SpringBoot統(tǒng)一功能處理

本篇將要學(xué)習(xí) Spring Boot 統(tǒng)一功能處理模塊，這也是 AOP 的實(shí)戰(zhàn)環(huán)節(jié)

用戶登錄權(quán)限的校驗(yàn)實(shí)現(xiàn)接口 HandlerInterceptor + WebMvcConfigurer

異常處理使用注解 @RestControllerAdvice + @ExceptionHandler

數(shù)據(jù)格式返回使用注解 @ControllerAdvice 并且實(shí)現(xiàn)接口 @ResponseBodyAdvice

1. 統(tǒng)一用戶登錄權(quán)限效驗(yàn)

用戶登錄權(quán)限的發(fā)展完善過(guò)程

最初用戶登錄效驗(yàn)： 在每個(gè)方法中獲取 Session 和 Session 中的用戶信息，如果存在用戶，那么就認(rèn)為登錄成功了，否則就登錄失敗了

第二版用戶登錄效驗(yàn)： 提供統(tǒng)一的方法，在每個(gè)需要驗(yàn)證的方法中調(diào)用統(tǒng)一的用戶登錄身份效驗(yàn)方法來(lái)判斷

第三版用戶登錄效驗(yàn)： 使用 Spring AOP 來(lái)統(tǒng)一進(jìn)行用戶登錄效驗(yàn)

第四版用戶登錄效驗(yàn)： 使用 Spring 攔截器來(lái)實(shí)現(xiàn)用戶的統(tǒng)一登錄驗(yàn)證

1.1 最初用戶登錄權(quán)限效驗(yàn)

@RestController
@RequestMapping("/user")
publicclassUserController{

@RequestMapping("/a1")
publicBooleanlogin(HttpServletRequestrequest){
//有Session就獲取，沒(méi)有就不創(chuàng)建
HttpSessionsession=request.getSession(false);
if(session!=null&&session.getAttribute("userinfo")!=null){
//說(shuō)明已經(jīng)登錄，進(jìn)行業(yè)務(wù)處理
returntrue;
}else{
//未登錄
returnfalse;
}
}

@RequestMapping("/a2")
publicBooleanlogin2(HttpServletRequestrequest){
//有Session就獲取，沒(méi)有就不創(chuàng)建
HttpSessionsession=request.getSession(false);
if(session!=null&&session.getAttribute("userinfo")!=null){
//說(shuō)明已經(jīng)登錄，進(jìn)行業(yè)務(wù)處理
returntrue;
}else{
//未登錄
returnfalse;
}
}
}

這種方式寫(xiě)的代碼，每個(gè)方法中都有相同的用戶登錄驗(yàn)證權(quán)限，缺點(diǎn)是：

每個(gè)方法中都要單獨(dú)寫(xiě)用戶登錄驗(yàn)證的方法，即使封裝成公共方法，也一樣要傳參調(diào)用和在方法中進(jìn)行判斷

添加控制器越多，調(diào)用用戶登錄驗(yàn)證的方法也越多，這樣就增加了后期的修改成功和維護(hù)成功

這些用戶登錄驗(yàn)證的方法和現(xiàn)在要實(shí)現(xiàn)的業(yè)務(wù)幾乎沒(méi)有任何關(guān)聯(lián)，但還是要在每個(gè)方法中都要寫(xiě)一遍，所以提供一個(gè)公共的 AOP 方法來(lái)進(jìn)行統(tǒng)一的用戶登錄權(quán)限驗(yàn)證是非常好的解決辦法。

1.2 Spring AOP 統(tǒng)一用戶登錄驗(yàn)證

統(tǒng)一用戶登錄驗(yàn)證，首先想到的實(shí)現(xiàn)方法是使用 Spring AOP 前置通知或環(huán)繞通知來(lái)實(shí)現(xiàn)

@Aspect//當(dāng)前類是一個(gè)切面
@Component
publicclassUserAspect{
//定義切點(diǎn)方法Controller包下、子孫包下所有類的所有方法
@Pointcut("execution(*com.example.springaop.controller..*.*(..))")
publicvoidpointcut(){}

//前置通知
@Before("pointcut()")
publicvoiddoBefore(){}

//環(huán)繞通知
@Around("pointcut()")
publicObjectdoAround(ProceedingJoinPointjoinPoint){
Objectobj=null;
System.out.println("Around方法開(kāi)始執(zhí)行");
try{
obj=joinPoint.proceed();
}catch(Throwablee){
e.printStackTrace();
}
System.out.println("Around方法結(jié)束執(zhí)行");
returnobj;
}
}

但如果只在以上代碼 Spring AOP 的切面中實(shí)現(xiàn)用戶登錄權(quán)限效驗(yàn)的功能，有這樣兩個(gè)問(wèn)題：

沒(méi)有辦法得到 HttpSession 和 Request 對(duì)象

我們要對(duì)一部分方法進(jìn)行攔截，而另一部分方法不攔截，比如注冊(cè)方法和登錄方法是不攔截的，也就是實(shí)際的攔截規(guī)則很復(fù)雜，使用簡(jiǎn)單的 aspectJ 表達(dá)式無(wú)法滿足攔截的需求

1.3 Spring 攔截器

針對(duì)上面代碼 Spring AOP 的問(wèn)題，Spring 中提供了具體的實(shí)現(xiàn)攔截器：HandlerInterceptor，攔截器的實(shí)現(xiàn)有兩步：

1.創(chuàng)建自定義攔截器，實(shí)現(xiàn) Spring 中的 HandlerInterceptor 接口中的 preHandle方法

2.將自定義攔截器加入到框架的配置中，并且設(shè)置攔截規(guī)則

給當(dāng)前的類添加 @Configuration 注解

實(shí)現(xiàn) WebMvcConfigurer 接口

重寫(xiě) addInterceptors 方法

注意：一個(gè)項(xiàng)目中可以同時(shí)配置多個(gè)攔截器

（1）創(chuàng)建自定義攔截器

/**
*@Description:自定義用戶登錄的攔截器
*@Date2023/2/1313:06
*/
@Component
publicclassLoginInterceptimplementsHandlerInterceptor{
//返回true表示攔截判斷通過(guò)，可以訪問(wèn)后面的接口
//返回false表示攔截未通過(guò)，直接返回結(jié)果給前端
@Override
publicbooleanpreHandle(HttpServletRequestrequest,HttpServletResponseresponse,
Objecthandler)throwsException{
//1.得到HttpSession對(duì)象
HttpSessionsession=request.getSession(false);
if(session!=null&&session.getAttribute("userinfo")!=null){
//表示已經(jīng)登錄
returntrue;
}
//執(zhí)行到此代碼表示未登錄，未登錄就跳轉(zhuǎn)到登錄頁(yè)面
response.sendRedirect("/login.html");
returnfalse;
}
}

（2）將自定義攔截器添加到系統(tǒng)配置中，并設(shè)置攔截的規(guī)則

addPathPatterns：表示需要攔截的 URL，**表示攔截所有?法

excludePathPatterns：表示需要排除的 URL

說(shuō)明：攔截規(guī)則可以攔截此項(xiàng)?中的使? URL，包括靜態(tài)?件（圖??件、JS 和 CSS 等?件）。

/**
*@Description:將自定義攔截器添加到系統(tǒng)配置中，并設(shè)置攔截的規(guī)則
*@Date2023/2/1313:13
*/
@Configuration
publicclassAppConfigimplementsWebMvcConfigurer{

@Resource
privateLoginInterceptloginIntercept;

@Override
publicvoidaddInterceptors(InterceptorRegistryregistry){
//registry.addInterceptor(newLoginIntercept());//可以直接new也可以屬性注入
registry.addInterceptor(loginIntercept).
addPathPatterns("/**").//攔截所有url
excludePathPatterns("/user/login").//不攔截登錄注冊(cè)接口
excludePathPatterns("/user/reg").
excludePathPatterns("/login.html").
excludePathPatterns("/reg.html").
excludePathPatterns("/**/*.js").
excludePathPatterns("/**/*.css").
excludePathPatterns("/**/*.png").
excludePathPatterns("/**/*.jpg");
}
}

1.4 練習(xí)：登錄攔截器

要求

登錄、注冊(cè)頁(yè)面不攔截，其他頁(yè)面都攔截

當(dāng)?shù)卿洺晒?xiě)入 session 之后，攔截的頁(yè)面可正常訪問(wèn)

在 1.3 中已經(jīng)創(chuàng)建了自定義攔截器 和 將自定義攔截器添加到系統(tǒng)配置中，并設(shè)置攔截的規(guī)則

（1）下面創(chuàng)建登錄和首頁(yè)的 html

（2）創(chuàng)建 controller 包，在包中創(chuàng)建 UserController，寫(xiě)登錄頁(yè)面和首頁(yè)的業(yè)務(wù)代碼

@RestController
@RequestMapping("/user")
publicclassUserController{

@RequestMapping("/login")
publicbooleanlogin(HttpServletRequestrequest,Stringusername,Stringpassword){
booleanresult=false;
if(StringUtils.hasLength(username)&&StringUtils.hasLength(password)){
if(username.equals("admin")&&password.equals("admin")){
HttpSessionsession=request.getSession();
session.setAttribute("userinfo","userinfo");
returntrue;
}
}
returnresult;
}

@RequestMapping("/index")
publicStringindex(){
return"HelloIndex";
}
}

（3）運(yùn)行程序，訪問(wèn)頁(yè)面，對(duì)比登錄前和登錄后的效果

1.5 攔截器實(shí)現(xiàn)原理

有了攔截器之后，會(huì)在調(diào)? Controller 之前進(jìn)?相應(yīng)的業(yè)務(wù)處理，執(zhí)?的流程如下圖所示

實(shí)現(xiàn)原理源碼分析

所有的 Controller 執(zhí)行都會(huì)通過(guò)一個(gè)調(diào)度器 DispatcherServlet 來(lái)實(shí)現(xiàn)

而所有方法都會(huì)執(zhí)行 DispatcherServlet 中的 doDispatch 調(diào)度?法，doDispatch 源碼分析如下：

通過(guò)源碼分析，可以看出，Sping 中的攔截器也是通過(guò)動(dòng)態(tài)代理和環(huán)繞通知的思想實(shí)現(xiàn)的

1.6 統(tǒng)一訪問(wèn)前綴添加

所有請(qǐng)求地址添加 api 前綴，c 表示所有

@Configuration
publicclassAppConfigimplementsWebMvcConfigurer{
//所有的接口添加api前綴
@Override
publicvoidconfigurePathMatch(PathMatchConfigurerconfigurer){
configurer.addPathPrefix("api",c->true);
}
}

2. 統(tǒng)一異常處理

給當(dāng)前的類上加 @ControllerAdvice 表示控制器通知類

給方法上添加 @ExceptionHandler(xxx.class)，表示異常處理器，添加異常返回的業(yè)務(wù)代碼

@RestController
@RequestMapping("/user")
publicclassUserController{
@RequestMapping("/index")
publicStringindex(){
intnum=10/0;
return"HelloIndex";
}
}

在 config 包中，創(chuàng)建 MyExceptionAdvice 類

@RestControllerAdvice//當(dāng)前是針對(duì)Controller的通知類（增強(qiáng)類）
publicclassMyExceptionAdvice{
@ExceptionHandler(ArithmeticException.class)
publicHashMaparithmeticExceptionAdvice(ArithmeticExceptione){
HashMapresult=newHashMap<>();
result.put("state",-1);
result.put("data",null);
result.put("msg","算出異常："+e.getMessage());
returnresult;
}
}

也可以這樣寫(xiě)，效果是一樣的

@ControllerAdvice
publicclassMyExceptionAdvice{
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
publicHashMaparithmeticExceptionAdvice(ArithmeticExceptione){
HashMapresult=newHashMap<>();
result.put("state",-1);
result.put("data",null);
result.put("msg","算數(shù)異常："+e.getMessage());
returnresult;
}
}

如果再有一個(gè)空指針異常，那么上面的代碼是不行的，還要寫(xiě)一個(gè)針對(duì)空指針異常處理器

@ExceptionHandler(NullPointerException.class)
publicHashMapnullPointerExceptionAdvice(NullPointerExceptione){
HashMapresult=newHashMap<>();
result.put("state",-1);
result.put("data",null);
result.put("msg","空指針異常異常："+e.getMessage());
returnresult;
}
@RequestMapping("/index")
publicStringindex(HttpServletRequestrequest,Stringusername,Stringpassword){
Objectobj=null;
System.out.println(obj.hashCode());
return"HelloIndex";
}

但是需要考慮的一點(diǎn)是，如果每個(gè)異常都這樣寫(xiě)，那么工作量是非常大的，并且還有自定義異常，所以上面這樣寫(xiě)肯定是不好的，既然是異常直接寫(xiě) Exception 就好了，它是所有異常的父類，如果遇到不是前面寫(xiě)的兩種異常，那么就會(huì)直接匹配到 Exception

當(dāng)有多個(gè)異常通知時(shí)，匹配順序?yàn)楫?dāng)前類及其?類向上依次匹配

@ExceptionHandler(Exception.class)
publicHashMapexceptionAdvice(Exceptione){
HashMapresult=newHashMap<>();
result.put("state",-1);
result.put("data",null);
result.put("msg","異常："+e.getMessage());
returnresult;
}

可以看到優(yōu)先匹配的還是前面寫(xiě)的 空指針異常

3. 統(tǒng)一數(shù)據(jù)格式返回

3.1 統(tǒng)一數(shù)據(jù)格式返回的實(shí)現(xiàn)

1.給當(dāng)前類添加 @ControllerAdvice

2.實(shí)現(xiàn) ResponseBodyAdvice 重寫(xiě)其方法

supports 方法，此方法表示內(nèi)容是否需要重寫(xiě)（通過(guò)此?法可以選擇性部分控制器和方法進(jìn)行重寫(xiě)），如果要重寫(xiě)返回 true

beforeBodyWrite 方法，方法返回之前調(diào)用此方法

@ControllerAdvice
publicclassMyResponseAdviceimplementsResponseBodyAdvice{

//返回一個(gè)boolean值，true表示返回?cái)?shù)據(jù)之前對(duì)數(shù)據(jù)進(jìn)行重寫(xiě)，也就是會(huì)進(jìn)入beforeBodyWrite方法
//返回false表示對(duì)結(jié)果不進(jìn)行任何處理，直接返回
@Override
publicbooleansupports(MethodParameterreturnType,ClassconverterType){
returntrue;
}

//方法返回之前調(diào)用此方法
@Override
publicObjectbeforeBodyWrite(Objectbody,MethodParameterreturnType,MediaTypeselectedContentType,ClassselectedConverterType,ServerHttpRequestrequest,ServerHttpResponseresponse){
HashMapresult=newHashMap<>();
result.put("state",1);
result.put("data",body);
result.put("msg","");
returnresult;
}
}
@RestController
@RequestMapping("/user")
publicclassUserController{

@RequestMapping("/login")
publicbooleanlogin(HttpServletRequestrequest,Stringusername,Stringpassword){
booleanresult=false;
if(StringUtils.hasLength(username)&&StringUtils.hasLength(password)){
if(username.equals("admin")&&password.equals("admin")){
HttpSessionsession=request.getSession();
session.setAttribute("userinfo","userinfo");
returntrue;
}
}
returnresult;
}

@RequestMapping("/reg")
publicintreg(){
return1;
}
}

3.2 @ControllerAdvice 源碼分析

通過(guò)對(duì) @ControllerAdvice 源碼的分析我們可以知道上面統(tǒng)一異常和統(tǒng)一數(shù)據(jù)返回的執(zhí)行流程

（1）先看 @ControllerAdvice 源碼

可以看到 @ControllerAdvice 派生于 @Component 組件而所有組件初始化都會(huì)調(diào)用 InitializingBean 接口

（2）下面查看 initializingBean 有哪些實(shí)現(xiàn)類

在查詢過(guò)程中發(fā)現(xiàn)，其中 Spring MVC 中的實(shí)現(xiàn)子類是 RequestMappingHandlerAdapter，它里面有一個(gè)方法 afterPropertiesSet（）方法，表示所有的參數(shù)設(shè)置完成之后執(zhí)行的方法

（3）而這個(gè)方法中有一個(gè) initControllerAdviceCache 方法，查詢此方法

發(fā)現(xiàn)這個(gè)方法在執(zhí)行時(shí)會(huì)查找使用所有的 @ControllerAdvice 類，發(fā)送某個(gè)事件時(shí)，調(diào)用相應(yīng)的 Advice 方法，比如返回?cái)?shù)據(jù)前調(diào)用統(tǒng)一數(shù)據(jù)封裝，比如發(fā)生異常是調(diào)用異常的 Advice 方法實(shí)現(xiàn)的。

審核編輯：劉清