Springboot, springMVC logback 日志目录配置

之前一直用的是log4j, 设置有一些局限, 而且logback在性能, 资源占用等方面都优于前者.

下面是主要的springboot 2环境下的logback配置, 由于springboot已经集成了日志系统, 所以不需要添加任何maven依赖

1. 配置目录(在application.properties或application.yml中添加目录配置)

logging.path: ./logs (自行根据需要修改, 我是指向当前工程下的logs目录, 会自动创建目录)

      如果是非springboot环境, maven中添加依赖

            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.3</version>
            </dependency>

 

2. logback.xml(springboot下推荐命名为logback-spring.xml) 放在resources目录下, 系统自动加载, 例子: 

<?xml version="1.0" encoding="UTF-8" ?>
<configuration debug="false" scan="true" scanPeriod="60 seconds">
    <!-- 自定义变量 -->
    <property name="LOG_HOME" value="${LOG_PATH}"/>
    <property name="FILE_NAME" value="developer"/>
    <property name="LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%logger{0}:%L] %level - %msg%n"/>

    <!-- 控制台输出 -->
    <appender name="CONSOLE_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>


    <!-- 按照每天生成日志文件 -->
    <appender name="LOG_DEBUG_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前日志文件 -->
        <file>${LOG_HOME}/${FILE_NAME}.debug</file>

        <!-- 备份 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${FILE_NAME}.debug.%d{yyyy-MM-dd}</fileNamePattern>
            <maxHistory>7</maxHistory>
        </rollingPolicy>

        <!-- 格式化输出 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>

        <!-- 级别过滤 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="LOG_INFO_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前日志文件 -->
        <file>${LOG_HOME}/${FILE_NAME}.log</file>

        <!-- 备份 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${FILE_NAME}.log.%d{yyyy-MM-dd}</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <!-- 格式化输出 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>

        <!-- 级别过滤 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>

    <appender name="LOG_ERROR_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前日志文件 -->
        <file>${LOG_HOME}/${FILE_NAME}.err</file>
        <append>true</append>

        <!-- 备份 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${FILE_NAME}.err.%d{yyyy-MM-dd}</fileNamePattern>
            <maxHistory>7</maxHistory>
        </rollingPolicy>

        <!-- 格式化输出 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>

        <!-- 级别过滤 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <!-- 日志输出 -->
    <logger name="org.springframework" level="INFO"/>
    <logger name="org.mybatis" level="INFO"/>
    <logger name="io.netty" level="INFO"/>
    <logger name="org.quartz" level="INFO"/>

    <if condition='property("LOG_HOME").startsWith("/")'>
        <then>
            <root level="info">
                <appender-ref ref="CONSOLE_APPENDER"/>
            </root>
        </then>
        <else>
            <root level="DEBUG">
                <appender-ref ref="LOG_DEBUG_APPENDER"/>
                <appender-ref ref="LOG_INFO_APPENDER"/>
                <appender-ref ref="LOG_ERROR_APPENDER"/>
            </root>
        </else>
    </if>
</configuration>

说明: (一些logback的基本配置这里就不赘述了)

1) <property name="LOG_HOME" value="${LOG_PATH}"/> 自定义变量LOG_HOME, 指向LOG_PATH

(如果是非springboot的 tomcat环境, 将LOG_PATH改为catalina.base)

 

2) LOG_PATTERN 指定log样式(上述配置, 打出的log格式如下, 个人推荐, 有线程名, 类名, 行号, 日志级别)

2019-04-28 11:25:30.583 [restartedMain] [Application:59] INFO - Started Application in 18.169 seconds (JVM running for 18.913)
2019-04-28 11:25:30.585 [restartedMain] [Restarter:224] DEBUG - Creating new Restarter for thread Thread[main,5,main]
2019-04-28 11:25:30.585 [restartedMain] [Restarter:224] DEBUG - Immediately restarting application

 

3)日志归档策略

上述配置的归档策略为: 保存30天日志(以info为例), 之前日志在结尾自动追加日期

 

4)特殊日志(其它框架)处理(只打印info)

<logger name="org.springframework" level="INFO"/> 

 

5)环境适配说明, 由于用到了表达式, 需要添加maven依赖

        <dependency>
            <groupId>org.codehaus.janino</groupId>
            <artifactId>janino</artifactId>
            <version>3.0.6</version>
        </dependency>

//判断上面定义的LOG_HOME路径是否以/开头(主要区别windows, linux环境, 在开发环境(windows)自动切换)
<if condition='!property("LOG_HOME").startsWith("/")'>

             //windows log打印至控制台
            <appender-ref ref="CONSOLE_APPENDER"/>

             //linux环境, 部署环境, 打印到日志文件
            <root level="DEBUG">
                <appender-ref ref="LOG_DEBUG_APPENDER"/>
                <appender-ref ref="LOG_INFO_APPENDER"/>
                <appender-ref ref="LOG_ERROR_APPENDER"/>
            </root>