springboot集成AOP管理日志

如何將所有的通過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();
        // 記錄下請求內容
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        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的組件掃描

最后測試添加用戶，則可在日志中看到如下信息：