logback的简单使用

曾经终败给现在 2022-11-05 11:59 93阅读 0赞

### 文章目录 ###

*  1、前置
 *  2、application.yml配置如下:
 *  3、logback-spring.xml基本配置如下:
 *  4、动态指定日志级别方式A:
 *  5、动态指定日志级别方式B:
 *  6、备注:

--------------------

# 1、前置 #

1、先介绍logback-spring.xml基本配置  
2、动态指定日志级别方式A  
3、动态指定日志级别方式B  
4、个人看法

# 2、application.yml配置如下: #

# logback-spring.xml中会应用以下参数
    # 日志保存目录
    log_path: ${LOG_PATH:/upload/logs}

# 3、logback-spring.xml基本配置如下: #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NjM3NTU4_size_16_color_FFFFFF_t_70]

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    <configuration  scan="true" scanPeriod="10 seconds" debug="false">
        <contextName>logback</contextName>
        
        <springProperty scope="context" name="log.path" source="log_path" defaultValue="/logs/chaim"/>
        
        
        <property name="maxHistory" value="10" />
        
        <property name="maxFileSize" value="10MB" />
        
        <property name="totalSizeCap" value="10GB" />
    
        
        
        <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
        <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
        <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
        
        <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    
    
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    
    
    
    
    
            <encoder>
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        
        
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_debug.log</file>
            
            <encoder>
                <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/debug/log-debug-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxFileSize>${maxFileSize}</maxFileSize>
                <maxHistory>${maxHistory}}</maxHistory>
                <totalSizeCap>${totalSizeCap}</totalSizeCap>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>DEBUG</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_info.log</file>
            
            <encoder>
                <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/info/log-info-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxFileSize>${maxFileSize}</maxFileSize>
                <maxHistory>${maxHistory}}</maxHistory>
                <totalSizeCap>${totalSizeCap}</totalSizeCap>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_warn.log</file>
            
            <encoder>
                <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/warn/log-warn-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxFileSize>${maxFileSize}</maxFileSize>
                <maxHistory>${maxHistory}}</maxHistory>
                <totalSizeCap>${totalSizeCap}</totalSizeCap>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>WARN</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_error.log</file>
            
            <encoder>
                <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/error/log-error-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
                <maxFileSize>${maxFileSize}</maxFileSize>
                <maxHistory>${maxHistory}}</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <logger name="com.chaim.system.mapper" level="DEBUG"/>
    
    
    
        
        <root level="info">
            
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="ERROR_FILE" />
        </root>
    </configuration>

找到对应的目录下, 可以看到对应的日志已经被写入文件:  
![在这里插入图片描述][20210306145601569.png]

# 4、动态指定日志级别方式A: #

# application.yml添加一个参数:
    # 日志输出级别, true开发模式, false线上环境
    log_environment: ${LOG_ENVIRONMENT:true}

# logback-spring.xml添加一个springProperty 标签:
    <springProperty scope="context" name="log_environment" source="log_environment" defaultValue="false"/>

# 需依赖包:janino
    <dependency>
       <groupId>org.codehaus.janino</groupId>
       <artifactId>janino</artifactId>
       <version>3.1.2</version>
    </dependency>

更改上面截图中的第三块:

# 通过 p("log_environment") 来获取log_environment值
    # equals contains
    <if condition='"true".equals(p("log_environment"))'>
            <then>
                # 当log_environment==true, 指定日志级别:info 控制台输出, 以及对应的文件写入
                <root level="info">
                    
                    <appender-ref ref="CONSOLE" />
                    <appender-ref ref="DEBUG_FILE" />
                    <appender-ref ref="INFO_FILE" />
                    <appender-ref ref="WARN_FILE" />
                    <appender-ref ref="ERROR_FILE" />
                </root>
            </then>
            <else>
                # 当log_environment!=true, 指定日志级别:error 控制台输出, 以及对应的日志级别文件写入
                <root level="error">
                    <appender-ref ref="CONSOLE" />
                    <appender-ref ref="INFO_FILE" />
                    <appender-ref ref="ERROR_FILE" />
                </root>
            </else>
        </if>

关于 if 标签官方文档介绍:  
地址:https://logback.qos.ch/manual/configuration.html  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NjM3NTU4_size_16_color_FFFFFF_t_70 1]

# 5、动态指定日志级别方式B: #

配置环境, 两种方式:

第一种: 配置pom.xml:
    <profiles>
            <profile>
                
                <id>dev</id>
                <properties>
                    <profiles.active>dev</profiles.active>
                </properties>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
            </profile>
            <profile>
                
                <id>prod</id>
                <properties>
                    <profiles.active>prod</profiles.active>
                </properties>
            </profile>
        </profiles>
    
    第二种: 指定当前环境:
    # 在application.yml中指定当前环境参数:
    spring.profiles.active=dev

更改上面截图中的第三块:

<springProfile name="dev">
            <root level="info">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="DEBUG_FILE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="WARN_FILE" />
                <appender-ref ref="ERROR_FILE" />
            </root>
        </springProfile>
    
        
        <springProfile name="prod">
            <root level="error">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="ERROR_FILE" />
            </root>
        </springProfile>

# 6、备注: #

1、多测, 多做自测  
2、个人推荐使用第5种方式, 通过环境区分, 轻便也简单  
3、 以上只是列举了 一些基本的参数, 具体的大家可以借助搜素引擎的力量  
4、不足的地方, 还望大家不吝赐教, 多多指正

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NjM3NTU4_size_16_color_FFFFFF_t_70]: /images/20221023/d77199ba81314866b96df8d924e21721.png
[20210306145601569.png]: /images/20221023/99b5059ea5244650a0f44c3ada31b870.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4NjM3NTU4_size_16_color_FFFFFF_t_70 1]: /images/20221023/938c8096c3be48d0831c92b63723d273.png