Spring boot AOP 記錄請求日誌
阿新 • • 發佈:2018-11-29
如何將所有的通過url的請求引數以及返回結果都輸出到日誌中?
如果在controller的類中每個方法名都寫一個log輸出肯定是不明智的選擇。
使用spring的AOP功能即可完成。
1. 在pom.xml中新增aspect依賴包。
<!-- aop -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2. 新增全域性的WebLogAspect類。
package com.king.app; import java.util.Enumeration; import javax.servlet.http.HttpServletRequest; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.AfterReturning; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.annotation.Pointcut; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; @Aspect @Component public class WebLogAspect { private Logger logger = LoggerFactory.getLogger(getClass()); @Pointcut("execution(public * com.king.controller..*.*(..))") public void webLog(){ } @Before("webLog()") public void doBefore(JoinPoint joinPoint){ ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 記錄下請求內容//url
logger.info("url ={}",request.getRequestURI());
//method
logger.info("method={}",request.getMethod());
//ip
logger.info("ip={}",request.getRemoteAddr());
//類方法
logger.info("class_method={}",joinPoint.getSignature().getDeclaringTypeName()+'.'+ joinPoint.getSignature().getName());//獲取類名及類方法
//引數
logger.info("args={}",joinPoint.getArgs());
Enumeration<String> enu = request.getParameterNames(); while (enu.hasMoreElements()) { String name = (String) enu.nextElement(); logger.info("name:{},value:{}", name, request.getParameter(name)); } } @AfterReturning(returning = "ret", pointcut = "webLog()") public void doAfterReturning(Object ret) throws Throwable { // 處理完請求,返回內容 logger.info("RESPONSE : " + ret); } }
@Pointcut("execution(public * com.king.controller..*.*(..))")
上面這段註解的意思如下:
1) execution(): 表示式主體
2) 第一個public *號:表示返回型別, *號表示所有的型別。
3) 包名:表示需要攔截的包名,後面的兩個句點表示當前包和當前包的所有子包,com.king.controller包、子孫包下所有類的方法。
4) 第二個*號:表示類名,*號表示所有的類。
5) *(..):最後這個星號表示方法名,*號表示所有的方法,後面括弧裡面表示方法的引數,兩個句點表示任何引數
3. 最後在App.class中新增com.king.app的元件掃描
最後測試新增使用者,則可在日誌中看到如下資訊: