歡迎關注個人微信公眾號: 小哈學Java, 文末分享《Java 核心知識整理&面試.pdf》資源連結!!
其實,小哈在之前就出過一篇關於如何使用 AOP 切面統一列印請求日誌的文章,那為什麼還要再出一篇呢?沒東西寫了?
哈哈,當然不是!原因是當時的實現方案還是存在缺陷的,原因如下:
- 不夠靈活,由於是以所有 Controller 方法中的方法為切面,也就是說切死了,如果說我們不想讓某個介面列印出入參日誌,就辦不到了;
- Controller 包層級過深時,導致很多包下的介面切不到;
今天主要說說如何通過自定義註解的方式,在 Spring Boot 中來實現 AOP 切面統一列印出入參日誌。小夥伴們可以收藏一波。
廢話不多說,進入正題 !
目錄
一、先看看切面日誌輸出效果
二、新增 AOP Maven 依賴
三、自定義日誌註解
四、配置 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
blog.didispace.com/springboota…
十、GitHub 原始碼地址
贈送 | 面試&學習福利資源
最近在網上發現一個不錯的 PDF 資源《Java 核心知識&面試.pdf》分享給大家,不光是面試,學習,你都值得擁有!!!
獲取方式: 關注公眾號: 小哈學Java, 後臺回覆 資源,既可免費無套路獲取資源連結,下面是目錄以及部分截圖:
重要的事情說兩遍,關注公眾號: 小哈學Java, 後臺回覆 資源,既可免費無套路獲取資源連結 !!!