SpringBoot整合AOP

Posted 2021-05-13 pcdd

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot整合AOP相关的知识，希望对你有一定的参考价值。

认识AOP
1.1 什么是AOP
1.2 AOP中的概念
SpringBoot整合AOP代码示例
2.1 使用execution（路径表达式）
2.2 使用annotation（注解）
JoinPoint 对象
ProceedingJoinPoint对象
使用了环绕通知后，全局异常捕获失效的解决办法

1 认识Spring AOP

1.1 什么是AOP

AOP (Aspect Oiented Programn,面向切面编程)把业务功能分为核心、非核心两部分。

● 核心业务功能:用户登录、增加数据、删除数据。
● 非核心业务功能:性能统计、日志、事务管理。

在Spring的面向切面编程( AOP )思想里，非核心业务功能被定义为切面。核心业务功能和切面功能先被分别进行独立开发，然后把切面功能和核心业务功能“编织”在一起，这就是AOP。

未使用AOP的程序如图1 所示，使用AOP的程序如图2 所示。由此可见，AOP将那些与业务无关，却为业务模块所共同调用的逻辑封装起来，以便减少系统的重复代码，降低模块间的耦合度，利于未来的拓展和维护。这正是AOP的目的，它是Spring最为重要的功能之一，被广泛使用。

在这里插入图片描述

1.2 AOP中的概念

● 切入点(pointcut)：在哪些类、哪些方法上切入。

● 通知(advice)：在方法前、方法后、方法前后做什么。

● 切面 = 切入点 + 通知。即在什么时机、什么地方、做什么。

● 织入(weaving)：把切面加入对象，并创建出代理对象的过程

● 环绕通知(around)：AOP中最强大、灵活的通知，它集成了前置和后置通知，保留了连接点原有的方法。

AOP的体系可以梳理为下图：
在这里插入图片描述

2 AOP代码示例

首先导入AOP的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2.1 使用execution（路径表达式）

@Slf4j
@Aspect
@Component
public class LogAspect {

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    /**
     * execution函数用于匹配方法执行的连接点，语法为：
     * execution(方法修饰符(可选)  返回类型  方法名  参数  异常模式(可选))
     * 参数部分允许使用通配符：
     * *  匹配任意字符，但只能匹配一个元素
     * .. 匹配任意字符，可以匹配任意多个元素，表示类时，必须和*联合使用
     * +  必须跟在类名后面，如Horseman+，表示类本身和继承或扩展指定类的所有类
     */
    @Pointcut("execution(public * work.pcdd.aop_demo.controller.*.*(..))")
    private void webLog() {}

    /**
     * 前置通知：在目标方法被调用之前调用通知功能
     */
    @Before("webLog()")
    public void doBefore(JoinPoint jp) {
        System.out.println("=====================doBefore======================");
        // 接收到请求
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 记录请求内容
        log.info("URL : {}", request.getRequestURL());
        log.info("HTTP方法 : {}", request.getMethod());
        log.info("IP地址 : {}", request.getRemoteAddr());
        log.info("类的方法 : {}.{}", jp.getSignature().getDeclaringTypeName(), jp.getSignature().getName());
        log.info("方法参数 : {}", Arrays.toString(jp.getArgs()));
        System.out.println("=====================doBefore======================");
    }

    /**
     * 返回通知：在目标方法成功执行之后调用通知
     */
    @AfterReturning(pointcut = "webLog()", returning = "result")
    public void doAfterReturning(Object result) {
        System.out.println("=====================doAfterReturning======================");
        // 处理完请求，返回内容
        System.out.println("方法的返回值 : " + result);
        System.out.println("=====================doAfterReturning======================");
    }

    /**
     * 最终通知：在目标方法完成之后调用通知，不管是抛出异常或者正常退出都会执行
     */
    @After("webLog()")
    public void doAfter(JoinPoint jp) {
        System.out.println("=====================doAfter======================");
        System.out.println("方法最后执行.....");
        System.out.println("=====================doAfter======================");
    }

    /**
     * 环绕通知：通知包裹了被通知的方法，在被通知的方法调用之前和调用之后执行，相当于MethodInterceptor
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint pjp) {
        System.out.println("=====================doAround======================");
        System.out.println("方法环绕start.....");
        startTime.set(System.currentTimeMillis());
        try {
            Object o = pjp.proceed();
            System.out.println("方法环绕proceed，结果是 :" + o);
            System.out.println("方法执行耗时：" + (System.currentTimeMillis() - startTime.get()) + " ms");
            System.out.println("=====================doAround======================");
            return o;
        } catch (Throwable e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 异常通知：在目标方法抛出异常后调用通知
     */
    @AfterThrowing(pointcut = "webLog()", throwing = "ex")
    public void doThrows(JoinPoint jp, Exception ex) {
        System.out.println("=====================doThrows======================");
        System.out.println("方法异常时执行\\n发生的异常：" + ex.getClass().getName() + "\\n异常信息：" + ex.getMessage());
        System.out.println("=====================doThrows======================");
    }


}

controller代码如下，返回当前日期时间

@RestController
public class BaseController {

    @GetMapping("/api1")
    public Map<String, Object> api1() {
        Map<String, Object> map = new HashMap<>(16);
        map.put("nowTime", LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
        return map;
    }
}

调用接口，控制台输出结果如下：

=====================doAround======================
方法环绕start.....
=====================doBefore======================
2021-05-09 23:20:58.013  INFO 14772 --- [nio-8080-exec-1] work.pcdd.aop_demo.aop.LogAspect         : URL : http://192.168.85.1:8080/api1
2021-05-09 23:20:58.014  INFO 14772 --- [nio-8080-exec-1] work.pcdd.aop_demo.aop.LogAspect         : HTTP方法 : GET
2021-05-09 23:20:58.014  INFO 14772 --- [nio-8080-exec-1] work.pcdd.aop_demo.aop.LogAspect         : IP地址 : 192.168.85.1
2021-05-09 23:20:58.015  INFO 14772 --- [nio-8080-exec-1] work.pcdd.aop_demo.aop.LogAspect         : 类的方法 : work.pcdd.aop_demo.controller.BaseController.api1
2021-05-09 23:20:58.016  INFO 14772 --- [nio-8080-exec-1] work.pcdd.aop_demo.aop.LogAspect         : 方法参数 : []
=====================doBefore======================
=====================doAfterReturning======================
方法的返回值 : {nowTime=2021-05-09 23:20:58}
=====================doAfterReturning======================
=====================doAfter======================
方法最后执行.....
=====================doAfter======================
方法环绕proceed，结果是 :{nowTime=2021-05-09 23:20:58}
方法执行耗时：18 ms
=====================doAround======================

代码解释如下：

● @Aspect：标记为切面类

● @Component：把切面类加入IoC容器中，让Spring进行管理

● @Before：再切入点开始处切入内容。

● @After：在切入点结尾处切入内容

● @AfterReturning：在切入点返回内容之后切入内容，可以用来对处理返回值做一些加工处理。

● @Around：在切入点前后切入内容，并控制何时执行切入点自身的内容。

● @AfterThrowing：用来处理当切入内容部分抛出异常之后的处理逻辑。

注：
● 被@Around标注的方法，必须要有一个ProceedingJoinPoint类型的参数，其他的可以不加参数
● @Order用于指定Spring IOC容器中Bean的执行顺序的优先级（不是定义Bean的加载顺序），值越小拥有越高的优先级，可为负数。

源码如下：
在这里插入图片描述

2.1 使用annotation（注解）

首先定义一个注解（不想自定义注解使用系统注解也可以，比如@GetMapping）

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation {
    String value() default "";
}

定义切面

@Slf4j
@Aspect
@Component
public class AnnotationAspect {

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Pointcut("@annotation(work.pcdd.aop_demo.annotation.MyAnnotation))")
    private void myAnnotationCheck() {
    }

    @Before("myAnnotationCheck()")
    public void doBefore(JoinPoint jp) {
        System.out.println("=====================doBefore======================");
        startTime.set(System.currentTimeMillis());
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        log.info("URL : {}", request.getRequestURL());
        log.info("HTTP方法 : {}", request.getMethod());
        log.info("IP地址 : {}", request.getRemoteAddr());
        log.info("类的方法 : {}.{}", jp.getSignature().getDeclaringTypeName(), jp.getSignature().getName());
        log.info("方法参数 : {}", Arrays.toString(jp.getArgs()));
        System.out.println("=====================doBefore======================");
    }

    /**
     * 后置增强
     */
    @AfterReturning(pointcut = "myAnnotationCheck()", returning = "result")
    public void doAfterReturning(Object result) {
        System.out.println("=====================doAfterReturning======================");
        log.info("方法的返回值 : {}", result);
        log.info("耗时 : {}ms", (System.currentTimeMillis() - startTime.get()));
        System.out.println("=====================doAfterReturning======================");
    }
}

controller代码如下，先阻塞两秒，观察耗时

@RestController
public class BaseController {

    @MyAnnotation
    @GetMapping("/api2")
    public String api2() throws InterruptedException {
        TimeUnit.SECONDS.sleep(2);
        return "api2 调用成功";
    }
}

执行结果如下：

=====================doBefore======================
2021-05-09 23:43:47.144  INFO 14772 --- [nio-8080-exec-3] work.pcdd.aop_demo.aop.AnnotationAspect  : URL : http://192.168.85.1:8080/api2
2021-05-09 23:43:47.144  INFO 14772 --- [nio-8080-exec-3] work.pcdd.aop_demo.aop.AnnotationAspect  : HTTP方法 : GET
2021-05-09 23:43:47.144  INFO 14772 --- [nio-8080-exec-3] work.pcdd.aop_demo.aop.AnnotationAspect  : IP地址 : 192.168.85.1
2021-05-09 23:43:47.145  INFO 14772 --- [nio-8080-exec-3] work.pcdd.aop_demo.aop.AnnotationAspect  : 类的方法 : work.pcdd.aop_demo.controller.BaseController.api2
2021-05-09 23:43:47.145  INFO 14772 --- [nio-8080-exec-3] work.pcdd.aop_demo.aop.AnnotationAspect  : 方法参数 : []
=====================doBefore======================
====================以上是关于SpringBoot整合AOP的主要内容，如果未能解决你的问题，请参考以下文章 
 SpringBoot学习笔记：整合aop
 SpringBootSpingBoot整合AOP
 SpringBoot整合aop日志管理
 SpringBoot——整合aop
 SpringBoot整合Mybatis多数据源 (AOP+注解)
 SpringBoot整合WEB开发--配置AOP