SpringBoot 统⼀功能处理 AOP

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

接下来是 Spring Boot 统⼀功能处理模块了也是 AOP 的实战环节要实现的⽬标有以下 3 个 

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

1.⽤户登录权限效验
⽤户登录权限的发展从之前每个⽅法中⾃⼰验证⽤户登录权限到现在统⼀的⽤户登录验证处理它是⼀个逐渐完善和逐渐优化的过程。

package com.example._20230103.controller;

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 UserController2 {
    @RequestMapping("/m1")
    public Object method(HttpServletRequest request) {
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("userinfo") != null) {
            //说明已经登录业务处理
            return true;
        } else {
            //未登录
            return false;
        }
    }

    @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;
        }
    }
}

从上述代码可以看出每个⽅法中都有相同的⽤户登录验证权限它的缺点是
1. 每个⽅法中都要单独写⽤户登录验证的⽅法即使封装成公共⽅法也⼀样要传参调⽤和在⽅法中进⾏判断。
2. 添加控制器越多调⽤⽤户登录验证的⽅法也越多这样就增加了后期的修改成本和维护成本。
3. 这些⽤户登录验证的⽅法和接下来要实现的业务⼏何没有任何关联但每个⽅法中都要写⼀遍。
所以提供⼀个公共的 AOP ⽅法来进⾏统⼀的⽤户登录权限验证迫在眉睫。
 

2.Spring AOP ⽤户统⼀登录验证的问题
说到统⼀的⽤户登录验证我们想到的第⼀个实现⽅案是 Spring AOP 前置通知或环绕通知来实现具体实现代码如下

package com.example._20230103.commons;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class UserAspect2 {
    //定义切点方法 controller 包下子孙包下所有类的所有方法
    @Pointcut("execution(* com.example._20230103.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 e) {
            throw new RuntimeException(e);
        }
        System.out.println("Around 方法结束执行");
        return obj;
    }
}

如果要在以上 Spring AOP 的切⾯中实现⽤户登录权限效验的功能有以下两个问题

  • 没办法获取到 HttpSession 对象。
  • 我们要对⼀部分⽅法进⾏拦截⽽另⼀部分⽅法不拦截如注册⽅法和登录⽅法是不拦截的这样的话排除⽅法的规则很难定义甚⾄没办法定义。

3.Spring 拦截器
对于以上问题 Spring 中提供了具体的实现拦截器HandlerInterceptor拦截器的实现分为以下两个步骤:

  •  创建⾃定义拦截器实现 HandlerInterceptor 接⼝的 preHandle执⾏具体⽅法之前的预处理⽅法。
  • 将⾃定义拦截器加⼊ WebMvcConfigurer 的 addInterceptors ⽅法中

具体实现如下。
 

将⾃定义拦截器加⼊到系统配置


其中

  • addPathPatterns表示需要拦截的 URL“**”表示拦截任意⽅法也就是所有⽅法。
  • excludePathPatterns表示需要排除的 URL。

说明以上拦截规则可以拦截此项⽬中的使⽤ URL包括静态⽂件图⽚⽂件、JS 和 CSS 等⽂件。

登录、注册⻚⾯不拦截其他⻚⾯都拦截。

 未登录时候访问其他方法运行结果

当登录成功写⼊ session 之后拦截的⻚⾯可正常访问。

在访问http://localhost:8080/user/hello 

 4.拦截器实现原理

正常情况下的调⽤顺序


然⽽有了拦截器之后会在调⽤ Controller 之前进⾏相应的业务处理执⾏的流程如下图所示


实现原理源码分析
所有的 Controller 执⾏都会通过⼀个调度器 DispatcherServlet 来实现这⼀点可以从 Spring Boot 控制台的打印信息看出如下图所示

⽽所有⽅法都会执⾏ DispatcherServlet 中的 doDispatch 调度⽅法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 {
            try {
                ModelAndView mv = null;
                Object dispatchException = null;

                try {
                    processedRequest = this.checkMultipart(request);
                    multipartRequestParsed = processedRequest != request;
                    mappedHandler = this.getHandler(processedRequest);
                    if (mappedHandler == null) {
                        this.noHandlerFound(processedRequest, response);
                        return;
                    }
                    HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.getHandler());
                    String method = request.getMethod();
                    boolean isGet = HttpMethod.GET.matches(method);
                    if (isGet || HttpMethod.HEAD.matches(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;
                    }
                    this.applyDefaultViewName(processedRequest, mv);
                    mappedHandler.applyPostHandle(processedRequest, response, mv);
                } catch (Exception var20) {
                    dispatchException = var20;
                } catch (Throwable var21) {
                    dispatchException = new NestedServletException("Handler di spatch failed", var21);
                }
                this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception) dispatchException);
            } catch (Exception var22) {
                this.triggerAfterCompletion(processedRequest, response, mappedHandler, var22);
            } catch (Throwable var23) {
                this.triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", var23));
            }
        } finally {
            if (asyncManager.isConcurrentHandlingStarted()) {
                if (mappedHandler != null) {
                    mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
                }
            } else if (multipartRequestParsed) {
                this.cleanupMultipart(processedRequest);
            }
        }
    }

从上述源码可以看出在开始执⾏ Controller 之前会先调⽤ 预处理⽅法 applyPreHandle⽽
applyPreHandle ⽅法的实现源码如下

    boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
        for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            if (!interceptor.preHandle(request, response, this.handler)) {
                this.triggerAfterCompletion(request, response, (Exception)null);
                return false;
            }
        }

        return true;
    }

从上述源码可以看出在 applyPreHandle 中会获取所有的拦截器 HandlerInterceptor 并执⾏拦截器中的 preHandle ⽅法这样就会咱们前⾯定义的拦截器对应上了如下图所示


 

此时⽤户登录权限的验证⽅法就会执⾏这就是拦截器的实现原理。

拦截器⼩结
通过上⾯的源码分析我们可以看出Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的⼤体的调⽤流程如下


5.统⼀异常处理

运行结果

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


 

运行结果

现在又有别的异常原来的异常管理不管用了。

运行结果

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

运行结果

 

我们可以针对不同的异常返回不同的结果弄个低保出了错总能返回一个异常信息



 

运行结果

 6.统⼀数据返回格式

为什么需要统⼀数据返回格式
统⼀数据返回格式的优点有很多⽐如以下⼏个

  1. ⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据。
  2. 降低前端程序员和后端程序员的沟通成本按照某个格式实现就⾏了因为所有接⼝都是这样返回的。
  3. 有利于项⽬统⼀数据的维护和修改。
  4. 有利于后端技术部⻔的统⼀规范的标准制定不会出现稀奇古怪的返回内容。
     

统⼀数据返回格式的实现

统⼀的数据返回格式可以使⽤ @ControllerAdvice + ResponseBodyAdvice 的⽅式实现具体实现代码如下

 

 

 运行结果

 

7.⽤户登录+拦截器

  1. 实现注册和登录功能
  2. 添加统⼀的错误处理@ControllerAdvice
  3. 添加登录拦截器WebMvcConfigurer + HandlerInterceptor
  4. ⽤户登录之后能到欢迎⻚未登录直接跳转到登录⻚⾯
  5. 添加统⼀的返回格式包含status、data、msg 字段。
     

 未完待续~

 


 

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
标签: Spring
返回列表

上一篇：【计算机网络】网络基础

下一篇：Python协程的四种实现方式

“SpringBoot 统⼀功能处理 AOP” 的相关文章

SpringBoot或SpringCloud集成Nacos1年前 (2023-02-02)
【Docker】（二）使用Dockerfile构建并发布一个SpringBoot服务1年前 (2023-02-02)
10天，几万字，源码深度解析之 Spring IOC1年前 (2023-02-02)
【Springboot项目】电信知识库系统_电信知识库1年前 (2023-02-02)
最新最全面的Spring详解（一）——Spring概述与IOC容器1年前 (2023-02-02)
Springbot启动报错-类文件具有错误的版本 61.0, 应为 52.0_类文件具有错误的版本 61.0, 应为 52.01年前 (2023-02-02)
【SSM整合】SpringMVC + Spring + Mybatis整合详细教程1年前 (2023-02-02)
springboot+vue练手级项目，真实的在线博客系统_spring boot+vue项目1年前 (2023-02-02)
Spring存储和读取对象 -- 21年前 (2023-02-02)
java+Springboot交通事故档案管理系统1年前 (2023-02-02)

阿里云国际版