Java EE 突击 15 - Spring Boot 统一功能处理

news2024/12/23 6:37:19

Spring Boot 统一功能处理

  • 一 . 统一功能的处理
    • 1.1 初级阶段 : 不断重复
    • 1.2 中级阶段 : 集成方法
    • 1.3 高级阶段 : Spring AOP
    • 1.4 超高级阶段 : Spring 拦截器
      • 准备工作
      • 实现拦截器
        • 自定义拦截器
        • 将自定义拦截器加入到系统配置
      • 拦截器实现原理
      • 扩展 : 统一访问前缀添加
  • 二 . 统一异常的处理
    • 2.1 统一异常的处理的实现
    • 2.2 细化异常
  • 三 . 统一数据返回格式
    • 3.1 为什么需要统一数据返回格式？
    • 3.2 统一数据返回格式的实现
    • 3.3 @ControllerAdvice 源码分析

这个专栏给大家介绍一下 Java 家族的核心产品 - SSM 框架
JavaEE 进阶专栏

Java 语言能走到现在 , 仍然屹立不衰的原因 , 有一部分就是因为 SSM 框架的存在

接下来 , 博主会带大家了解一下 Spring、Spring Boot、Spring MVC、MyBatis 相关知识点

并且带领大家进行环境的配置 , 让大家真正用好框架、学懂框架

来上一篇文章复习一下吧
点击即可跳转到前置文章
CSDN 平台观感有限 , 可以私聊作者获取源笔记链接
在这里插入图片描述

上一篇文章是 Spring AOP 理论阶段 , 这篇文章就进入了 Spring AOP 实战
我们会讲解这三种功能 :

  1. 统⼀用户登录权限验证
  2. 统⼀数据格式返回
  3. 统⼀异常处理

我们新创建一个项目来完成这三项功能
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png
image.png

一 . 统一功能的处理

1.1 初级阶段 : 不断重复

我们先来回顾⼀下最初用户登录验证的实现方法 :

@RestController
@RequestMapping("/user")
public class UserController {
	/**
	 * 某⽅法 1
	 */
	@RequestMapping("/m1")
	public Object method(HttpServletRequest request) {
		// 有 session 就获取，没有不会创建
		HttpSession session = request.getSession(false);
		if (session != null && session.getAttribute("userinfo") != null) {
			// 说明已经登录，业务处理
			return true;
		} else {
			// 未登录
			return false;
		}
	}

	/**
	 * 某⽅法 2
	 */
	@RequestMapping("/m2")
	public Object method2(HttpServletRequest request) {
		// 有 session 就获取，没有不会创建
		HttpSession session = request.getSession(false);
		if (session != null && session.getAttribute("userinfo") != null) {
			// 说明已经登录，业务处理
			return true;
		} else {
			// 未登录
			return false;
		}
	}
	// 其他⽅法...
}

image.png

1.2 中级阶段 : 集成方法

我发现我们每一个需要登录授权的地方都需要写重复的代码 , 那我们索性就直接封装成统一的方法
但是在业务方法里面还是要调用公共方法的
一旦公共方法增加了参数 , 那我们调用公共方法的位置还是需要进行更改 , 依然很麻烦

1.3 高级阶段 : Spring AOP

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class UserAspect {
    // 定义切点⽅法 controller 包下、⼦孙包下所有类的所有⽅法
    @Pointcut("execution(* com.example.demo.controller..*.*(..))")
    public void pointcut() {
    }

    // 前置⽅法
    @Before("pointcut()")
    public void doBefore() {
    }

    // 环绕⽅法
    @Around("pointcut()")
    public Object doAround(ProceedingJoinPoint joinPoint) {
        Object obj = null;
        System.out.println("Around ⽅法开始执⾏");
        try {
            // 执⾏拦截⽅法
            obj = joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println("Around ⽅法结束执⾏");
        return obj;
    }
}

image2.png
虽然环绕方法很香 , 但是我们也发现了两个问题 :

  1. 我们拿不到 HttpSession 对象了
  2. 拦截规则写起来还是比较复杂的 , 我们就是有一种需求 : controller 文件夹下 , 有的方法就是需要进行拦截的 , 而有的方法是不需要进行拦截的 , 那我们去写拦截表达式就会非常复杂

image.png

1.4 超高级阶段 : Spring 拦截器

对于上面的两个问题 , Spring 官方也考虑到了这个问题 , 他们就推出了具体的实现拦截器 : HandlerInterceptor , 他是在 Spring AOP 上进行了封装 , 让拦截变得更加简单 , 功能更加丰富 .
拦截器的实现分为以下两个步骤 :

  1. 创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean
  2. 将自定义拦截器加入 WebMvcConfigurer 的 addInterceptors 方法中

接下来 , 我们就尝试一下 Spring 拦截器

准备工作

在 demo 底下新建一个包 controller , 里面写一个类 : UserController
image.png
image.png
编写业务逻辑

package com.example.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

@RestController
@RequestMapping("/user")
public class UserController {
    /**
     * 登录需要传入用户名密码
     * 验证用户名密码是否正确需要传入 request 对象
     * @param request
     * @param username
     * @param password
     * @return
     */
    @RequestMapping("login")
    public boolean login(HttpServletRequest request,
                         String username, String password) {
        // 1. 非空判断
        if(username != null && username != "" &&
           password != null && password != "") {
            // 2. 验证用户名和密码是否正确
        }
        
        return false;
    }
}

但是非空判断这里 , 不太雅观 , Spring 就给我们提供了一种方式
image.png
千万千万不要选错 , 咱们这个是 Spring Boot 项目 , 当然要去找 Spring 提供的方法
使用他的 hasLength() 方法就可以判定是不是空以及是不是空字符串
image.png
image.png
然后继续完善我们的登录功能

package com.example.demo.controller;

import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@RestController
@RequestMapping("/user")
public class UserController {
    /**
     * 登录需要传入用户名密码
     * 验证用户名密码是否正确需要传入 request 对象
     * @param request
     * @param username
     * @param password
     * @return
     */
    @RequestMapping("login")
    public boolean login(HttpServletRequest request,
                         String username, String password) {
        // 1. 非空判断
        // StringUtils.hasLength()
        // 有值 -> 返回 true
        // 为 null -> 返回 false
        if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
            // 2. 验证用户名和密码是否正确(伪代码)
            if("admin".equals(username) && "admin".equals(password)) {
                // 登陆成功
                // 把登录信息放进 HttpSession 里面
                HttpSession session = request.getSession();
                session.setAttribute("userinfo","admin");
                return true;
            } else {
                // 登陆失败
                // 用户名或密码错误
                return false;
            }
        }
        return false;
    }
    
}

接下来 , 我们再去实现获取个人信息方法

package com.example.demo.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {
    /**
     * 登录需要传入用户名密码
     * 验证用户名密码是否正确需要传入 request 对象
     * @param request
     * @param username
     * @param password
     * @return
     */
    @RequestMapping("login")
    public boolean login(HttpServletRequest request,
                         String username, String password) {
        // 1. 非空判断
        // StringUtils.hasLength()
        // 有值 -> 返回 true
        // 为 null -> 返回 false
        if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
            // 2. 验证用户名和密码是否正确(伪代码)
            if("admin".equals(username) && "admin".equals(password)) {
                // 登陆成功
                // 把登录信息放进 HttpSession 里面
                HttpSession session = request.getSession();
                session.setAttribute("userinfo","admin");
                return true;
            } else {
                // 登陆失败
                // 用户名或密码错误
                return false;
            }
        }
        return false;
    }

    /**
     * 获取个人信息(伪代码)
     * @return
     */
    @RequestMapping("/getinfo")
    public String getInfo() {
        // 使用日志,需要添加 @Slf4j 注解
        log.debug("执行了 getinfo 方法");
        return "执行了 getinfo 方法";
    }
}

接下来 , 我们再去实现注册功能

package com.example.demo.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {
    /**
     * 登录需要传入用户名密码
     * 验证用户名密码是否正确需要传入 request 对象
     * @param request
     * @param username
     * @param password
     * @return
     */
    @RequestMapping("/login")
    public boolean login(HttpServletRequest request,
                         String username, String password) {
        // 1. 非空判断
        // StringUtils.hasLength()
        // 有值 -> 返回 true
        // 为 null -> 返回 false
        if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
            // 2. 验证用户名和密码是否正确(伪代码)
            if("admin".equals(username) && "admin".equals(password)) {
                // 登陆成功
                // 把登录信息放进 HttpSession 里面
                HttpSession session = request.getSession();
                session.setAttribute("userinfo","admin");
                return true;
            } else {
                // 登陆失败
                // 用户名或密码错误
                return false;
            }
        }
        return false;
    }

    /**
     * 获取个人信息
     * @return
     */
    @RequestMapping("/getinfo")
    public String getInfo() {
        // 使用日志,需要添加 @Slf4j 注解
        log.debug("执行了 getinfo 方法");
        return "执行了 getinfo 方法";
    }

    /**
     * 注册功能(伪代码)
     */
    @RequestMapping("/reg")
    public String reg() {
        // 使用日志,需要添加 @Slf4j 注解
        log.debug("执行了 reg 方法");
        return "执行了 reg 方法";
    }
}

在 UserController 中 , 我们需要拦截 getInfo() 方法 , 而 login() reg() 方法是不需要拦截的

实现拦截器

自定义拦截器

接下来 , 我们再新建一个包去写拦截器 , 包名叫做 config , 再写一个类 : LoginInterceptor ( 登录拦截器 )
image.png
image.png
自定义拦截器的步骤 : 创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean
编写以下代码

package com.example.demo.config;

import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * 登录拦截器
 */
// 1. 创建自定义拦截器 , 实现 HandlerInterceptor 接口 , 重写 preHandle ( 执行具体方法之前的预处理 ) 方法 , 返回 boolean
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 登录判断的业务
        // false : 有 session 直接得到 session , 没有 session 就不需要再创建 session 了
        // 如果用在登录判断的业务上,一定要用 session
        HttpSession session = request.getSession(false);
        if(session != null && session.getAttribute("userinfo") != null) {
            return true;
        }
        // 非必须:可以设置状态码
        response.setStatus(401);//401代表没有权限
        // 也可以实现页面跳转
        // response.sendRedirect("xxx.html");
        // 默认不执行返回 false
        return false;
    }
}

将自定义拦截器加入到系统配置

目前我们实现了第一步 : 创建自定义拦截器 , 接下来完成第二步 : 配置拦截规则

  1. 创建一个类 , 实现 WebMvcConfigurer

image.png
image.png

  1. 重写 addInterceptors 方法

image.png

  1. 为了想要拦截器在 Spring 程序启动时就生效 , 我们需要添加 @Configuration 注解
package com.example.demo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        
    }
}
  1. 把自定义拦截器加载到拦截规则中 , 使用 registry
package com.example.demo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor());
    }
}

那为什么在 Spring 里面 , 我们还要 new 对象呢 ?
image.png
我们也可以不用 new , 在 登录拦截器的实现的类 (LoginInterceptor) 中添加 @Component 注解
这就代表我们当前的类托管到 Spring 里面了 , 那我们就可以在配置拦截规则的类中把属性注入进来了
image.png

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor);
    }
}

这样写完之后 , 我们的拦截器就生效了 , 但是规则还未制指定 , 制定规则使用 addPathPatterns 代表全部拦截 , excludePathPatterns 代表不拦截谁

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                .excludePathPatterns("/*.js") // 还可以使用表达式,拦截所有的js
                .excludePathPatterns("/user/reg");
    }
}

接下来齐活 , 我们就可以运行一下了
reg 方法是不拦截的 , 那么我们访问一下 reg 方法看看
image.png
image.png
再看一下 getinfo 方法
image.png
打开谷歌的开发者工具看看
image.png
image.png
这就说明我们的拦截器起作用了
我们可以通过打印日志更清晰地查看效果
image.png
重新运行
image.png
image.png

但是离谱的是 : 我们再访问 reg 方法 , 他仍然被拦截了
image.png
打开 reg 页面的开发者工具看一看是咋回事
image.png
那么这个 favicon.ico 是什么 , 他为什么会被拦截 ?
比如我们访问百度页面
image.png
圈出来的部分就是一个小的百度图标 , 其实这就是我们的 favicon.ico
我们设置拦截规则的时候也要把它排除在外 , 否则所有的页面都要被拦截的

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                .excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;
                .excludePathPatterns("/user/reg");
    }
}

接下来 , 再运行
image.png
image.png
还是一直被拦截 , 这时候 , 就需要考虑考虑是不是我们的缓存的问题呢 ?
image.png
再次运行
image.png
image.png
再次失败 (图标这个问题真的很顽固)

但是 reg 方法是没有被拦截的
image.png
getinfo 方法
image.png
image.png
接下来 , 我们挂载一下 session , 让他登陆成功
我们直接访问 login
image.png
访问 127.0.0.1:8080/user/login?username=admin&password=admin , 就变成 true 了
image.png
接下来再去访问 getinfo 是什么场景呢 ?
image.png
说明 session 成功挂载 , 但是换个浏览器还是 bbq
image.png
这是因为 session 的实现是通过谷歌浏览器帮助的 , 存储在谷歌浏览器的 cookie 里面了 , 但是并未存储到 edge 浏览器的 cookie 里面

拦截器实现原理

正常情况
image.png
拦截器
image.png
从最开始的直接进入控制器层 , 到现在多了一层校验才能进入控制器层 , Spring AOP 帮我们实现了校验拦截的功能
所有的 Controller 执行都会通过⼀个调度器 DispatcherServlet 来实现 , 可以从 Spring Boot 控制台的打印信息看出
我们访问 controller 底下的 login 方法
image.png
就可以在 Spring Boot 的控制台下面 , 发现 DispatcherServlet 的身影
image.png
从源码角度来分析
双击 shift 搜索 DispatchServlet
image.png
CTRL + F 搜索 doDispatch 就找到了

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HttpServletRequest processedRequest = request;
    HandlerExecutionChain mappedHandler = null;
    boolean multipartRequestParsed = false;

    WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

    try {
        ModelAndView mv = null;
        Exception dispatchException = null;

        try {
            processedRequest = checkMultipart(request);
            multipartRequestParsed = (processedRequest != request);

            mappedHandler = getHandler(processedRequest);
            if (mappedHandler == null) {
                noHandlerFound(processedRequest, response);
                return;
            }

            HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

            String method = request.getMethod();
            boolean isGet = "GET".equals(method);
            if (isGet || "HEAD".equals(method)) {
                long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
                if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
                    return;
                }
            }
            
            // 调用预处理[重要]
            if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                return;
            }

            // 执行 controller 里面的业务
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
            if (asyncManager.isConcurrentHandlingStarted()) {
                return;
            }
            applyDefaultViewName(processedRequest, mv);
            mappedHandler.applyPostHandle(processedRequest, response, mv);
        }
        catch (Exception ex) {
            dispatchException = ex;
        }
        catch (Throwable err) {
            dispatchException = new NestedServletException("Handler dispatch failed", err);
        }
        
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
    catch (Exception ex) {
        triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
    }
    catch (Throwable err) {
        triggerAfterCompletion(processedRequest, response, mappedHandler,
                               new NestedServletException("Handler processing failed", err));
    }
    finally {
        if (asyncManager.isConcurrentHandlingStarted()) {
            if (mappedHandler != null) {
                mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
            }
        }
        else {
            if (multipartRequestParsed) {
                cleanupMultipart(processedRequest);
            }
        }
    }
}

我们再看一下源码里面的核心方法
image.png
image.png
image.png
通过上面的源码分析 , 我们可以看出 , Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的 , 大体的调用流程如下 :
image.png

扩展 : 统一访问前缀添加

在 MyConfig 类中重写 configurePathMatch 方法 , 然后使用他的 addPathPrefix 方法

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
// 1. 实现 WebMvcConfigurer
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    // 2. 重写 addInterceptors 方法
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/user/login")  // 排除不拦截的 URL
                .excludePathPatterns("/favicon.ico") // 排除状态栏标签小图标;
                .excludePathPatterns("/user/reg");
    }

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api",c -> true);
    }
}

其中第⼆个参数是⼀个表达式 , 设置为 true 表示启动前缀
它的作用就是 , 我们在地址栏输入的时候 , 需要在前面加上 api (其实很鸡肋)
image.png

想要成功访问 , 还要修改一下拦截路径
image.png

二 . 统一异常的处理

我们在 reg 方法里构造一个异常 , 当这个异常发生了 , 原本的期望是发生异常返回信息给前端 , 让前端知道出现问题了 .
但是我们目前程序的健壮性并不是很强 , 当我们制造出一个异常之后 , 目前的程序并不能返回错误给前端

package com.example.demo.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {
    /**
     * 登录需要传入用户名密码
     * 验证用户名密码是否正确需要传入 request 对象
     * @param request
     * @param username
     * @param password
     * @return
     */
    @RequestMapping("login")
    public boolean login(HttpServletRequest request,
                         String username, String password) {
        // 1. 非空判断
        // StringUtils.hasLength()
        // 有值 -> 返回 true
        // 为 null -> 返回 false
        if(StringUtils.hasLength(username) && StringUtils.hasLength(password)) {
            // 2. 验证用户名和密码是否正确(伪代码)
            if("admin".equals(username) && "admin".equals(password)) {
                // 登陆成功
                // 把登录信息放进 HttpSession 里面
                HttpSession session = request.getSession();
                session.setAttribute("userinfo","admin");
                return true;
            } else {
                // 登陆失败
                // 用户名或密码错误
                return false;
            }
        }
        return false;
    }

    /**
     * 获取个人信息
     * @return
     */
    @RequestMapping("/getinfo")
    public String getInfo() {
        // 使用日志,需要添加 @Slf4j 注解
        log.debug("执行了 getinfo 方法");
        return "执行了 getinfo 方法";
    }

    /**
     * 注册功能(伪代码)
     */
    @RequestMapping("/reg")
    public String reg() {
        int num = 10 / 0;
        log.debug("执行了 reg 方法");
        return "执行了 reg 方法";
    }

}

image.png
接下来 , 我们就去浏览器看看效果
image.png
后端这里就报错了
image.png
那前端就蒙了 , 我还在这等着你呢 , 你这头自己就偷摸报错了
那我们就需要通过 Spring AOP 统一异常的处理 , 来加强程序的鲁棒性

2.1 统一异常的处理的实现

我们在 config 包底下新创建一个类 , 叫做 ErrorAdvice
image.png
image.png
统一异常的处理分为以下几步 :

  1. 新建一个类 , 加上 @ControllerAdvice 注解
package com.example.demo.config;

/**
 * 统一处理异常
 */

import org.springframework.web.bind.annotation.ControllerAdvice;

@ControllerAdvice 
public class ErrorAdvice {
}
  1. 编写具体的方法 , 在方法上面加上注解 : @ExceptionHandler(Exception.class)
package com.example.demo.config;

/**
 * 统一处理异常
 */

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

@ControllerAdvice
public class ErrorAdvice {
    // 企业级要求:返回对象(返回HashMap)
    // 添加注解:@ExceptionHandler(Exception.class)
    @ExceptionHandler(Exception.class)
    @ResponseBody // 返回的是数据而不是页面
    public HashMap<String, Object> exAdvice() {
        HashMap<String, Object> result = new HashMap<>();
        
        return result;
    }
}
  1. 要修改状态码 , 以及把错误信息添加进去
package com.example.demo.config;

/**
 * 统一处理异常
 */

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

@ControllerAdvice
public class ErrorAdvice {
    // 企业级要求:返回对象(返回HashMap)
    // 添加注解:@ExceptionHandler(Exception.class)
    @ExceptionHandler(Exception.class)
    @ResponseBody // 返回的是数据而不是页面
    public HashMap<String, Object> exAdvice(Exception e) {
        HashMap<String, Object> result = new HashMap<>();
        result.put("code","-1");// 出现异常,状态码改成-1
        result.put("msg",e.getMessage());// 把报错信息添加进去,需要在方法参数加上Exception e
        return result;
    }
}

这就完成了统一异常的处理
接下来 , 我们再去运行一下
image.png

2.2 细化异常

目前我们是实现了大异常 , 我们还可以去实现更细级别的小异常

package com.example.demo.config;

/**
 * 统一处理异常
 */

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

@ControllerAdvice
public class ErrorAdvice {
    // 企业级要求:返回对象(返回HashMap)
    // 添加注解:@ExceptionHandler(Exception.class)
    @ExceptionHandler(Exception.class)
    @ResponseBody // 返回的是数据而不是页面
    public HashMap<String, Object> exAdvice(Exception e) {
        HashMap<String, Object> result = new HashMap<>();
        result.put("code","-1");// 出现异常,状态码改成-1
        result.put("msg",e.getMessage());// 把报错信息添加进去,需要在方法参数加上Exception e
        return result;
    }

    @ExceptionHandler(ArithmeticException.class)
    @ResponseBody
    public HashMap<String, Object> arithmeticAdvice(ArithmeticException e) {
        HashMap<String, Object> result = new HashMap<>();
        result.put("code",-2);
        result.put("msg",e.getMessage());
        return result;
    }
}

image.png
image.png
那我们再制造个空指针异常 , 状态码就应该为 -1
image.png
image.png
前端程序员收到错误信息之后 , 前端程序员就可以进行处理了 , 可以给用户一个页面或者弹窗提示运行失败

三 . 统一数据返回格式

3.1 为什么需要统一数据返回格式？

本质就是降低双方沟通成本

3.2 统一数据返回格式的实现

  1. 在类上添加 @ControllerAdvice 注解
  2. 实现 ResponseBodyAdvice
  3. 重写两个方法 :
    1. supports : 固定返回 true
    2. beforeBodyWrite : 在此方法内构造统一返回对象

我们可以实现一下
image.png
image.png

package com.example.demo.config;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import java.util.HashMap;

/**
 * 统一返回数据的处理
 */
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        // 固定返回 true,这样才能调用下面的方法
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        // 构造统一返回对象
        HashMap<String, Object> result = new HashMap<>();
        result.put("code", 200);// 状态码
        result.put("msg", "");// 状态的描述信息
        result.put("data", body);// 数据
        return result;
    }
}

image.png
运行查看效果
之前我们登录返回的是布尔值
image.png
现在就变成了 JSON 数据
image.png
image.png
image.png
但是统一数据返回格式的方法过于霸道 , 他把所有的对象都进行封装
比如我们的 getinfo 以及 reg , 已经报错了 , 然后统一异常处理就给他们封装成一个 HashMap 了
image.png
但是统一数据返回格式又把这个已经封装好的对象又抓过来了 , 进行再次封装 , 所以就会像图片里那样 , data 里面又包含了 code 以及 msg

3.3 @ControllerAdvice 源码分析

我们在统一异常的处理和统一数据返回格式之中 , 都用到了 @ControllerAdvice 注解
image.png
image.png
那这个 @ControllerAdvice 到底是怎么回事呢 ? 我们可以通过源码来看一下
image.png
@ControllerAdvice 注解也是来自于 @Component 注解的 , 他就相当于 Java 中的 “Object”
image.png
@ControllerAdvice 派生于 @Component 组件 , 而所有组件初始化都会调用 InitalizingBean 接口
所以接下来我们来看 InitializingBean 有哪些实现类 ? 在查询的过程中我们发现了 , 其中 Spring MVC
中的实现子类是 RequestMappingHandlerAdapter , 他里面有⼀个 afterPropertiesSet() 方法 , 表
示所有的参数设置完成之后执行的方法 (来源于 @Component 注解的其他注解都会使用 afterPropertiesSet() 方法 )
在 afterPropertiesSet() 方法 中 , 有这样一句代码
image.png
这个方法是干什么的呢 ?
image.png

事件 : 到了某个时间点干什么事

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/950347.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

机器学习的第一节基本概念的相关学习

机器学习的第一节基本概念的相关学习

目录 1.1 决策树的概念 1.2 KNN的概念 1.2.1KNN的基本原理 1.2.2 流程&#xff1a; 1.2.3 优缺点 1.3 深度学习 1.4 梯度下降 损失函数 1.5 特征与特征选择 特征选择的目的 1.6 python中dot函数总结 一维数组的点积&#xff1a; 二维数组&#xff08;矩阵&#xff09;的乘法&am…
阅读更多...
结构体对齐原理及在STM32中的设计原则和实现

结构体对齐原理及在STM32中的设计原则和实现

在嵌入式系统开发中&#xff0c;结构体作为一种常见的数据组织方式&#xff0c;在内存中的布局方式对于程序性能和内存占用具有重要影响。本文将深入探讨单片机C语言中的结构体对齐原理、重要性以及不同的对齐方式&#xff0c;并通过示例演示结构体对齐如何影响内存占用、访问性…
阅读更多...
SpringBoot：一个注解就能帮你下载任意对象

SpringBoot：一个注解就能帮你下载任意对象

一 前言 下载功能应该是比较常见的功能了&#xff0c;虽然一个项目里面可能出现的不多&#xff0c;但是基本上每个项目都会有&#xff0c;而且有些下载功能其实还是比较繁杂的&#xff0c;倒不是难&#xff0c;而是麻烦。 如果我说现在只需要一个注解就能帮你下载任意的对象&…
阅读更多...
纪念我的第一个稍微有用一点的python代码的成功——利用最近邻插值法实现图像的放大

纪念我的第一个稍微有用一点的python代码的成功——利用最近邻插值法实现图像的放大

一、技术来源&#xff1a; 插值算法 &#xff5c; 最近邻插值法_哔哩哔哩_bilibili 感谢这位的技术分享&#xff0c;讲解得通俗易懂 二、一些磕磕绊绊&#xff1a; 1.首先&#xff0c;pycharm的使用&#xff0c;通过file创建一个新的项目&#xff08;最好可以记住文件路径&am…
阅读更多...
Java9-17新特性

Java9-17新特性

文章目录 一、简介二、新特性接口私有方法&#xff08;JDK9&#xff09;String存储结构的变化&#xff08;JDK9&#xff09;快速创建只读集合&#xff08;JDK9、10&#xff09;文本块&#xff08;JDK13、14、15&#xff09;更直观的 NullPointerException 提示&#xff08;JDK1…
阅读更多...
exe软件监控看门狗使用说明

exe软件监控看门狗使用说明

作为物联网数据采集解决方案专业提供商,数采物联网 小编daq-iot在这里做以下内容介绍,并诚挚的欢迎大家讨论和交流。 1.软件概述 本软件功能用途&#xff1a;监控电脑或服务器exe程序运行&#xff0c;在exe程序由于异常或其他原因退出后&#xff0c;自动启动exe程序&#xff0…
阅读更多...
goroutine的一点东西

goroutine的一点东西

前面的两篇&#xff0c;从相对比较简单的锁的内容入手(也是干货满满)&#xff0c;开始了go的系列。这篇开始&#xff0c;进入更核心的内容。我们知道&#xff0c;go应该是第一门在语言层面支持协程的编程语言(可能是我孤陋寡闻)&#xff0c;goroutine也完全算的上是go的门面。g…
阅读更多...
文件属性查看和修改学习

文件属性查看和修改学习

这个是链接&#xff0c;相当于快捷方式&#xff0c;指向usr/bin这个目录&#xff0c;链接到这个目录
阅读更多...
NRF52832一主多从ble_app_multilink_central

NRF52832一主多从ble_app_multilink_central

下载官方SDK后打开路径&#xff1a;nRF5SDK153059ac345\nRF5_SDK_15.3.0_59ac345\examples\ble_central\ble_app_multilink_central\pca10040\s132\arm5_no_packs 下的工程文件&#xff0c;确定把log开启 编译后下载完程序(要下载协议栈&#xff0c;这里用6.1.1的)&#xff0c…
阅读更多...
FPGA原理与结构——时钟IP核原理学习

FPGA原理与结构——时钟IP核原理学习

一、前言 在之前的文章中&#xff0c;我们介绍了FPGA的时钟结构 FPGA原理与结构——时钟资源https://blog.csdn.net/apple_53311083/article/details/132307564?spm1001.2014.3001.5502 在本文中我们将学习xilinx系列的FPGA所提供的时钟IP核&#xff0c;来帮助我们进一…
阅读更多...
实现带头双向循环链表

实现带头双向循环链表

&#x1f308;带头双向循环链表 描述&#xff1a;一个节点内包含两个指针&#xff0c;一个指向上一个节点&#xff0c;另一个指向下一个节点。哨兵位指向的下一个节点为头节点&#xff0c;哨兵位的上一个指向尾节点。 结构优势&#xff1a;高效率找尾节点&#xff1b;高效率插入…
阅读更多...
RabbitMQ工作模式-主题模式

RabbitMQ工作模式-主题模式

主题模式 官方文档参考&#xff1a;https://www.rabbitmq.com/tutorials/tutorial-five-python.html 使用topic类型的交换器&#xff0c;队列绑定到交换器、bingingKey时使用通配符&#xff0c;交换器将消息路由转发到具体队列时&#xff0c;会根据消息routingKey模糊匹配&am…
阅读更多...
[学习笔记] fhq Treap 平衡树

[学习笔记] fhq Treap 平衡树

fhq Treap 也叫无旋Treap &#xff08;好像&#xff1f;我也不知道&#xff09; 反正我带旋 Treap 是不会滴&#xff0c;其他的平衡树也不会&#xff08;但是会平板电视&#xff09; fhq Treap 好写&#xff0c;码量小&#xff0c;缺点是常数比较大 定义 二叉搜索树 二叉搜…
阅读更多...
为什么说模电难学？因为它至少是这27个基础知识的排列组合！

为什么说模电难学？因为它至少是这27个基础知识的排列组合！

1、基尔1、基尔霍夫定理的内容是什么&#xff1f; 基尔霍夫电流定律&#xff1a;在电路任一节点&#xff0c;流入、流出该节点电流的代数和为零。 基尔霍夫电压定律&#xff1a;在电路中的任一闭合电路&#xff0c;电压的代数和为零。 2、戴维南定理 一个含独立源、线性电阻…
阅读更多...
在抖音开店卖货的流程是什么？最全解答如下，建议新手认真看完！

在抖音开店卖货的流程是什么？最全解答如下，建议新手认真看完！

我是王路飞。 同样是在抖音卖货&#xff0c;为何如今大多数人都是选择在抖音开店&#xff0c;而不再是选择做账号、开直播了呢&#xff1f; 原因很简单&#xff0c;因为门槛和变现方式。 相比短视频和直播带货的起号、变现难度越来越大&#xff0c;低门槛的抖音小店显然更适…
阅读更多...
Origin热图的做法

Origin热图的做法

1.数据准备 2.绘制-选择带标签热图 3.图表调整 右边标签- 下方标签-复制格式&#xff0c;再到左边或者右边选择 粘贴所有 图中的标签及颜色 直接双击在属性框更改 主框的其他特征在属性框选择 色阶的控制 直接选择色阶的属性框
阅读更多...
Endnote中查看一个文献的分组的具体方法——以Endnote X8为例

Endnote中查看一个文献的分组的具体方法——以Endnote X8为例

Endnote中查看一个文献的分组的具体方法——以Endnote X8为例 一、问题 当Endnote中使用分类方法对文献进行分组管理后&#xff0c;有时需要重新调整该文献的分组&#xff0c;则需要找到这个文献在哪个分组中。本文阐述怎样寻找一个文献的分组的位置信息。 二、解决方法 1.选…
阅读更多...
Spooling的原理

Spooling的原理

脱机技术 程序猿先用纸带机把自己的程序数据输入到磁带中&#xff0c;这个输入的过程是由一台专门的外围控制机实现的。之后CPU直接从快速的磁带中读取想要的这些输入数据。输出也类似。 假脱机技术&#xff08;Spooling技术&#xff09; 即用软件的方式来模拟脱机技术。要…
阅读更多...
Kubernetes技术--k8s核心技术Controller控制器

Kubernetes技术--k8s核心技术Controller控制器

1.Controller概述 Controller是在集群上管理和运行容器的对象。是一个实际存在的对象。 2.pod和Controller之间的关系 pod通过controller实现应用的运维，包括伸缩、滚动升级等操作。 这里pod和controller通过label标签来建立关系。如下所示: 3.Deployment控制器应用场景 -1:…
阅读更多...
RabbitMQ工作模式-发布订阅模式

RabbitMQ工作模式-发布订阅模式

Publish/Subscribe&#xff08;发布订阅模式&#xff09; 官方文档&#xff1a; https://www.rabbitmq.com/tutorials/tutorial-three-python.html 使用fanout类型类型的交换器&#xff0c;routingKey忽略。每个消费者定义生成一个队列关绑定到同一个Exchange&#xff0c;每个…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023