SpringBoot 集成Log4j与AOP

偏执的太偏执、 2022-01-12 16:39 322阅读 0赞

### 一、SpringBoot 集成Log4j ###

SpringBoot 日志系统默认使用 logback。集成log4j方法很简单：

**1、修改pom.xml文件，过滤掉自带的 spring-boot-starter-logging，然后添加spring-boot-starter-log4j依赖包**：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <exclusions>
                    
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-logging</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-log4j</artifactId>
                <version>1.3.8.RELEASE</version>
            </dependency>

**2、在 resources 目录下新建 log4j.properties 配置文件**

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=d://log4j/logs/api_services_info.log
    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=d://log4j/logs/error/api_services_error.log
    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=d://log4j/logs/debug/api_services_debug.log

**3、打印日志的测试java类：**

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    public class IndexController {
        private static final Logger logger = LoggerFactory.getLogger(IndexController.class);
    
        @ResponseBody
        @GetMapping(value = "/index")
        public String index(){
            logger.info("IndexController 日志信息");
            return "IndexController";
        }
    }

![20190617214521121.png][]

### 二、Aop 统一处理Web请求日志 ###

传送门：[spring切面编程AOP][spring_AOP]  切入点表达式参考：[AspectJ切入点语法详解][AspectJ]

*  @Aspect     声明该类为 切面类
 *  @Order(2)   当同一个目标方法有多个切面的时，哪个切面类先执行，取决于order的值，值越小越优先执行)
 *  @Before 前置通知（在目标方法执行之前执行）
 *  @After 后置通知（在目标方法执行之后执行）无论有没有异常抛出都会执行
 *  @AfterReturning 返回通知（在目标方法返回结果之后执行）
 *  @AfterThrowing 异常通知（在目标方法跑出异常之后执行）
 *  @Around 环绕通知（围绕着方法执行）

JoinPoint 类：提供了访问当前被增强方法的真实对象、代理对象、方法参数等数据。

ProceedingJoinPoint 类：是JoinPoint 的子类，只能用于环绕通知中，参数必须是ProceedingJoinPoint。必须有返回值（目标方法的返回值）。

**1、引入AOP依赖**

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

**2、编写切面类 WebLogAspect**

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.core.annotation.Order;
    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.Arrays;
    
    @Aspect
    @Order(5)
    @Component
    public class WebLogAspect {
        private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    
        ThreadLocal<Long> startTime = new ThreadLocal<>();
    
        @Pointcut("execution(public * cn.jq..*.*controller.*.*(..))")
        public void webLog(){}
    
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint) throws Throwable {
            startTime.set(System.currentTimeMillis());
    
            // 接收到请求，记录请求内容
            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());
            logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
            logger.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
    
        }
    
        @AfterReturning(returning = "ret", pointcut = "webLog()")
        public void doAfterReturning(Object ret) throws Throwable {
            // 处理完请求，返回内容
            logger.info("RESPONSE : " + ret);
            logger.info("SPEND TIME : " + (System.currentTimeMillis() - startTime.get()));
        }
    
    }

**3、打印日志的测试java类：**

@Controller
    public class IndexController {
        //private static final Logger logger = LoggerFactory.getLogger(IndexController.class);
    
        @ResponseBody
        @GetMapping(value = "/index")
        public String index(String name, String password){
            //logger.info("IndexController 日志信息");
            return "IndexController>>>" + name + ">>>"+ password;
        }
    
    }

![20190618095016165.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70][]

**3、切入点表达式也可以使用注解**

// 自定义注解
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface SystemLog {
        String description() default "";
    }

@Aspect
    @Order(99)
    @Component
    public class WebLogAspect {
        private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    
        ThreadLocal<Long> startTime = new ThreadLocal<>();
    
        @Pointcut("@annotation(cn.jq.SystemLog)")
        public void webLog(){}
    
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint){
            logger.info("Before : " + joinPoint.getSignature().getName());
        }
    
        @After(value = "webLog()")
        public void doAfter(JoinPoint joinPoint){
            logger.info("After : " + joinPoint.getSignature().getName());
        }
    
        @AfterReturning(returning = "ret", value = "webLog()")
        public void doAfterReturning(JoinPoint joinPoint, Object ret) throws Throwable {
            // 处理完请求，返回内容
            logger.info("AfterReturning : " + joinPoint.getSignature().getName());
        }
    
        @AfterThrowing(value = "webLog()", throwing = "ex")
        public void afterThrowing(JoinPoint joinPoint, Exception ex){
            String name = joinPoint.getSignature().getName();
            logger.info("afterThrowing : " + name + "========" + ex.getMessage());
        }
    
    //    @Around(value = "webLog()")
    //    public Object around(ProceedingJoinPoint proceedingJoinPoint){
    //        Object re = null;
    //        try {
    //            re = proceedingJoinPoint.proceed();
    //        } catch (Throwable throwable) {
    //            throwable.printStackTrace();
    //        }
    //        logger.info("re : " + re );
    //        return re;
    //    }
    
    }

参考文章 [https://blog.csdn.net/linxingliang/article/details/52324965][https_blog.csdn.net_linxingliang_article_details_52324965]

ends~

[20190617214521121.png]: /images/20220112/5e9304e8a68d4173bb0f28efb5780adf.png
[spring_AOP]: https://blog.csdn.net/qq_42402854/article/details/82049893
[AspectJ]: https://blog.csdn.net/garfielder007/article/details/85311321
[20190618095016165.png]: /images/20220112/35b77f4aa05344f39dcde9fbc1bdfc1b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70]: /images/20220112/702a7bcf0b9145c98c5fc923fc63d41c.png
[https_blog.csdn.net_linxingliang_article_details_52324965]: https://blog.csdn.net/linxingliang/article/details/52324965