Springboot配置logback日志----依葫芦画瓢就能用

最新推荐文章于 2023-12-28 14:20:42 发布

DayFight_DayUp

最新推荐文章于 2023-12-28 14:20:42 发布

阅读量545

点赞数 1

分类专栏： # SpringBoot 文章标签： Springboot配置logback日志----依葫芦画瓢

本文链接：https://blog.csdn.net/a907691592/article/details/97792283

版权

SpringBoot 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

再没有自定义配置的时候，我们能在application种这样配置：

logging.level.root=debug
logging.level.web=debug
logging.level.sql=debug
logging.level.org.apache.ibatis=debug
logging.level.com.wangye.spbootmybatis3=debug
logging.file=
logging.path=

有多少模块就配置多少模块，但是这样配置的日志只能输出一个文件，如果要输出多个文件，比如把warn、error输出要错误文件中。把等级大于或等于debug的输出到全部的日志文件中，那么我们就要自定义日志文件。

SpringBoot默认整合了logback，你几乎只要一个XXXstarter，就都会依赖logback

只要依赖了spring-boot-starter，就会依赖spring-boot-starter-logging,从而依赖logback。

既然已经依赖了logback，那么我们就直接配置就好了。

首先要在resource下创建一个logback-spring.xml文件（Spring推荐），接下来就要配置了，配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
    scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
    scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒；当scan为true时，此属性生效。默认的时间间隔为1分钟。
    debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="logs"/>

    <!-- 从application.properties种获取属性 -->
    <springProperty scope="context" name="LogPath" source="log.path" defaultValue="D:/mylogDev"/>
    <!-- 从application.properties种获取属性 -->
    <springProperty scope="context" name="LogAppName" source="log.appName" defaultValue="SpringBootLogBackTest"/>

    <!-- 定义日志文件名称 -->
    <property name="appName" value="coco"></property>

    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <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}:%line){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 日志输出格式：
                %d表示日期时间，
                %thread表示线程名，
                %-5level：级别从左显示5个字符宽度
                %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
                %msg：日志消息，
                %n是换行符
        -->
        <!--
        <layout class="ch.qos.logback.classic.PatternLayout">

            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==> [%thread] ==> %-5level %logger{50} - %msg%n</pattern>
        </layout>
        -->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf-8</charset>
        </encoder>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <appender name="appAllLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LogPath}/${LogAppName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LogPath}/${LogAppName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!--
            当日志文件超过maxFileSize指定的大小时，根据上面提到的%i进行日志文件滚动
            注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加为true,追加方式记录日志 -->
        <append>true</append>
        <!-- 日志输出格式： -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
        -->
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <appender name="appErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LogPath}/${LogAppName}-error.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level><!-- 警告以上的日志才会打印 -->
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LogPath}/${LogAppName}-error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!--
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!--
            当日志文件超过maxFileSize指定的大小时，根据上面提到的%i进行日志文件滚动
            注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <!-- 日志输出格式： -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            <charset>utf-8</charset> <!-- 编码格式 -->
        </encoder>
        <!--
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
        -->
    </appender>

    <!--
       root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
       要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
       如果logger没有定义字节点。默认是使用root的子节点
       -->
    <root level="debug">
        <appender-ref ref="stdout"/>
        <appender-ref ref="appAllLog"/>
        <appender-ref ref="appErrorLog"/>
    </root>

    <!--
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- app logger -->
    <logger name="com.wangye.spbootlogback" level="debug" additivity="true"/>
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="true"  />
    <logger name="org.springframework.web" level="debug" additivity="true"/>
    <logger name="org.springframework.web.servlet" level="debug" additivity="true"/>
    <logger name="org.springframework.http" level="debug" additivity="true"/>
    <logger name="org.springframework.remoting" level="debug" additivity="true"/>
    <logger name="org.springframework.transaction" level="debug" additivity="true"/>
    <logger name="org.springframework.dao" level="debug" additivity="true"/>
    <logger name="org.springframework.jdbc" level="debug" additivity="true"  />
    <logger name="org.apache.ibatis" level="debug" additivity="true"/>
    <logger name="org.mybatis" level="debug" additivity="true"/>
    <logger name="java.sql" level="debug"  additivity="true" />
</configuration>

想必已经注意到配置中的

 <!-- 从application.properties种获取属性 -->
    <springProperty scope="context" name="LogPath" source="log.path" defaultValue="D:/mylogDev"/>
    <!-- 从application.properties种获取属性 -->
    <springProperty scope="context" name="LogAppName" source="log.appName" defaultValue="SpringBootLogBackTest"/>

这是笔者为了分环境的，已经不同环境有不同的输出路径，笔者已经在SpringBoot多环境配置---带图带文，一看就知道博文中详细介绍了springboot如何分环境。

那么我们来看看application-dev.properties和application-test.properties中者两个变量的值：

application-dev.properties：

log.path=D:/mylogDev
log.appName=SpringBootLogBackDev

application-test.properties:

log.path=D:/mylogTest
log.appName=SpringBootLogBackTest

上面的配置我控制台输出使用的是彩色格式，文件中就不是彩色的了。

其实日志级别也是能分环境配置在各环境的properties中。（笔者也推荐分环境配置日志级别，这样生产能提高效率）。

一般情况下，生产环境中一般是info，测试和本地开发一般是debug（一般要把sql，还有参数打出来）。

好了，这样logback就配置完了接下来就是dev和test启动看看D盘下是不是出现了如下的目录而且里面有两个log文件。

看看测试代码：

@SpringBootApplication
@MapperScan("com.wangye.spbootlogback.mapper")
public class SpbootLogbackApplication {

    private static final Logger logger = LoggerFactory.getLogger(SpbootLogbackApplication.class);

    public static void main(String[] args) {
        SpringApplication.run(SpbootLogbackApplication.class, args);
        logger.trace("trace 打印了");
        logger.debug("debug 打印了");
        logger.info("info 打印了");
        logger.warn("warn 打印了");
        logger.error("error 打印了");
    }

}

我在启动类里获取了日志对象，也打印日志，因为无论是那个环境都是debug，那么只有下面四行能打印日志，trace不能打印。