SpringBoot配置集成log4j统一处理请求日志（AOP）

springboot中集成log4j需要3步就可以配置完成

1. 添加log4j依赖

<!-- pom.xml添加log4j依赖,最新版本可以去maven网站下载 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-log4j</artifactId>
  <version>1.3.8.RELEASE</version>
</dependency>

2. log4j配置

log4j日志的配置可以用log4j.xml,log4j.properties这2种形式配置。log4j的配置文件一般放在resources文件夹下。
 

log4j.rootLogger=INFO,Console,File
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.Target=System.out
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c - %L]%m%n
log4j.appender.File=org.apache.log4j.RollingFileAppender
log4j.appender.File.File=D:/logs/info/info.log
log4j.appender.File.MaxFileSize=10MB
log4j.appender.File.Threshold=ALL
log4j.appender.File.layout=org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern=[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c - %L]%m%n

3. 配置完成，Controller中使用log4j

@RestController
@RequestMapping("log4j")
public class Log4jController {
    Logger logger=Logger.getLogger(Log4jController.class);

    @RequestMapping("logtest")
    @ResponseBody
    public String logtest(){

        logger.fatal("致命错误");
        logger.error("严重警告");
        logger.warn("警告");
        logger.info("普通信息");
        logger.debug("调试信息");

        return "testLog4j";
    }
}

4.验证

在浏览器输入：http://127.0.0.1:8080/log4j/logtest

 打印log下图所示：

SpringBoot+log4j统一处理请求日志（AOP）

项目当中经常需要对请求日志进行统一处理，以便能够及时的掌握项目功能情况，下面简单介绍springboot利用log4j如何用AOP对所有请求统一记录。

1. springboot集成log4j

具体详见springboot配置集成log4j（上面的步骤）

2. 导入AOP依赖

<!-- AOP -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

3. WebLogAspect切面类

package com.myspringboot.controller;

import java.util.Enumeration;
import javax.servlet.http.HttpServletRequest;
import org.apache.log4j.Logger;
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.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

@Aspect
@Component  //配置Bean
public class WebLogAspect {
    private Logger logger = Logger.getLogger(getClass());
    
    private long startTime=0;

    @Pointcut("execution(public * com.myspringboot.controller..*.*(..))")
    //com.myspringboot.controller  为Controller所在的包名
    public void webLog() {

    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        startTime = System.currentTimeMillis();
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        logger.info("---------------request----------------");
        logger.info("URL : " + request.getRequestURL().toString());
        logger.info("HTTP_METHOD : " + request.getMethod());
        logger.info("IP : " + request.getRemoteAddr());
        Enumeration enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = (String) enu.nextElement();
            logger.info("name:" + name + " - value:" + request.getParameter(name));
        }
    }

    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        logger.info("---------------response----------------");
        // 处理完请求，返回内容
        logger.info("RESPONSE : " + ret);
        logger.info("花费时间 : " + (System.currentTimeMillis() - startTime) + "毫秒");
    }
    
    // 通过@Pointcut定义切入点，此处是com.test.controller包下的所有Controller（对controller层所有请求处理做切入点），
    // 然后通过@Before实现对请求内容的日志记录，最后通过@AfterReturning记录请求返回的对象。
    // 这样所有功能的请求参数，返回数据，以及运行时间等都可以统一记录，不需要在每个方法去单独处理。
}
 

 4.验证

在浏览器输入：http://127.0.0.1:8080/log4j/logtest

相关参考文档

springboot+log4j统一处理请求日志（AOP）