【SpringBoot】——SpringBoot详细配置 logback

程序员文章站 2022-07-03 16:10:32

...

参考链接：https://www.cnblogs.com/lixuwu/p/5804793.html#_label0

资源链接：https://download.csdn.net/download/weixin_37603867/10507712

配置流程：

1. 引入jar包：

①：maven 环境下直接将jar包放入pom.xml 中，其余jar包会自动依赖进来

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

②：如果非maven项目请自行下载logback 需要jar包；所需jar包有

  logback-access-1.0.0.jar
  logback-classic-1.0.0.jar
  logback-core-1.0.0.jar
  slf4j-api-1.6.0.jar

  ③：引入jar包出现错误，错误消息及解决方法如下：

<!--引入logback-classic.jar 包出现报错，
    报错信息：java.lang.ClassCastException: org.slf4j.impl.Log4jLoggerFactory cannot be cast to ch.qos.logback.classic.LoggerContext
    解决方法：logback-classic 和 slf4j-log4j12 中 StaticLoggerBinder 中的方法冲突，所以将slf4j-log4j12.jar 包排除。即可不报错。
    参考链接：https://www.cnblogs.com/simplelei/p/5408029.html
    -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<!--logback 配置   end-->

2. 默认springboot 项目是查找classpath 路径下的 logback.xml 或者 logback-test.xml 如果都没有找到默认地会调用BasicConfigurator ，创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。

配置方式：

①：可以在application.xml 中执行logback 的位置；指定方式：

logging.config=classpath:logback-boot.xml

②： 可以在classpath 下 创建 logback.xml 或者 logback-test.xml 即可。

配置示例：（详细配置）

注意配置文件中需要修改日志的路径：(其他暂时不需要修改)

【SpringBoot】——SpringBoot详细配置 logback

<!--springboot - logback 配置 参考链接： https://www.cnblogs.com/lixuwu/p/5804793.html#_label0 -->
<!--级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE-->

<configuration>

    <!--说明一：-->
    <!--
       1、日志级别及文件
           日志记录采用分级记录，级别与日志文件名相对应，不同级别的日志信息记录到不同的日志文件中
           例如：error级别记录到log_error_xxx.log或log_error.log（该文件为当前记录的日志文件），而log_error_xxx.log为归档日志，
           日志文件按日期记录，同一天内，若日志文件大小等于或大于2M，则按0、1、2...顺序分别命名
           例如log-level-2013-12-21.0.log
           其它级别的日志也是如此。
       2、文件路径
           若开发、测试用，在Eclipse中运行项目，则到Eclipse的安装路径查找logs文件夹，以相对路径../logs。
           若部署到Tomcat下，则在Tomcat下的logs文件中
       3、Appender
           FILEERROR对应error级别，文件名以log-error-xxx.log形式命名
           FILEWARN对应warn级别，文件名以log-warn-xxx.log形式命名
           FILEINFO对应info级别，文件名以log-info-xxx.log形式命名
           FILEDEBUG对应debug级别，文件名以log-debug-xxx.log形式命名
           stdout将日志信息输出到控制上，为方便开发测试使用
    -->

    <!-- 控制台日志 begin-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset><!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
        </encoder>
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>
    <!-- 控制台日志 end-->

    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_PATH" value="E:/logs" />

    <!--设置记录日志的目录-->
    <contextName>SpringBootJpaDemo</contextName>
    <property name="APPDIR" value="SpringBootJpaDemo" />

    <!--日志级别仅为 info    begin -->
    <!--日志记录器，日期滚动记录-->
    <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--设置日志最新位置-->
        <file>${LOG_PATH}/${APPDIR}/log_info.log</file>

        <!--日志记录器的滚动策略，按照日期记录大小记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例如今天是2013-12-21日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，
            从而将当前日志文件或归档日志文件置不同的目录。而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 30天 -->
            <maxHistory>30</maxHistory>

            <!--使用 timeBasedFileNamingAndTriggeringPolicy 这个配置会报错：
               报错： Caused by: java.lang.IllegalStateException: Logback configuration error detected:
               解决： 参考下方： -->
            <!-- 除按日志记录之外，还配置了日志文件不能超过2M，若超过2M，日志文件会以索引0开始，命名日志文件，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>

        </rollingPolicy>

        <!-- 追加方式记录日志 -->
        <append>true</append>

        <!--日志的文件格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>

        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!--日志级别仅为 info    end -->

    <!--日志级别仅为 warn    begin -->
    <!--日志记录器，日期滚动记录-->
    <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--设置日志最新位置-->
        <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>

        <!--日志记录器的滚动策略，按照日期记录大小记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例如今天是2013-12-21日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log_warn-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

            <!-- 日志最大的历史 30天 -->
            <maxHistory>30</maxHistory>

            <!--使用 timeBasedFileNamingAndTriggeringPolicy 这个配置会报错：
               报错： Caused by: java.lang.IllegalStateException: Logback configuration error detected:
               解决：参考下方-->
            <!-- 除按日志记录之外，还配置了日志文件不能超过2M，若超过2M，日志文件会以索引0开始，命名日志文件，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <!-- 追加方式记录日志 -->
        <append>true</append>

        <!--日志的文件格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>

        <!-- 此日志文件只记录 warn 级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!--日志级别仅为 warn    end -->

    <!--日志级别仅为 error    begin -->
    <!--日志记录器，日期滚动记录-->
    <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--设置日志最新位置-->
        <file>${LOG_PATH}/${APPDIR}/log_error.log</file>

        <!--日志记录器的滚动策略，按照日期记录大小记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 归档的日志文件的路径，例如今天是2013-12-21日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/error/log_error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>

            <!-- 日志最大的历史 30天 -->
            <maxHistory>30</maxHistory>

            <!--使用 timeBasedFileNamingAndTriggeringPolicy 这个配置会报错：
               报错： Caused by: java.lang.IllegalStateException: Logback configuration error detected:
               解决：参考下方 -->
            <!-- 除按日志记录之外，还配置了日志文件不能超过2M，若超过2M，日志文件会以索引0开始，命名日志文件，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <!-- 追加方式记录日志 -->
        <append>true</append>

        <!--日志的文件格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>

        <!-- 此日志文件只记录 error 级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!--日志级别仅为 error    end -->

    <!--说明二:-->
    <!--说明：
        %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,,
        appender是configuration的子节点，是负责写日志的组件。
        格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符
        -->

    <!-- 包制定日志  begin -->
    <!-- com.dj 为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
    <!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
    <!--<logger name="com.dj" level="info"></logger>-->
    <!-- 包制定日志  end -->

    <!-- 日志输出级别 begin-->
    <!-- 注意： 生产环境下，将此级别配置为适合的级别，以免日志文件太多或影响程序性能 -->
    <root level="INFO">
        <appender-ref ref="FILEERROR" />
        <appender-ref ref="FILEWARN" />
        <appender-ref ref="FILEINFO" />

        <!-- 生产环境将请stdout,testfile去掉 -->
        <appender-ref ref="STDOUT" />
    </root>
    <!-- 日志输出级别 end-->

    <logger name="org.springframework" level="WARN" />
    <!--<logger name="org.hibernate" level="WARN" />-->

    <!--日志异步到数据库 begin-->
    <!--<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">-->
    <!--&lt;!&ndash;日志异步到数据库 &ndash;&gt;-->
    <!--<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">-->
    <!--&lt;!&ndash;连接池 &ndash;&gt;-->
    <!--<dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">-->
    <!--<driverClass>com.mysql.jdbc.Driver</driverClass>-->
    <!--<url>jdbc:mysql://127.0.0.1:3306/databaseName</url>-->
    <!--<user>root</user>-->
    <!--<password>root</password>-->
    <!--</dataSource>-->
    <!--</connectionSource>-->
    <!--</appender>-->
    <!--日志异步到数据库 end-->

</configuration>

报错原因：

Caused by: java.lang.IllegalStateException: Logback configuration error detected:

解决方式：

①：在 rollingPolicy 标签内配置 timeBasedFileNamingAndTriggeringPolicy
②：<fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}-%i.log</fileNamePattern> 中 %i 需要加上。

上一篇：在 MFC项目中会经常用到的知识点小结

下一篇：项目中的vue知识点

【SpringBoot】——SpringBoot详细配置 logback

SpringBoot + Mybatis 增删改查实例教程详细解读

SpringBoot多配置切换的配置方法

springboot 多环境配置教程

SpringBoot使用Druid数据源的配置方法

springboot配置内存数据库H2教程详解

IDEA搭建Springboot+SpringMVC+Mybatis+Mysql（详细、易懂）

SpringBoot配置发送Email的示例代码

springboot配置tomcat配置乱码（配置乱码原因和对应解决法）

springboot介绍项目（springboot自动配置原理）

springboot介绍项目（springboot自动配置原理）