SpringBoot+AOP+日志框架logback整合

男娘i 2023-09-26 09:19 77阅读 0赞

#### 文章目录 ####

*  SpringBoot+AOP+日志框架logback整合
 *   *   *  项目集成日志框架(logback)
         *  自定义注解+AOP实现日志打印

## SpringBoot+AOP+日志框架logback整合 ##

> Logback中有五个日志级别，分别为**TRACE**<**DEBUG**<**INFO**<**WARN**<**ERROR**

#### 项目集成日志框架(logback) ####

> 导入jar包

<dependency>
                <groupId>net.logstash.logback</groupId>
                <artifactId>logstash-logback-encoder</artifactId>
                <version>6.6</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.3</version>
            </dependency>

> 配置logback-spring.xml文件

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    <configuration scan="true" scanPeriod="10 seconds">
        
        <contextName>Logback For Boss</contextName>
        
        <property name="log.path" value="D:/log"/>
        
        <property name="logDir" value="D:/log"/>
        
        <property name="maxHistory" value="30"/>
    
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger-%msg%n</pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
        </appender>
    
    
        
        <appender name="ERROR"
                  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <rollingPolicy
                    class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${logDir}\%d{yyyyMMdd}\error.log</fileNamePattern>
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n
                </pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
            <append>false</append>
            <prudent>false</prudent>
        </appender>
    
        
        <appender name="WARN"
                  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>WARN</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <rollingPolicy
                    class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${logDir}\%d{yyyyMMdd}\warn.log</fileNamePattern>
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger-%msg%n</pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
            <append>false</append>
            <prudent>false</prudent>
        </appender>
    
        
        <appender name="INFO"
                  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <rollingPolicy
                    class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${logDir}\%d{yyyyMMdd}\info.log</fileNamePattern>
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger-%msg%n</pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
            <append>false</append>
            <prudent>false</prudent>
        </appender>
    
        
        <appender name="DEBUG"
                  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>DEBUG</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
            <rollingPolicy
                    class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${logDir}\%d{yyyyMMdd}\debug.log</fileNamePattern>
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger-%msg%n</pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
            <append>false</append>
            <prudent>false</prudent>
        </appender>
    
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${logDir}/%d{yyyyMMdd}/%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
            
            <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
                <MaxFileSize>10MB</MaxFileSize>
            </triggeringPolicy>
        </appender>
    
        
        <appender name="dayLogAsyncAppender" class="ch.qos.logback.classic.AsyncAppender">
            <includeCallerData>true</includeCallerData>
            
            <discardingThreshold>0</discardingThreshold>
            
            <queueSize>512</queueSize>
            <appender-ref ref="FILE"/>
        </appender>
    
        
        
        
        
        
        
        
        
        
    
        
        
        
        <root level="INFO">
            
            <appender-ref ref="STDOUT"/>
            
            <appender-ref ref="ERROR"/>
            <appender-ref ref="INFO"/>
            <appender-ref ref="WARN"/>
            <appender-ref ref="DEBUG"/>
        </root>
    </configuration>

> 在需要日志打印的类中实例化一个LOGGER对象

public static final Logger LOGGER = LoggerFactory.getLogger(xxx.class);

> 日志输出

LOGGER.error("error");
    LOGGER.warn("wring");
    LOGGER.info("info"); 
    LOGGER.debug("debug");
    LOGGER.trace("trace");

#### 自定义注解+AOP实现日志打印 ####

> 声明自定义注解

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 自定义注解：自动进行日志打印
     */
    @Target({
        ElementType.PARAMETER, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface AutoLogAnnotation {
        
        String methodDesc() default "";//方法描述
    }

> 导入日志jar包依赖，然后配置xml文件。

> 实现自定义注解+AOP日志打印

import com.example.demo.annotation.AutoLogAnnotation;
    import com.google.gson.Gson;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    
    import org.aspectj.lang.annotation.Pointcut;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    import java.lang.reflect.Method;
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * 切面AOP
     */
    @Aspect
    @Component
    public class AutoLogAspect {
        
    
        private static final Logger LOGGER = LoggerFactory.getLogger(AutoLogAspect.class);
    
        @Pointcut("@annotation(com.example.demo.annotation.AutoLogAnnotation)")
        public void logPointCut() {
        
        }
    
        //环绕注入
        @Around("logPointCut()")
        public Object around(ProceedingJoinPoint point) throws Throwable {
        
            long startTime = System.currentTimeMillis();//记录目标方法的开始执行时间
            Object result = point.proceed();//执行目标方法
            long methodExecuteTime = System.currentTimeMillis() - startTime;
    
            //日志信息记录
            try {
        
                MethodSignature methodSignature = (MethodSignature) point.getSignature();
                Method method = methodSignature.getMethod();
                AutoLogAnnotation systemLog = method.getDeclaredAnnotation(AutoLogAnnotation.class);
                String className = point.getTarget().getClass().getName();//类名
                String methodName = method.getName();//方法名
    
                //入参信息
                Object[] args = point.getArgs();
                List<String> list = new ArrayList<String>();
                for (Object obj : args) {
        
                    list.add(new Gson().toJson(obj));
                }
                LOGGER.info(className + "." + methodName + "，" + systemLog.methodDesc() + ",入参：" + list.toString());
                LOGGER.info(className + "." + methodName + "，" + systemLog.methodDesc() + "，耗时：" + methodExecuteTime + "ms");
            } catch (Exception e) {
        
                LOGGER.error("日志切入出错");
            }
            return result;
        }
    }