Spring Boot 自定義注解，AOP 切面統一打印出入參請求日志

 

 

 

其實，小哈在之前就出過一篇關於如何使用 AOP 切面統一打印請求日志的文章，那為什么還要再出一篇呢？沒東西寫了？

哈哈，當然不是！原因是當時的實現方案還是存在缺陷的，原因如下：

1. 不夠靈活，由於是以所有 Controller 方法中的方法為切面，也就是說切死了，如果說我們不想讓某個接口打印出入參日志，就辦不到了；
2. Controller 包層級過深時，導致很多包下的接口切不到；

今天主要說說如何通過自定義注解的方式，在 Spring Boot 中來實現 AOP 切面統一打印出入參日志。小伙伴們可以收藏一波。

廢話不多說，進入正題 ！

一、先看看切面日志輸出效果

在看看實現方法之前，我們先看下切面日志輸出效果咋樣：

 

 

從上圖中可以看到，每個對於每個請求，開始與結束一目了然，並且打印了以下參數：

• URL: 請求接口地址；
• Description: 接口的中文說明信息；
• HTTP Method: 請求的方法，是 POST, GET, 還是 DELETE 等；
• Class Method: 被請求的方法路徑 : 包名 + 方法名;
• IP: 請求方的 IP 地址；
• Request Args: 請求入參，以 JSON 格式輸出；
• Response Args: 響應出參，以 JSON 格式輸出；
• Time-Consuming: 請求耗時，以此估算每個接口的性能指數；

怎么樣？看上去效果還不錯呢？接下來看看，我們要如何一步一步實現它呢？

二、添加 AOP Maven 依賴

在項目 pom.xml 文件中添加依賴：

<!-- aop 依賴 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <!-- 用於日志切面中，以 json 格式打印出入參 --> <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.5</version> </dependency> 

三、自定義日志注解

讓我們來自定義一個日志注解，如下所示：

 

 

• ①：什么時候使用該注解，我們定義為運行時；
• ②：注解用於什么地方，我們定義為作用於方法上；
• ③：注解是否將包含在 JavaDoc 中；
• ④：注解名為 WebLog;
• ⑤：定義一個屬性，默認為空字符串；

源代碼如下：

package site.exception.springbootaopwebrequest.aspect; import java.lang.annotation.*; /** * @author 犬小哈 （微信號：小哈學Java） * @site www.exception.site * @date 2019/2/12 * @time 下午9:19 * @discription **/ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) @Documented public @interface WebLog { /** * 日志描述信息 * * @return */ String description() default ""; } 

到這里，一個完整的自定義注解就定義完成了。

四、配置 AOP 切面

在配置 AOP 切面之前，我們需要了解下 aspectj 相關注解的作用：

• @Aspect：聲明該類為一個注解類；
• @Pointcut：定義一個切點，后面跟隨一個表達式，表達式可以定義為切某個注解，也可以切某個 package 下的方法；

切點定義好后，就是圍繞這個切點做文章了：

• @Before: 在切點之前，織入相關代碼；
• @After: 在切點之后，織入相關代碼;
• @AfterReturning: 在切點返回內容后，織入相關代碼，一般用於對返回值做些加工處理的場景；
• @AfterThrowing: 用來處理當織入的代碼拋出異常后的邏輯處理;
• @Around: 環繞，可以在切入點前后織入代碼，並且可以自由的控制何時執行切點；

 

 

接下來，定義一個 WebLogAspect.java 切面類，聲明一個切點：

 

 

然后，定義 @Around 環繞，用於何時執行切點：

 

 

• ①：記錄一下調用接口的開始時間；
• ②：執行切點，執行切點后，會去依次調用 @Before -> 接口邏輯代碼 -> @After -> @AfterReturning；
• ③：打印出參；
• ④：打印接口處理耗時；
• ⑤：返回接口返參結果；

再來看看 @Before 方法：

 

 

看注釋功能說明，因為注釋說得還是比較清楚的！

最后，用 @After 來做個收尾：

 

 

 

 

我們在每個接口的最后，打印日志結束標志。最后再看下項目包結構：

 

 

到這里，切面相關的代碼就完成了！

上完整代碼：

package site.exception.springbootaopwebrequest.aspect; import com.google.gson.Gson; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.*; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Profile; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; import javax.servlet.http.HttpServletRequest; import java.lang.reflect.Method; /** * @author 犬小哈 （微信號：小哈學Java） * @site www.exception.site * @date 2019/2/12 * @time 下午9:19 * @discription **/ @Aspect @Component @Profile({"dev", "test"}) public class WebLogAspect { private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class); /** 換行符 */ private static final String LINE_SEPARATOR = System.lineSeparator(); /** 以自定義 @WebLog 注解為切點 */ @Pointcut("@annotation(site.exception.springbootaopwebrequest.aspect.WebLog)") public void webLog() {} /** * 在切點之前織入 * @param joinPoint * @throws Throwable */ @Before("webLog()") public void doBefore(JoinPoint joinPoint) throws Throwable { // 開始打印請求日志 ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 獲取 @WebLog 注解的描述信息 String methodDescription = getAspectLogDescription(joinPoint); // 打印請求相關參數 logger.info("========================================== Start =========================================="); // 打印請求 url logger.info("URL : {}", request.getRequestURL().toString()); // 打印描述信息 logger.info("Description : {}", methodDescription); // 打印 Http method logger.info("HTTP Method : {}", request.getMethod()); // 打印調用 controller 的全路徑以及執行方法 logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName()); // 打印請求的 IP logger.info("IP : {}", request.getRemoteAddr()); // 打印請求入參 logger.info("Request Args : {}", new Gson().toJson(joinPoint.getArgs())); } /** * 在切點之后織入 * @throws Throwable */ @After("webLog()") public void doAfter() throws Throwable { // 接口結束后換行，方便分割查看 logger.info("=========================================== End ===========================================" + LINE_SEPARATOR); } /** * 環繞 * @param proceedingJoinPoint * @return * @throws Throwable */ @Around("webLog()") public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { long startTime = System.currentTimeMillis(); Object result = proceedingJoinPoint.proceed(); // 打印出參 logger.info("Response Args : {}", new Gson().toJson(result)); // 執行耗時 logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime); return result; } /** * 獲取切面注解的描述 * * @param joinPoint 切點 * @return 描述信息 * @throws Exception */ public String getAspectLogDescription(JoinPoint joinPoint) throws Exception { String targetName = joinPoint.getTarget().getClass().getName(); String methodName = joinPoint.getSignature().getName(); Object[] arguments = joinPoint.getArgs(); Class targetClass = Class.forName(targetName); Method[] methods = targetClass.getMethods(); StringBuilder description = new StringBuilder(""); for (Method method : methods) { if (method.getName().equals(methodName)) { Class[] clazzs = method.getParameterTypes(); if (clazzs.length == arguments.length) { description.append(method.getAnnotation(WebLog.class).description()); break; } } } return description.toString(); } } 

五、怎么使用呢？

因為我們的切點是自定義注解 @WebLog, 所以我們僅僅需要在 Controller 控制器的每個接口方法添加 @WebLog 注解即可，如果我們不想某個接口打印出入參日志，不加注解就可以了：

 

 

六、對於文件上傳好使不？

是好使的！不論是單文件上傳，抑或是多文件上傳，切面日志均運行良好，這里測試的東西，小哈就不貼出來了。有興趣的小伙伴可以試試！

七、只想在開發環境和測試環境中使用？

對於那些性能要求較高的應用，不想在生產環境中打印日志，只想在開發環境或者測試環境中使用，要怎么做呢？我們只需為切面添加 @Profile 就可以了，如下圖所示：

 

 

這樣就指定了只能作用於 dev 開發環境和 test 測試環境，生產環境 prod 是不生效的！

八、多切面如何指定優先級？

假設說我們的服務中不止定義了一個切面，比如說我們針對 Web 層的接口，不止要打印日志，還要校驗 token 等。要如何指定切面的優先級呢？也就是如何指定切面的執行順序？

我們可以通過 @Order(i)注解來指定優先級，注意：i 值越小，優先級則越高。

假設說我們定義上面這個日志切面的優先級為 @Order(10), 然后我們還有個校驗 token 的切面 CheckTokenAspect.java，我們定義為了 @Order(11), 那么它們之間的執行順序如下：

 

 

我們可以總結一下：

• 在切點之前，@Order 從小到大被執行，也就是說越小的優先級越高；
• 在切點之后，@Order 從大到小被執行，也就是說越大的優先級越高；

九、Ref

http://blog.didispace.com/springbootaoplog

十、GitHub 源碼地址

https://github.com/weiwosuoai/spring-boot-tutorial/tree/master/spring-boot-aop-web-request

 

轉載：https://www.exception.site/springboot/spring-boot-aop-web-request