【SpringBoot】springboot 整合log4j日志 及 使用AOP统一处理Web请求日志

本文源码：https://github.com/SsRong/springboot2.0-ssrtest02

一、springboot整合log4j日志（此方法为传统方式，之后使用lombok可以大幅简化）

步骤：

  1、在resources文件夹下新建log4j.properties文件，在其中添加配置信息

           配置信息：

#log4j.rootLogger=CONSOLE,info,error,DEBUG
log4j.rootLogger= info,error,CONSOLE,DEBUG
log4j.appender.CONSOLE= org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout= org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern= %d{ yyyy -MM- dd -HH- mm }[%t][%c][%p]-%m%n
log4j.logger.info= info
log4j.appender.info= org.apache.log4j.DailyRollingFileAppender
log4j.appender.info.layout= org.apache.log4j.PatternLayout
log4j.appender.info.layout.ConversionPattern= %d{ yyyy -MM- dd -HH- mm }[%t][%c][%p]-%m%n
log4j.appender.info.datePattern= '.' yyyy -MM- dd
log4j.appender.info.Threshold =  info
log4j.appender.info.append= true
#log4j.appender.info.File=/home/ admin / pms - api -services/logs/info/api_services_info
log4j.appender.info.File= /Users/ dddd /Documents/ testspace / pms - api -services/logs/info/api_services_info
log4j.logger.error= error
log4j.appender.error= org.apache.log4j.DailyRollingFileAppender
log4j.appender.error.layout= org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern= %d{ yyyy -MM- dd -HH- mm }[%t][%c][%p]-%m%n
log4j.appender.error.datePattern= '.' yyyy -MM- dd
log4j.appender.error.Threshold =  error
log4j.appender.error.append= true
#log4j.appender.error.File=/home/ admin / pms - api -services/logs/error/api_services_error
log4j.appender.error.File= /Users/ dddd /Documents/ testspace / pms - api -services/logs/error/api_services_error
log4j.logger.DEBUG= DEBUG
log4j.appender.DEBUG= org.apache.log4j.DailyRollingFileAppender
log4j.appender.DEBUG.layout= org.apache.log4j.PatternLayout
log4j.appender.DEBUG.layout.ConversionPattern= %d{ yyyy -MM- dd -HH- mm }[%t][%c][%p]-%m%n
log4j.appender.DEBUG.datePattern = '.' yyyy -MM- dd
log4j.appender.DEBUG.Threshold =  DEBUG
log4j.appender.DEBUG.append= true
#log4j.appender.DEBUG.File=/home/ admin / pms - api -services/logs/debug/api_services_debug
log4j.appender.DEBUG.File= /Users/ dddd /Documents/ testspace / pms - api -services/logs/debug/api_services_debug

  2、在pom.xml中添加log4j的依赖。

        <!--log4j 的依赖jar包-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j</artifactId>
            <version>1.3.8.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>

        <!--引入aop的jar包-->
        <dependency>
            <groupId> org.springframework.boot </groupId>
            <artifactId> spring-boot-starter-aop </artifactId>
        </dependency>

  3、在需要做日志记录的类中定义一个全局的Logger变量

private static final Loggerlogger=(Logger)LoggerFactory.getLogger(JspController.class);

logger.info("springboot整合log4j成功！！荣杉山真帅");

二、使用AOP统一处理Web请求日志

1、通过上面的传统方法整合log4j日志所存在的局限性，以及在大工程下的不可行性。我们在这学习如何使用AOP技术来对日志文件进行整合。

2、准备步骤：实验前我们同样新建一个与controller包同等级的aop项目包，并向其中导入WebLogAspect.java文件，再添加完依赖后，由类中的@Pointcut("execution(public*com.ssrtest02.controller..*.*(..))")，方法注解可知，在controller包下的所有方法在使用的时候都会触发日志事件，进行记录。

3、代码源码如下：

package com.ssrtest02.aop;

import lombok.extern.slf4j.Slf4j;
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;

import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;

@Aspect
@Component
@Slf4j
public class WebLogAspect {
   // private log log = logFactory.getlog(getClass());
    //这个方法会拦截com.ssrtest02.controller项目包所有类的所有方法
    @Pointcut("execution(public * com.ssrtest02.controller..*.*(..))")
    public void webLog() {
    }

    /**
     *使用AOP的前置通知拦截请求参数信息
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        //  接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //  记录下请求内容
        log.info("URL : " + request.getRequestURL().toString());
        log.info("HTTP_METHOD : " + request.getMethod());
        log.info("IP : " + request.getRemoteAddr());
        Enumeration<String> enu = request.getParameterNames();
        while (enu.hasMoreElements()) {
            String name = (String) enu.nextElement();
            log.info("name:{},value:{}", name, request.getParameter(name));
        }
    }

    /**
     *使用AOP的后置通知
     */
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        //  处理完请求，返回内容
        log.info("RESPONSE : " + ret);
    }
}