Spring Boot配置AOP打印日志的全過程
前言
在項目開發(fā)中,日志系統(tǒng)是必不可少的,用AOP在Web的請求做入?yún)⒑统鰠⒌膮?shù)打印,同時對異常進行日志打印,避免重復的手寫日志,完整案例見文末源碼。
一、Spring AOP
AOP(Aspect-Oriented Programming,面向切面編程),它利用一種"橫切"的技術,將那些多個類的共同行為封裝到一個可重用的模塊。便于減少系統(tǒng)的重復代碼,降低模塊之間的耦合度,并有利于未來的可操作性和可維護性。
AOP中有以下概念:
- Aspect(切面):聲明類似于Java中的類聲明,在Aspect中會包含一些Pointcut及相應的Advice。
- Joint point(連接點):表示在程序中明確定義的點。包括方法的調用、對類成員的訪問等。
- Pointcut(切入點):表示一個組Joint point,如方法名、參數(shù)類型、返回類型等等。
- Advice(通知):Advice定義了在Pointcut里面定義的程序點具體要做的操作,它通過(before、around、after(return、throw)、finally來區(qū)別實在每個Joint point之前、之后還是執(zhí)行 前后要調用的代碼。
- Before:在執(zhí)行方法前調用Advice,比如請求接口之前的登錄驗證。
- Around:在執(zhí)行方法前后調用Advice,這是最常用的方法。
- After:在執(zhí)行方法后調用Advice,after、return是方法正常返回后調用,after\throw是方法拋出異常后調用。
- Finally:方法調用后執(zhí)行Advice,無論是否拋出異常還是正常返回。
- AOP proxy:AOP proxy也是Java對象,是由AOP框架創(chuàng)建,用來完成上述動作,AOP對象通??梢酝ㄟ^JDK dynamic proxy完成,或者使用CGLIb完成。
- Weaving:實現(xiàn)上述切面編程的代碼織入,可以在編譯時刻,也可以在運行時刻,Spring和其它大多數(shù)Java框架都是在運行時刻生成代理。
二、項目示例
當然,在使用該案例之前,如果需要了解日志配置相關,可參考 SpringBoot 異步輸出 Logback 日志, 本文就不再概述了。
2.1 在pom引入依賴
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <!-- 分析客戶端信息的工具類--> <dependency> <groupId>eu.bitwalker</groupId> <artifactId>UserAgentUtils</artifactId> <version>1.20</version> </dependency> <!-- lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <scope>1.8.4</scope> </dependency> </dependencies>
2.2 Controller 切面:WebLogAspect
@Aspect
@Component
@Slf4j
public class WebLogAspect {
/**
* 進入方法時間戳
*/
private Long startTime;
/**
* 方法結束時間戳(計時)
*/
private Long endTime;
public WebLogAspect() {
}
/**
* 定義請求日志切入點,其切入點表達式有多種匹配方式,這里是指定路徑
*/
@Pointcut("execution(public * cn.van.log.aop.controller.*.*(..))")
public void webLogPointcut() {
}
/**
* 前置通知:
* 1. 在執(zhí)行目標方法之前執(zhí)行,比如請求接口之前的登錄驗證;
* 2. 在前置通知中設置請求日志信息,如開始時間,請求參數(shù),注解內容等
*
* @param joinPoint
* @throws Throwable
*/
@Before("webLogPointcut()")
public void doBefore(JoinPoint joinPoint) {
// 接收到請求,記錄請求內容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
//獲取請求頭中的User-Agent
UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
//打印請求的內容
startTime = System.currentTimeMillis();
log.info("請求開始時間:{}" + LocalDateTime.now());
log.info("請求Url : {}" + request.getRequestURL().toString());
log.info("請求方式 : {}" + request.getMethod());
log.info("請求ip : {}" + request.getRemoteAddr());
log.info("請求方法 : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
log.info("請求參數(shù) : {}" + Arrays.toString(joinPoint.getArgs()));
// 系統(tǒng)信息
log.info("瀏覽器:{}", userAgent.getBrowser().toString());
log.info("瀏覽器版本:{}", userAgent.getBrowserVersion());
log.info("操作系統(tǒng): {}", userAgent.getOperatingSystem().toString());
}
/**
* 返回通知:
* 1. 在目標方法正常結束之后執(zhí)行
* 1. 在返回通知中補充請求日志信息,如返回時間,方法耗時,返回值,并且保存日志信息
*
* @param ret
* @throws Throwable
*/
@AfterReturning(returning = "ret", pointcut = "webLogPointcut()")
public void doAfterReturning(Object ret) throws Throwable {
endTime = System.currentTimeMillis();
log.info("請求結束時間:{}" + LocalDateTime.now());
log.info("請求耗時:{}" + (endTime - startTime));
// 處理完請求,返回內容
log.info("請求返回 : {}" + ret);
}
/**
* 異常通知:
* 1. 在目標方法非正常結束,發(fā)生異?;蛘邟伋霎惓r執(zhí)行
* 1. 在異常通知中設置異常信息,并將其保存
*
* @param throwable
*/
@AfterThrowing(value = "webLogPointcut()", throwing = "throwable")
public void doAfterThrowing(Throwable throwable) {
// 保存異常日志記錄
log.error("發(fā)生異常時間:{}" + LocalDateTime.now());
log.error("拋出異常:{}" + throwable.getMessage());
}
}
2.3 編寫測試
@RestController
@RequestMapping("/log")
public class LogbackController {
/**
* 測試正常請求
* @param msg
* @return
*/
@GetMapping("/{msg}")
public String getMsg(@PathVariable String msg) {
return "request msg : " + msg;
}
/**
* 測試拋異常
* @return
*/
@GetMapping("/test")
public String getException(){
// 故意造出一個異常
Integer.parseInt("abc123");
return "success";
}
}
2.4 @Before和@AfterReturning部分也可使用以下代碼替代
/**
* 在執(zhí)行方法前后調用Advice,這是最常用的方法,相當于@Before和@AfterReturning全部做的事兒
* @param pjp
* @return
* @throws Throwable
*/
@Around("webLogPointcut()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
// 接收到請求,記錄請求內容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
//獲取請求頭中的User-Agent
UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
//打印請求的內容
startTime = System.currentTimeMillis();
log.info("請求Url : {}" , request.getRequestURL().toString());
log.info("請求方式 : {}" , request.getMethod());
log.info("請求ip : {}" , request.getRemoteAddr());
log.info("請求方法 : " , pjp.getSignature().getDeclaringTypeName() , "." , pjp.getSignature().getName());
log.info("請求參數(shù) : {}" , Arrays.toString(pjp.getArgs()));
// 系統(tǒng)信息
log.info("瀏覽器:{}", userAgent.getBrowser().toString());
log.info("瀏覽器版本:{}",userAgent.getBrowserVersion());
log.info("操作系統(tǒng): {}", userAgent.getOperatingSystem().toString());
// pjp.proceed():當我們執(zhí)行完切面代碼之后,還有繼續(xù)處理業(yè)務相關的代碼。proceed()方法會繼續(xù)執(zhí)行業(yè)務代碼,并且其返回值,就是業(yè)務處理完成之后的返回值。
Object ret = pjp.proceed();
log.info("請求結束時間:"+ LocalDateTime.now());
log.info("請求耗時:{}" , (System.currentTimeMillis() - startTime));
// 處理完請求,返回內容
log.info("請求返回 : " , ret);
return ret;
}
三、 測試
3.1 請求入口LogbackController.java
@RestController
@RequestMapping("/log")
public class LogbackController {
/**
* 測試正常請求
* @param msg
* @return
*/
@GetMapping("/normal/{msg}")
public String getMsg(@PathVariable String msg) {
return msg;
}
/**
* 測試拋異常
* @return
*/
@GetMapping("/exception/{msg}")
public String getException(@PathVariable String msg){
// 故意造出一個異常
Integer.parseInt("abc123");
return msg;
}
}
3.2 測試正常請求
打開瀏覽器,訪問http://localhost:8082/log/normal/hello
日志打印如下:
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [65] [INFO ] 請求開始時間:2019-02-24T22:37:50.892
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [66] [INFO ] 請求Url : http://localhost:8082/log/normal/hello
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [67] [INFO ] 請求方式 : GET
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [68] [INFO ] 請求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [69] [INFO ] 請求方法 :
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [70] [INFO ] 請求參數(shù) : [hello]
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [72] [INFO ] 瀏覽器:CHROME
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [73] [INFO ] 瀏覽器版本:76.0.3809.100
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [74] [INFO ] 操作系統(tǒng): MAC_OS_X
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [88] [INFO ] 請求結束時間:2019-02-24T22:37:50.901
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [89] [INFO ] 請求耗時:14
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [91] [INFO ] 請求返回 : hello
3.3 測試異常情況
訪問:http://localhost:8082/log/exception/hello
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [65] [INFO ] 請求開始時間:2019-02-24T22:39:57.728
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [66] [INFO ] 請求Url : http://localhost:8082/log/exception/hello
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [67] [INFO ] 請求方式 : GET
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [68] [INFO ] 請求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [69] [INFO ] 請求方法 :
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [70] [INFO ] 請求參數(shù) : [hello]
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [72] [INFO ] 瀏覽器:CHROME
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [73] [INFO ] 瀏覽器版本:76.0.3809.100
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [74] [INFO ] 操作系統(tǒng): MAC_OS_X
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [104] [ERROR] 發(fā)生異常時間:2019-02-24T22:39:57.731
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [105] [ERROR] 拋出異常:For input string: "abc123"
[2019-02-24 22:39:57.057] [org.apache.juli.logging.DirectJDKLog] [http-nio-8082-exec-9] [175] [ERROR] Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.NumberFormatException: For input string: "abc123"] with root cause
java.lang.NumberFormatException: For input string: "abc123"
四、源碼
4.1 示例代碼
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,謝謝大家對腳本之家的支持。
相關文章
據(jù)說這個是可以擼到2089年的idea2020.2(推薦)
這篇文章主要介紹了據(jù)說這個是可以擼到2089年的idea2020.2,本教程給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-09-09
springboot對接minio的webhook完整步驟記錄
Minio是一款開源的對象存儲服務,它致力于為開發(fā)者提供簡單、高性能、高可用的云存儲解決方案,下面這篇文章主要給大家介紹了關于springboot對接minio的webhook的相關資料,需要的朋友可以參考下2024-07-07
SpringMvc/SpringBoot HTTP通信加解密的實現(xiàn)
這篇文章主要介紹了SpringMvc/SpringBoot HTTP通信加解密的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-08-08

