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

時間 2020-06-08

標籤 spring boot 自定義註解 aop 切面統一打印出入請求日誌欄目 Spring 简体版

原文原文鏈接

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

哈哈，固然不是！緣由是當時的實現方案仍是存在缺陷的，緣由以下：git

不夠靈活，因爲是以全部 Controller 方法中的方法爲切面，也就是說切死了，若是說咱們不想讓某個接口打印出入參日誌，就辦不到了；
Controller 包層級過深時，致使不少包下的接口切不到；

今天主要說說如何經過自定義註解的方式，在 Spring Boot 中來實現 AOP 切面統一打印出入參日誌。小夥伴們能夠收藏一波。github

廢話很少說，進入正題！web

1、先看看切面日誌輸出效果

在看看實現方法以前，咱們先看下切面日誌輸出效果咋樣：spring

從上圖中能夠看到，每一個對於每一個請求，開始與結束一目瞭然，而且打印瞭如下參數：json

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

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

2、添加 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>

3、自定義日誌註解

讓咱們來自定義一個日誌註解，以下所示：app

①：何時使用該註解，咱們定義爲運行時；
②：註解用於什麼地方，咱們定義爲做用於方法上；
③：註解是否將包含在 JavaDoc 中；
④：註解名爲 WebLog;
⑤：定義一個屬性，默認爲空字符串；

源代碼以下：spring-boot

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

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

4、配置 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(); } }