十、SpringBoot 统⼀功能处理【拦截器、统一数据返回格式、统一异常处理】

十、SpringBoot 统⼀功能处理

- [1. 拦截器【HandlerInterceptor、WebMvcConfig】](#1. 拦截器【HandlerInterceptor、WebMvcConfig】)
- - [1.1 拦截器快速⼊⻔](#1.1 拦截器快速⼊⻔)
  - - ⾃定义拦截器：实现HandlerInterceptor接⼝，并重写其所有⽅法
    - 注册配置拦截器：实现WebMvcConfigurer接⼝，并重写addInterceptors⽅法
  - [1.2 拦截器详解](#1.2 拦截器详解)
  - - [1.2.1 拦截路径](#1.2.1 拦截路径)
    - [1.2.2 拦截器执⾏流程](#1.2.2 拦截器执⾏流程)
  - [1.3 登录校验](#1.3 登录校验)
  - - [1.3.1 定义拦截器](#1.3.1 定义拦截器)
    - [1.3.2 注册配置拦截器](#1.3.2 注册配置拦截器)
- [2. 统⼀数据返回格式【ControllerAdvicd、ResponseAdviced】](#2. 统⼀数据返回格式【ControllerAdvicd、ResponseAdviced】)
- - [2.1 快速⼊⻔](#2.1 快速⼊⻔)
- [3. 统⼀异常处理【@ControllerAdvice + @ExceptionHandler】](#3. 统⼀异常处理【@ControllerAdvice + @ExceptionHandler】)

本节⽬标

掌握拦截器的使⽤, 及其原理
学习统⼀数据返回格式和统⼀异常处理的操作
了解⼀些Spring的源码

1. 拦截器【HandlerInterceptor、WebMvcConfig】

上个章节我们完成了强制登录的功能, 后端程序根据Session来判断⽤⼾是否登录, 但是实现⽅法是⽐较⿇烦的

• 需要修改每个接⼝的处理逻辑

• 需要修改每个接⼝的返回结果

• 接⼝定义修改, 前端代码也需要跟着修改

有没有更简单的办法, 统⼀拦截所有的请求, 并进⾏Session校验呢, 这⾥我们学习⼀种新的解决办法: 拦截器

1.1 拦截器快速⼊⻔

什么是拦截器?
拦截器是Spring框架提供的核⼼功能之⼀, 主要⽤来拦截⽤⼾的请求, 在指定⽅法前后, 根据业务需要执⾏预先设定的代码.
也就是说, 允许开发⼈员提前预定义⼀些逻辑, 在⽤⼾的请求响应前后执⾏. 也可以在⽤⼾请求前阻⽌其执⾏.
在拦截器当中，开发⼈员可以在应⽤程序中做⼀些通⽤性的操作, ⽐如通过拦截器来拦截前端发来的请求, 判断Session中是否有登录⽤⼾的信息. 如果有就可以放⾏, 如果没有就进⾏拦截.

下⾯我们先来学习下拦截器的基本使⽤.

拦截器的使⽤步骤分为两步：

定义拦截器
注册配置拦截器

⾃定义拦截器：实现HandlerInterceptor接⼝，并重写其所有⽅法

java 复制代码

@Slf4j
@Component
public class LoginInterceptor implements HandlerInterceptor {
 
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		log.info("LoginInterceptor ⽬标⽅法执⾏前执⾏..");
		return true;
	}
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		log.info("LoginInterceptor ⽬标⽅法执⾏后执⾏");
	}
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		log.info("LoginInterceptor 视图渲染完毕后执⾏，最后执⾏");
	}
}

• preHandle()⽅法：⽬标⽅法执⾏前执⾏. 返回true: 继续执⾏后续操作; 返回false: 中断后续操作.

• postHandle()⽅法：⽬标⽅法执⾏后执⾏

• afterCompletion()⽅法：视图渲染完毕后执⾏，最后执⾏(后端开发现在⼏乎不涉及视图, 暂不了解)

注册配置拦截器：实现WebMvcConfigurer接⼝，并重写addInterceptors⽅法

java 复制代码

@Configuration
public class WebConfig implements WebMvcConfigurer {
	//⾃定义的拦截器对象
	@Autowired
	private LoginInterceptor loginInterceptor;
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		//注册⾃定义拦截器对象
		registry.addInterceptor(loginInterceptor)
			.addPathPatterns("/**");
	//设置拦截器拦截的请求路径（ /** 表⽰拦截所有请求）
	}
}

启动服务, 试试访问任意请求, 观察后端⽇志

可以看到preHandle ⽅法执⾏之后就放⾏了, 开始执⾏⽬标⽅法, ⽬标⽅法执⾏完成之后执⾏postHandle和afterCompletion⽅法.

我们把拦截器中preHandle⽅法的返回值改为false, 再观察运⾏结果

可以看到, 拦截器拦截了请求, 没有进⾏响应.

1.2 拦截器详解

拦截器的⼊⻔程序完成之后，接下来我们来介绍拦截器的使⽤细节。拦截器的使⽤细节我们主要介绍

两个部分：

拦截器的拦截路径配置
拦截器实现原理

1.2.1 拦截路径

拦截路径是指我们定义的这个拦截器, 对哪些请求⽣效.

我们在注册配置拦截器的时候, 通过 addPathPatterns() ⽅法指定要拦截哪些请求. 也可以通过excludePathPatterns() 指定不拦截哪些请求.

上述代码中, 我们配置的是 /** , 表⽰拦截所有的请求.

⽐如⽤⼾登录校验, 我们希望可以对除了登录之外所有的路径⽣效.

java 复制代码

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
public class WebConfig implements WebMvcConfigurer {
	//⾃定义的拦截器对象
	@Autowired
	private LoginInterceptor loginInterceptor;
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		//注册⾃定义拦截器对象
		registry.addInterceptor(loginInterceptor)
			.addPathPatterns("/**")
			.excludePathPatterns("/user/login");
			//设置拦截器拦截的请求路径
		(/** 表⽰拦截所有请求)
	}

1.2.2 拦截器执⾏流程

添加拦截器后, 执⾏Controller的⽅法之前, 请求会先被拦截器拦截住. 执⾏ preHandle() ⽅法，这个⽅法需要返回⼀个布尔类型的值. 如果返回true, 就表⽰放⾏本次操作, 继续访问controller中的⽅法. 如果返回false，则不会放⾏(controller中的⽅法也不会执⾏).
controller当中的⽅法执⾏完毕后，再回过来执⾏postHandle() 这个⽅法以及afterCompletion() ⽅法，执⾏完毕之后，最终给浏览器响应数据.

1.3 登录校验

学习拦截器的基本操作之后，接下来我们需要完成最后⼀步操作：通过拦截器来完成图书管理系统中的登录校验功能

1.3.1 定义拦截器

从session中获取⽤⼾信息, 如果session中不存在, 则返回false,并设置http状态码为401, 否则返回true.

java 复制代码

@Slf4j
@Component
public class LoginInterceptor implements HandlerInterceptor {
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		HttpSession session = request.getSession(false);
		if (session != null && session.getAttribute(Constants.SESSION_USER_KEY) != null) {
			return true;
		}
		response.setStatus(401);
		return false;
	}
}

http状态码401: Unauthorized

Indicates that authentication is required and was either not provided or has failed. If the

request already included authorization credentials, then the 401 status code indicates that

those credentials were not accepted.

中⽂解释: 未经过认证. 指⽰⾝份验证是必需的, 没有提供⾝份验证或⾝份验证失败. 如果请求已经包

含授权凭据，那么401状态码表⽰不接受这些凭据

1.3.2 注册配置拦截器

java 复制代码

@Configuration
public class WebConfig implements WebMvcConfigurer {
	//⾃定义的拦截器对象
	@Autowired
	private LoginInterceptor loginInterceptor;
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		//注册⾃定义拦截器对象
		registry.addInterceptor(loginInterceptor)
		.addPathPatterns("/**")//设置拦截器拦截的请求路径(/**表⽰拦截所有请求)
		.excludePathPatterns("/user/login")//设置拦截器排除拦截的路径
		.excludePathPatterns("/**/*.js") //排除前端静态资源
		.excludePathPatterns("/**/*.css")
		.excludePathPatterns("/**/*.png")
		.excludePathPatterns("/**/*.html");
 }
}

2. 统⼀数据返回格式【ControllerAdvicd、ResponseAdviced】

强制登录案例中, 我们共做了两部分⼯作

通过Session来判断⽤⼾是否登录
对后端返回数据进⾏封装, 告知前端处理的结果

回顾

后端统⼀返回结果

java 复制代码

@Data
public class Result<T> {
 private int status;
 private String errorMessage;
 private T data;
}

后端逻辑处理

java 复制代码

@RequestMapping("/getListByPage")
public Result getListByPage(PageRequest pageRequest) {
	log.info("获取图书列表, pageRequest:{}", pageRequest);
	//⽤⼾登录, 返回图书列表
	PageResult<BookInfo> pageResult = bookService.getBookListByPage(pageRequest);
	log.info("获取图书列表222, pageRequest:{}", pageResult);
	return Result.success(pageResult);
}

Result.success(pageResult) 就是对返回数据进⾏了封装

拦截器帮我们实现了第⼀个功能, 接下来看SpringBoot对第⼆个功能如何⽀持

2.1 快速⼊⻔

统⼀的数据返回格式使⽤ @ControllerAdvice 和ResponseBodyAdvice 的⽅式实现@ControllerAdvice 表⽰控制器通知类

添加类 ResponseAdvice , 实现 ResponseBodyAdvice 接⼝, 并在类上添加@ControllerAdvice 注解

java 复制代码

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
	@Override
	public boolean supports(MethodParameter returnType, Class converterType) {
		return true;
	}
	
	@Override
	public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
		return Result.success(body);
	}
}

supports⽅法: 判断是否要执⾏beforeBodyWrite⽅法. true为执⾏, false不执⾏. 通过该⽅法可以选择哪些类或哪些⽅法的response要进⾏处理, 其他的不进⾏处理.

从returnType获取类名和⽅法名

java 复制代码

//获取执⾏的类
Class<?> declaringClass = returnType.getMethod().getDeclaringClass();
//获取执⾏的⽅法
Method method = returnType.getMethod();

beforeBodyWrite⽅法: 对response⽅法进⾏具体操作处理

java 复制代码

@SneakyThrows
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
	//返回结果更加灵活
	if (body instanceof Result){
		return body;
	}
	//如果返回结果为String类型, 使⽤SpringBoot内置提供的Jackson来实现信息的序列化
	if (body instanceof String){
		return mapper.writeValueAsString(Result.success(body));
	}
	return Result.success(body);
}

3. 统⼀异常处理【@ControllerAdvice + @ExceptionHandler】

统⼀异常处理使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的,@ControllerAdvice 表⽰控制器通知类， @ExceptionHandler 是异常处理器，两个结合表⽰当出现异常的时候执⾏某个通知，也就是执⾏某个⽅法事件

具体代码如下

java 复制代码

@ControllerAdvice
@ResponseBody
public class ErrorAdvice {
 @ExceptionHandler
 public Object handler(Exception e) {
	 return Result.fail(e.getMessage());
 }
}

类名, ⽅法名和返回值可以⾃定义, 重要的是注解

接⼝返回为数据时, 需要加 @ResponseBody 注解

以上代码表⽰，如果代码出现Exception异常(包括Exception的⼦类), 就返回⼀个 Result的对象, Result对象的设置参考 Result.fail(e.getMessage())

java 复制代码

public static Result fail(String msg) {
 Result result = new Result();
 result.setStatus(ResultStatus.FAIL);
 result.setErrorMessage(msg);
 result.setData("");
 return result;
}

我们可以针对不同的异常, 返回不同的结果

java 复制代码

@ResponseBody
@ControllerAdvice
public class ErrorAdvice {
 @ExceptionHandler
 public Object handler(Exception e) {
 return Result.fail(e.getMessage());
 }
 @ExceptionHandler
 public Object handler(NullPointerException e) {
 return Result.fail("发⽣NullPointerException:"+e.getMessage());
 }
 @ExceptionHandler
 public Object handler(ArithmeticException e) {
 return Result.fail("发⽣ArithmeticException:"+e.getMessage());
 }
}

模拟制造异常:

java 复制代码

@RequestMapping("/test")
@RestController
public class TestController {
 @RequestMapping("/t1")
 public String t1(){
 return "t1";
 }
 @RequestMapping("/t2")
 public boolean t2(){
 int a = 10/0; //抛出ArithmeticException
 return true;
 }
 @RequestMapping("/t3")
 public Integer t3(){
 String a =null;
 System.out.println(a.length()); //抛出NullPointerException
 return 200;
 }
}