logback-spring.xml文件的编写

我们经常会在程序内看到logback/logback-spring 文件,这类文件如何配置,如何实现对不同类型的日志输出,以及分时间打包,分时段输出都可以在这个文件内配置。
logback-spring.xml 只有在Spring应用程序运行的时候才生效,即带有@SpringBootApplication注解的类启动的时候才会生效。
如果不是Spring应用程序,而是一个main方法或者一个JUnit的测试方法,要用 logback.xml 来配置。

系统中的配置文件

  • logback-spring.xml (直接可以在java应用中使用)
    下面给出我前几天在我们系统中配置的文件进行拆解。
<configuration>
    <!--文件输出名-->
    <property name="LOG_FILE" value="./logs"/>
    <!--文件输出名 sql-->
    <property name="LOG_SQL_FILE" value="./logs"/>
    <!--日志输出格式-->
    <property name="LOG_PATTERN" value="%d{yyyy/MM/dd-HH:mm:ss} %-5level [%thread] %logger - %msg%n"/>
    <!-- 活动文件的大小 -->
    <property name="max.file.size" value="100MB"/>
    <!-- 保留的归档文件的最大天数 -->
    <property name="max.history" value="30"/>
    <!-- 控制所有归档日志文件的总大小 -->
    <property name="total.size.cap" value="30GB"/>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- logger命中中包含Mapper的单独输出到一个文件 -->
    <appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_SQL_FILE}/uhi-debug-sql.log</file>
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator class="ch.qos.logback.classic.boolex.JaninoEventEvaluator">
                <expression>logger.contains("Mapper")</expression>
            </evaluator>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_SQL_FILE}/%d{yyyy-MM-dd}/uhi-debug-sql.%i.log.gz</fileNamePattern>
            <maxHistory>${max.history}</maxHistory>
            <totalSizeCap>${total.size.cap}</totalSizeCap>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${max.file.size}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 输出错误日志文件 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_FILE}/uhi-asset-gateway-error.log</file>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}/%d{yyyy-MM-dd}/uhi-asset-gateway-error.%i.log.gz</fileNamePattern>
            <maxHistory>${max.history}</maxHistory>
            <totalSizeCap>${total.size.cap}</totalSizeCap>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${max.file.size}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>

    <!--日志输出-->
    <appender name="TIME_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_FILE}/uhi-asset-gateway.log</file>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}/%d{yyyy-MM-dd}/uhi-asset-gateway-%d{HH}.%i.log.gz</fileNamePattern>
            <maxHistory>${max.history}</maxHistory>
            <totalSizeCap>${total.size.cap}</totalSizeCap>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${max.file.size}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>

    <!-- 添加异常信息输出指定文件 -->
    <logger name="com.nonecity.common.utils.helper.SpringHelper" additivity="false" level="ERROR">
        <appender-ref ref="ERROR_FILE"/>
    </logger>

    <!-- 添加log信息输出指定文件 -->
    <logger name="com.nonecity" additivity="false" level="WARN">
        <appender-ref ref="TIME_FILE"/>
    </logger>

    <!--打印sql-->
    <logger name="com.nonecity" additivity="true" level="DEBUG">
        <appender-ref ref="SQL_FILE"/>
    </logger>

    <!--日志级别-->
    <root level="WARN">
        <appender-ref ref="CONSOLE"/>
    </root>

</configuration>

配置文件解读

  • <appender> 标签:是负责写日志的组件,有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
  • ConsoleAppender:把日志输出到控制台中,并可以用<encoder>进行格式化操作;
  • RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件;
  • <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
  • <timeBasedFileNamingAndTriggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
  • sql 单独输出到文件
        <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
            <evaluator class="ch.qos.logback.classic.boolex.JaninoEventEvaluator">
                <expression>logger.contains("Mapper")</expression>
            </evaluator>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

此需要引入程序包:

<!-- https://mvnrepository.com/artifact/org.codehaus.janino/janino -->
        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>janino</artifactId>
            <version>3.0.8</version>
        </dependency>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容