SpringBoot學習之整合AOP

Charles Yan發表於2020-10-11

SpringBoot學習之整合AOP

基於SpringBoot整合Aop記錄日誌

SpringBoot各版本參考文件

https://docs.spring.io/spring-boot/docs/
查詢引入依賴

引入依賴



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

切面類



  package link.lycreate.springbooteasyexceldemo.aspect;

  import lombok.extern.slf4j.Slf4j;
  import org.aspectj.lang.JoinPoint;
  import org.aspectj.lang.ProceedingJoinPoint;
  import org.aspectj.lang.annotation.*;
  import org.aspectj.lang.reflect.MethodSignature;
  import org.springframework.stereotype.Component;
  import org.springframework.web.context.request.RequestAttributes;
  import org.springframework.web.context.request.RequestContextHolder;
  import org.springframework.web.context.request.ServletRequestAttributes;

  import javax.servlet.http.HttpServletRequest;
  import java.lang.reflect.Method;
  import java.util.Arrays;

  /**
  * @ClassName LogAspect
  * @Description TODO 日誌切面類$
  * @Author charlesYan
  * @Date 2020/10/9 12:53
  * @Version 1.0
  **/
  @Aspect  // 宣告是一個切面元件
  @Component // 加入到IOC容器
  @Slf4j  // 等同於 private final Logger logger = LoggerFactory.getLogger(XXX.class);
  public class LogAspect {

      /**
      * @Author charlesYan
      * @Description // 指定切入點表示式，攔截那些方法，即為哪些類生成代理物件
      *      第一*表示匹配任何返回值的方法
      *      第二*表示匹配controller包下的所有類
      *      第三*表示匹配類下的所有方法
      *      ..表示任何個數引數，和如何型別的引數
      **/
      //@Pointcut("execution(* link.lycreate.springbooteasyexceldemo.controller.*.*(..))")
      @Pointcut("@annotation(link.lycreate.springbooteasyexceldemo.aspect.LogFilter)") //在所有標記指定註解的方法上攔截
      public void logPointCut(){}

      /**
      * @Author charlesYan
      * @Description //前置通知：在目標方法執行前呼叫
      **/
      @Before("logPointCut()")
      public void before(JoinPoint joinPoint){
          System.out.println("---------------Before Begin CurrentTime = " + System.currentTimeMillis());
          /*獲取當前請求的HttpServletRequest*/
          RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
          HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();

          log.info("URL-->"+request.getRequestURL().toString());
          log.info("IP-->"+request.getRemoteAddr());
          log.info("HTTP_Method-->"+request.getMethod());
          log.info("Request_args-->"+ Arrays.toString(joinPoint.getArgs()));

          System.out.println("---------------Before End CurrentTime = " + System.currentTimeMillis());

      }

      /**
      * @Author charlesYan
      * @Description //返回通知 在目標方法執行後呼叫，若目標方法出現異常，則不執行
      **/
      @AfterReturning(value = "logPointCut()",returning = "obj")
      public void afterReturning(JoinPoint joinPoint,Object obj){
          System.out.println("---------------AfterReturn CurrentTime = " + System.currentTimeMillis());

      }

      /**
      * @Author charlesYan
      * @Description //後置通知：無論目標方法在執行過程中是否出現異常都會在它之後呼叫
      **/
      @After("logPointCut()")
      public void after(JoinPoint joinPoint){
          System.out.println("---------------After CurrentTime = " + System.currentTimeMillis());
      }

      /**
      * @Author charlesYan
      * @Description //異常通知：目標方法丟擲異常時執行
      **/
      @AfterThrowing(value = "logPointCut()", throwing = "ex")
      public void afterThrowing(JoinPoint joinPoint,Exception ex){
          System.out.println("---------------AfterThrowing CurrentTime = " + System.currentTimeMillis());
      }

      /**
      * @Author charlesYan
      * @Description //環繞通知：是前面四個通知的結合體
      *         需要在方法之前執行，可以寫在joinPoint.procedd();之前
      *         需要在方法之後執行，可以寫在joinPoint.procedd();之後
      **/
      @Around("logPointCut()")
      public void around(ProceedingJoinPoint joinPoint) throws Throwable {

          // 獲取目標方法的名稱
          String methodName = joinPoint.getSignature().getName();
          // 獲取方法傳入引數
          Object[] params = joinPoint.getArgs();
          MethodSignature signature = (MethodSignature) joinPoint.getSignature();
          Method method = signature.getMethod();
          // 獲取方法上LogFilter註解
          LogFilter logFilter = method.getAnnotation(LogFilter.class);
          String value = logFilter.value() ;
          log.info("模組描述:"+value);
          System.out.println("---------------Around Before CurrentTime = " + System.currentTimeMillis() + " method name：" + methodName + " args：" + params[0]);
          // 執行源方法
          joinPoint.proceed();
          System.out.println("---------------Around After CurrentTime = " + System.currentTimeMillis() + " method name：" + methodName + " args：" + params[0]);
      }
  }

自定義註解



  /**
  * @ClassName LogFilter
  * @Description TODO 自定義日誌註解類$
  * @Author charlesYan
  * @Date 2020/10/11 17:59
  * @Version 1.0
  **/

  @Target(ElementType.METHOD)//Target註解決定LogFilter註解可以加在哪些成分上，如加在類身上，或者屬性身上，或者方法身上等成分
  @Retention(RetentionPolicy.RUNTIME)//Retention註解括號中的"RetentionPolicy.RUNTIME"意思是讓LogFilter這個註解的生命週期一直程式執行時都存在
  @Documented
  public @interface LogFilter {

      String value() default "";
  }

請求方法


  @LogFilter("儲存請求日誌")
  @RequestMapping(path = "/saveRequestLog",method = RequestMethod.POST)
  public String saveRequestLog(@RequestParam("name")String name){
      return "請求成功：" + name;
  }

測試方式

報錯資訊

方法引數未宣告

報錯資訊


  Caused by: java.lang.IllegalArgumentException: error at ::0 formal unbound in pointcut

截圖資訊

錯誤程式碼


  /**
  * @Author charlesYan
  * @Description //返回通知 在目標方法執行後呼叫，若目標方法出現異常，則不執行
  **/
  @AfterReturning("logPointCut()")
  public void afterReturning(JoinPoint joinPoint,Object obj){
      System.out.println("---------------AfterReturn CurrentTime = " + System.currentTimeMillis());

  }

正確程式碼


  /**
  * @Author charlesYan
  * @Description //返回通知 在目標方法執行後呼叫，若目標方法出現異常，則不執行
  **/
  @AfterReturning(value = "logPointCut()", returning = "obj")
  public void afterReturning(JoinPoint joinPoint,Object obj){
      System.out.println("---------------AfterReturn CurrentTime = " + System.currentTimeMillis());

  }

原因分析
```
  新增的方法引數未賦值
```

總結

Aop切面通知執行順序

例圖

通知註解中的value屬性補充

自定義註解


  //註解實體類
  package com.trip.demo;

  import java.lang.annotation.ElementType;
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  import java.lang.annotation.Target;


  @Retention(RetentionPolicy.RUNTIME)
  @Target({ ElementType.METHOD })
  public @interface SMSAndMailSender {

      /*簡訊模板String格式化串*/
      String value() default "";

      String smsContent() default "";

      String mailContent() default "";
      /*是否啟用傳送功能*/
      boolean isActive() default true;
      /*主題*/
      String subject() default "";

  }

切面類中的切面方法


  /**
  * 在所有標記了@SMSAndMailSender的方法中切入
  * @param joinPoint
  * @param obj
  */
  @AfterReturning(value="@annotation(com.trip.demo.SMSAndMailSender)", returning="obj")
  public void afterReturning(JoinPoint joinPoint,Object obj){
      System.out.println("---------------AfterReturn CurrentTime = " + System.currentTimeMillis());

  }

參考連結

SpringBoot整合Aop

https://www.cnblogs.com/fernfei/p/12092510.html
SpringBoot整合aop

https://www.cnblogs.com/myitnews/p/11848159.html
SpringBoot 通過自定義註解實現AOP切面程式設計例項

https://www.cnblogs.com/lingyejun/p/9941350.html
SpringBoot2.0 基礎案例(11)：配置AOP切面程式設計，解決日誌記錄業務

https://my.oschina.net/cicadasmile/blog/3073069
淺談Spring AOP 面向切面程式設計最通俗易懂的畫圖理解AOP、AOP通知執行順序~

https://www.cnblogs.com/ChromeT/p/11823735.html
@interface 註解詳解

https://blog.csdn.net/u010882691/article/details/82427520

SpringBoot學習之整合Swagger
2020-08-08
Spring BootSwagger
SpringBoot學習之整合Mybatis
2020-07-31
Spring BootMyBatis
Spring-boot整合AOP及AOP相關學習
2018-12-28
Springboot
jackson學習之九：springboot整合(配置檔案)
2021-02-07
Spring Boot
jackson學習之十(終篇)：springboot整合(配置類)
2021-09-09
Spring Boot
Rabbit學習---SpringBoot整合RabbitMQ
2021-01-03
Spring BootMQ
SpringBoot整合Activiti學習(一)
2020-11-29
Spring Boot
【springboot】學習4:整合JDBC、整合druid、整合mybatis、整合 SpringSecurity
2020-09-24
Spring BootJDBCUIMyBatisGse
Elasticsearch學習（三）springboot整合ElasticSearch
2021-01-02
ElasticsearchSpring Boot
Elasticsearch學習＜四＞SpringBoot整合es
2020-12-10
ElasticsearchSpring Boot
個人學習系列 - SpringBoot整合RabbitMQ
2021-11-23
Spring BootMQ
SpringBoot學習之mvc
2021-09-09
Spring BootMVC
SSM框架學習之Spring的AOP學習以及資料整理
2020-10-12
SSM框架Spring
SpringBoot整合ElasticSearch 入門demo學習筆記
2020-11-05
Spring BootElasticsearch筆記
SpringBoot使用AOP
2021-09-09
Spring Boot
SpringBoot之Dubbo和Zookeeper整合
2020-10-15
Spring Boot
Spring AOP學習筆記01：AOP概述
2020-06-03
Spring筆記
AOP學習筆記
2019-04-01
筆記
SpringBoot 學習之 No bean named ‘xxx’ available
2020-07-30
Spring BootBeanAI
SpringBoot學習之資料結構
2020-12-18
Spring Boot資料結構
ML《整合學習（二）Boosting之Adaboosting》
2021-01-03
Spring AOP學習筆記03：AOP的核心實現之獲取增強器
2020-06-15
Spring筆記
整合學習（一）：簡述整合學習
2022-03-20
SpringBoot AOP的使用
2019-01-23
Spring Boot
springboot中的AOP
2019-11-22
Spring Boot
SpringBoot部落格開發之AOP日誌處理
2021-08-31
Spring Boot
Springcloud學習筆記68--springboot 整合Caffeine 本地快取
2024-05-31
GCCloud筆記Spring Boot快取
Spring AOP學習筆記02：如何開啟AOP
2020-06-08
Spring筆記
Spring5.0原始碼學習系列之Spring AOP簡述
2020-11-26
Spring原始碼
SpringBoot 學習
2019-01-19
Spring Boot
springboot學習
2020-12-05
Spring Boot
整合學習
2024-05-13
SpringBoot系列之YAML配置用法學習筆記
2020-02-01
Spring BootYAML筆記
SpringBoot之整合thymeleaf渲染Web頁面
2020-12-26
Spring BootWeb
ML.NET 示例：深度學習之整合TensorFlow
2018-12-16
深度學習
機器學習之整合演算法
2019-08-04
機器學習演算法
python學習之Python整合開發環境
2020-09-02
Python開發環境
Spring AOP學習筆記05：AOP失效的罪因
2020-06-29
Spring筆記

SpringBoot學習之整合AOP

SpringBoot學習之整合AOP

基於SpringBoot整合Aop記錄日誌

報錯資訊

方法引數未宣告

總結

Aop切面通知執行順序

通知註解中的value屬性補充

參考連結

相關文章