Spring Boot中使用AOP统一处理Web请求日志

Posted 2022-01-12 hpx2020

1，引入jar

   <!-- springboot-aop 技术，统一处理日志记录-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2，写web日志类

package com.itmayiedu.aop;

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 //将一个java类定义为切面类
@Component
public class WebLogAspect 
    public static final Logger logger= LoggerFactory.getLogger(WebLogAspect.class);

    /**
     * @Pointcut  定义一个切入点，可以是一个规则表达式，比如下面的某个package下的所有函数，也可以是一个注解等
     */
    @Pointcut("execution(public * com.itmayiedu.controller.*.*(..))")
    public  void webLog()
    

    /**根据需要在切入点开始处切入内容
     * 使用@Before 在切入点开开始切入内容
     * 使用Aop前置配置通知拦截请求信息
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public  void doBefore(JoinPoint joinPoint) throws Throwable
        //接到请求，记录请求内容 记录最多半年数据迁移  云备份
        ServletRequestAttributes attributes= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request=attributes.getRequest();
        //记录下日志请求内容
        logger.info("URL : "+request.getRequestURL());
        logger.info("Http_METHOO : "+request.getMethod());
        logger.info("IP : "+request.getRemoteAddr());
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("ASK_TIME : "+System.currentTimeMillis());
        Enumeration<String> enu =request.getParameterNames();
        while (enu.hasMoreElements())
            String name=enu.nextElement();
            logger.info("name : ,value :  ",name,request.getParameter(name));
        



    

    /**

     * 根据需要在不同位置的切入内容

     * @AfterReturning 在切入点return内容后切入内容（可以用来对处理返回值做一些加工处理）

     * @param ret

     * @throws Throwable

     */
    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret)throws Throwable
        //处理完成，返回内容
        logger.info("RESPONSE : "+ret);
    

 

3，添加日志
只是需要在resource目录下添加 logback.xml就可以

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%dyyyy-MM-dd HH:mm:ss.SSS [%thread] %-5level %logger50 - %msg  %n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>$LOG_HOME/runtime.log.%dyyyy-MM-dd.log</FileNamePattern>
            <!--志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%dyyyy-MM-dd HH:mm:ss.SSS [%thread] %-5level %logger50 - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>