通過AOP統(tǒng)一處理web請求日志,只需要添加兩個依賴即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
一般不需要其他任何配置,即可使用。
1.先定義一個注解,用來描述每個方法的用途等。
@Target(ElementType.METHOD) //表示該注解標(biāo)注在方法上
@Retention(RetentionPolicy.RUNTIME) //表示該注解保留到runtime階段,將被JVM保留,所以它能在運行時被JVM或其他使用反射機制的代碼所讀取和使用.
@Documented //表示該注解會被 javadoc 之類的工具處理, 所以注解類型信息也會被包括在生成的文檔中
public @interface LoggerManage {
public String description();
}
2.先寫一個簡單的請求
@RestController
public class IndexController {
@RequestMapping(value = "/index", method = RequestMethod.GET)
@LoggerManage(description = "獲取用戶名")
public String getUserName(String userID, Integer age) {
return "ArcherLj";
}
}
3.實現(xiàn)web層日志切面
使用@Aspect
注解將一個java類定義為切面類
使用@Pointcut
定義一個切入點,可以是一個規(guī)則表達(dá)式,比如下例中某個package下的所有函數(shù),也可以是一個注解等。
使用@Before
在切入點開始處切入內(nèi)容
使用@After
在切入點結(jié)尾處切入內(nèi)容
使用@AfterReturning
在切入點return內(nèi)容之后切入內(nèi)容(可以用來對處理返回值做一些加工處理)
使用@Around
在切入點前后切入內(nèi)容,并自己控制何時執(zhí)行切入點自身的內(nèi)容
使用@AfterThrowing
用來處理當(dāng)切入內(nèi)容部分拋出異常之后的處理邏輯
使用ThreadLocal對象來記錄請求處理的時間(直接在使用基本類型會有同步問題,所以我們可以引入ThreadLocal對象)
package com.example.demo;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
/**
* Created by archerlj on 2017/6/23.
*/
@Aspect
@Component
public class LoggerAdvice {
private Logger logger = Logger.getLogger(this.getClass());
ThreadLocal<Long> startTime = new ThreadLocal<>();
@Before("within(com.example.demo.*) && @annotation(loggerManage)")
public void addBeforeLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
logger.info("執(zhí)行--" + loggerManage.description() + "--開始");
startTime.set(System.currentTimeMillis());
logger.info(joinPoint.getSignature().toString());
logger.info(parseParames(joinPoint.getArgs()));
}
@AfterReturning("within(com.example.demo.*) && @annotation(loggerManage)")
public void addAfterReturningLogger(JoinPoint joinPoint, LoggerManage loggerManage) {
logger.info("執(zhí)行--" + loggerManage.description() + "--結(jié)束");
logger.info("執(zhí)行時間--" + (System.currentTimeMillis() - startTime.get()));
}
@AfterThrowing(pointcut = "within(com.example.demo.*) && @annotation(loggerManage)", throwing = "ex")
public void addAfterThrowingLogger(JoinPoint joinPoint, LoggerManage loggerManage, Exception ex) {
logger.error("執(zhí)行--" + loggerManage.description() + "--異常", ex);
}
private String parseParames(Object[] parames) {
if (null == parames || parames.length <= 0) {
return "";
}
StringBuffer param = new StringBuffer("參數(shù)--");
for (Object obj : parames) {
String va = ToStringBuilder.reflectionToString(obj);
param.append(va).append(" ");
}
return param.toString();
}
}
Spring AOP支持在切入點表達(dá)式中使用如下的切入點指示符:
execution
- 匹配方法執(zhí)行的連接點,這是你將會用到的Spring的最主要的切入點指示符。
within
- 限定匹配特定類型的連接點(在使用Spring AOP的時候,在匹配的類型中定義的方法的執(zhí)行)。
this
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中bean reference(Spring AOP 代理)是指定類型的實例。
target
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中目標(biāo)對象(被代理的應(yīng)用對象)是指定類型的實例。
args
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中參數(shù)是指定類型的實例。
@target
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中正執(zhí)行對象的類持有指定類型的注解。
@args
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中實際傳入?yún)?shù)的運行時類型持有指定類型的注解。
@within
- 限定匹配特定的連接點,其中連接點所在類型已指定注解(在使用Spring AOP的時候,所執(zhí)行的方法所在類型已指定注解)。
@annotation
- 限定匹配特定的連接點(使用Spring AOP的時候方法的執(zhí)行),其中連接點的主題持有指定的注解。
4.設(shè)置log文件位置
application.properties:
logging.file=./demo.log
logging.level.com.example.demo=INFO
logging.level.org.springframework.web=INFO
logging.level.org.hibernate=ERROR
訪問http://localhost:8080/index?userID=sadfieg3&age=129
結(jié)果如下
: 執(zhí)行--獲取用戶名--開始
: String com.example.demo.IndexController.getUserName(String,Integer)
: 參數(shù)--java.lang.String@250928e9[value={s,a,d,f,i,e,g,3},hash=1708579352] java.lang.Integer@ded028e[value=129]
: 執(zhí)行--獲取用戶名--結(jié)束
: 執(zhí)行時間--20
最后幫朋友打個小廣告