美文网首页
spring boot logback.xml 配置

spring boot logback.xml 配置

作者: _大叔_ | 来源:发表于2020-12-17 16:22 被阅读0次

一、logback基本配置

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration  scan="true" scanPeriod="10 seconds" debug="false">

    <contextName>logback</contextName>

    <!-- 彩色日志依赖的渲染类 -->
    <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" />

    <!-- 彩色日志格式 -->
    <!-- %m输出的信息, %p日志级别, %t线程名, %d日期, %c类的全名, %i索引 -->
    <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}}"/>
    <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
    <property name="logPath" value="D:/log" />
    <property name="name" value="giant-cloud-server-rt-storage" />

    <!-- appender是configuration的子节点,是负责写日志的组件 -->
    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志 appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 时间滚动输出 level为 DEBUG 日志 -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${logPath}/${name}.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <!-- %m输出的信息, %p日志级别, %t线程名, %d日期, %c类的全名, %i索引 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss}  [ %thread ]  %-5level  %logger{50}  -  %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志归档 -->
            <fileNamePattern>${logPath}/${name}/%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小,默认值是10MB,本篇设置为100MB -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录debug级别的,如果设置只会输出相应级别的日志,不设置只输出和控制台相同的日志 -->
        <!--        <filter class="ch.qos.logback.classic.filter.LevelFilter">-->
        <!--            <level>info</level>-->
        <!--            <onMatch>ACCEPT</onMatch>-->
        <!--            <onMismatch>DENY</onMismatch>-->
        <!--        </filter>-->
    </appender>

    <!--
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
        以及指定<appender>。<logger>仅有一个name属性,
        一个可选的level和一个可选的addtivity属性。
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
              还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
              如果未设置此属性,那么当前logger将会继承上级的级别。
        addtivity:是否向上级logger传递打印信息。默认是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
    <!--
        使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
        第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
        第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:
     -->

    <!--开发环境:打印控制台-->
    <springProfile name="@activatedProperties@">
        <!-- 指定某些包直输出error信息 -->
        <logger name="sun.net" level="error"/>
        <logger name="org.apache" level="error"/>
        <logger name="com.giant.cloud" level="debug"/>
        <logger name="com.giant.cloud.mapper" level="error"/>
        <logger name="sum.rmi" level="error"/>
    </springProfile>

    <!--
        root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
        不能设置为INHERITED或者同义词NULL。默认是DEBUG
        可以包含零个或多个元素,标识这个appender将会添加到这个logger。
    -->
    <root level="error">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG" />
    </root>

</configuration>

以上的这些配会把日志输出到文件中,并分天保存日志到固定目录下,待时间到了后删除。

二、logback 分环境

主pom设置

    <dependencies>
        <!-- 必须添加否则子项目的环境不起作用或报错 -->
        <dependency>
            <groupId>org.yaml</groupId>
            <artifactId>snakeyaml</artifactId>
        </dependency>
    </dependencies>

    <!-- 不同的 profile,对应不同的开发环境 -->
    <profiles>
        <!-- 开发环境 -->
        <profile>
            <id>dev</id>
            <!-- 参数 -->
            <properties>
                <activatedProperties>dev</activatedProperties>
            </properties>
            <!-- 默认开发环境 -->
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>

        <!-- 测试环境 -->
        <profile>
            <id>test</id>
            <properties>
                <activatedProperties>test</activatedProperties>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>

        <!-- 生产环境 -->
        <profile>
            <id>produce</id>
            <properties>
                <activatedProperties>produce</activatedProperties>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>
    </profiles>

子pom设置

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>

        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**</include>
                </includes>
            </resource>

            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**</include>
                </includes>
                <!-- 必须添加否则更改环境无法识别 -->
                <filtering>true</filtering>
            </resource>
        </resources>

    </build>

application.yml 配置

spring:
  profiles:
    active: @activatedProperties@
# 日志
logging:
  config: classpath:log/logback-@activatedProperties@.xml

@activatedProperties@ 会读取 主pom的 <profiles> 的配置,也可以根据 idea 选择的 profiles。

我们只需要手动创建 logback-x.xml,选择环境启动项目即可,日志就会根据所选环境加载配置进行输出。

三、自定义 appender

我们可以从以上 appender 看到指定了某个class为 appender 的规则。其主要继承了 UnsynchronizedAppenderBase,实现了 Appender,而我们只需要 继承 UnsynchronizedAppenderBase 即可。

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.Layout;
import ch.qos.logback.core.UnsynchronizedAppenderBase;
import lombok.Data;

/**
 * @author big uncle
 * @date 2020/12/17 14:51
 * @module
 **/
@Data
public class RedisAppender extends UnsynchronizedAppenderBase<ILoggingEvent>{

    Layout<ILoggingEvent> layout;

    //自定义配置
    String applicationName;

    @Override
    protected void append(ILoggingEvent iLoggingEvent) {
        if (iLoggingEvent == null || !isStarted()){
            return;
        }
        // 此处自定义实现输出
        // 获取输出值:event.getFormattedMessage()
        // System.out.print(event.getFormattedMessage());
        // 格式化输出
        System.out.print(layout.doLayout(iLoggingEvent));
    }

    @Override
    public void start(){
        //这里可以做些初始化判断 比如layout不能为null ,
        if(layout == null) {
            addWarn("Layout was not defined");
        }
//        System.out.println("logback-start方法被调用");
        //或者写入数据库 或者redis时 初始化连接等等
        super.start();
    }

    @Override
    public void stop()
    {
        //释放相关资源,如数据库连接,redis线程池等等
//        System.out.println("logback-stop方法被调用");
        if(!isStarted()) {
            return;
        }
        super.stop();
    }
}

我自定义了一个 RedisAppender,让所有日志信息到Redis中。
在 logback.xml 使用如下

    <appender name="REDIS" class="com.giant.cloud.log.RedisAppender">
        <applicationName>${name}</applicationName>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss}  [ %thread ]  %-5level  %logger{50}  -  %msg%n</pattern>
        </layout>
    </appender>

相关文章

网友评论

      本文标题:spring boot logback.xml 配置

      本文链接:https://www.haomeiwen.com/subject/gguzgktx.html