Spring Boot 使用 Aop 實現日志全局攔截

前面的章節我們學習到 Spring Boot Log 日志使用教程 和 Spring Boot 異常處理與全局異常處理，本章我們結合 Aop 面向切面編程來實現全局攔截異常並記錄日志。

在 Spring Boot 中 Aop 與 Ioc 可以說是 Spring 的靈魂，其功能也是非常強大。

本項目源碼下載

1 新建 Spring Boot 項目

1）File > New > Project，如下圖選擇 Spring Initializr 然后點擊 【Next】下一步

2）填寫 GroupId（包名）、Artifact（項目名） 即可。點擊 下一步
groupId=com.fishpro
artifactId=aoplog

3)選擇依賴 Spring Web Starter 前面打鈎。

4)項目名設置為 spring-boot-study-aoplog

2 Pom 中引入 aop 依賴

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--aop-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

3 編寫處理代碼

3.1 程序原理及流程

在 Spring Boot 應用程序中使用 @Aspect 注解來實現 aop ，非常的簡單。本示例代碼主要實現

本代碼供新增了4個文件,文件清單如下，斜杠前是包名，需要新建

• annotation/Log.java 自定義日志攔截注解
• aspect/LogAspect.java 自定義日志攔截注解觸發條件、環繞增強（在請求前和請求后的執行邏輯）
• aspect/WebLogAspect.java 基於 Web 的日志攔截，定義了 Web 的請求前動作、請求后動作、請求生命周期中的動作
• controller/IndexController.java 控制層 Controller 類，方便測試，定了 /log

本示例使用到的新的注解包括

• @Aspect 面向切面編程注解，通常應用在類上
• @Pointcut Pointcut是植入Advice的觸發條件。每個Pointcut的定義包括2部分，一是表達式，二是方法簽名。方法簽名必須是 public及void型。可以將Pointcut中的方法看作是一個被Advice引用的助記符，因為表達式不直觀，因此我們可以通過方法簽名的方式為 此表達式命名。因此Pointcut中的方法只需要方法簽名，而不需要在方法體內編寫實際代碼
• @Around：環繞增強，相當於MethodInterceptor
• @AfterReturning：后置增強，相當於AfterReturningAdvice，方法正常退出時執行
• @Before：標識一個前置增強方法，相當於BeforeAdvice的功能，相似功能的還有
• @AfterThrowing：異常拋出增強，相當於ThrowsAdvice
• @After: final增強，不管是拋出異常或者正常退出都會執行

流程說明

如圖所示，用戶訪問 IndexController 的 /log 路由的時候，被 WebLogAspect 攔截到了帶有 @log 注解方法的信息，根據 WebLogAspect 中的定義處理了請求前 請求后 請求中的信息 並存於日志中。

3.2 自定義日志注解 @log

本文不打算詳細說明什么是自定義注解，如何使用，可以知道的是，

• 注解是一種元數據形式。即注解是屬於java的一種數據類型，和類、接口、數組、枚舉類似
• 注解用來修飾，類、方法、變量、參數、包。
• 注解不會對所修飾的代碼產生直接的影響。

定義注解 @Log，在 anotation 包下 Log.java

/**
 * 使用@interface將定義一個注解 這里是log
 * 用於日志aop編程
 * */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
    String value() default "";
}

如何使用，我沒有在 IndexController 的方法中使用 @Log 注解

3.3 定義測試用 IndexController

@Controller
public class IndexController {

    @Log("日志注解，配合WebAspect記錄請求前、請求后、請求過程")
    @RequestMapping("/log")
    @ResponseBody
    public String log(String name){
        return "log";
    }
}

3.4 定義 aop 類 LogAspect 與 WebLogAspect

@Aspect
@Component
public class LogAspect {
    private static final Logger logger=LoggerFactory.getLogger(LogAspect.class);

    /**
     * 這里指定使用 @annotation 指定com.fishpro.aoplog.annotation.Log log注解
     * */
    @Pointcut("@annotation(com.fishpro.aoplog.annotation.Log)")
    public void logPointCut(){

    }

    public  Object around(ProceedingJoinPoint point) throws Throwable{
        long beginTime = System.currentTimeMillis();
        // 執行方法
        Object result = point.proceed();
        // 執行時長(毫秒)
        long time = System.currentTimeMillis() - beginTime;
        //異步保存日志 這里是文本日志

        return result;
    }

    void saveLog(ProceedingJoinPoint joinPoint, long time) throws InterruptedException{

    }
}

@Aspect
@Component
public class WebLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    /**
     * 指定 controller 包下的注解
     * */
    @Pointcut("execution( * com.fishpro.aoplog.controller.*.*(..))")//兩個..代表所有子目錄，最后括號里的兩個..代表所有參數
    public void logPointCut() {

    }

    /**
     * 指定當前執行方法在logPointCut之前執行
     * */
    @Before("logPointCut()")
    public void doBefore(JoinPoint joinPoint) throws Throwable{
        // 接收到請求，記錄請求內容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 記錄下請求內容
        logger.info("請求地址 : " + request.getRequestURL().toString());
        logger.info("HTTP METHOD : " + request.getMethod());
        // 獲取真實的ip地址
        //logger.info("IP : " + IPAddressUtil.getClientIpAddress(request));
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        logger.info("參數 : " + Arrays.toString(joinPoint.getArgs()));
        //loggger.info("參數 : " + joinPoint.getArgs());
    }
    /**
     * 指定在方法之后返回
     * */
    @AfterReturning(returning = "ret", pointcut = "logPointCut()")// returning的值和doAfterReturning的參數名一致
    public void doAfterReturning(Object ret) throws Throwable {
        // 處理完請求，返回內容(返回值太復雜時，打印的是物理存儲空間的地址)
        logger.info("返回值 : " + ret);
    }

    @Around("logPointCut()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object ob = pjp.proceed();// ob 為方法的返回值
        logger.info("耗時 : " + (System.currentTimeMillis() - startTime));
        return ob;
    }
}

3.5 測試

在瀏覽器輸入,注意端口在 application.yml 中已經改為了8085

http://localhost:8085/log?name=fishpro
在控制台輸出

2019-07-13 17:12:15.388  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : 請求地址 : http://localhost:8085/log
2019-07-13 17:12:15.388  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : HTTP METHOD : GET
2019-07-13 17:12:15.389  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : CLASS_METHOD : com.fishpro.aoplog.controller.IndexController.log
2019-07-13 17:12:15.389  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : 參數 : [fishpro]
2019-07-13 17:12:17.219  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : 耗時 : 4934
2019-07-13 17:12:17.997  INFO 10055 --- [nio-8085-exec-1] com.fishpro.aoplog.aspect.WebLogAspect   : 返回值 : log

本項目源碼下載

---

關聯閱讀：

Spring Boot Log 日志使用教程

Spring Boot 全局異常處理

---

歡迎關注我的微信公眾號,我們一起編程聊天看世界