说说在 logback中如何配置日志的控制台输出与文件输出

爱被打了一巴掌 2022-10-08 02:30 521阅读 0赞

通常情况下，日志是由一个抽象层 + 实现层的组合来搭建\[i\]。

![1124ec6eef6866569a9f69f261ce23ab.png][]

spring-boot-starter 其中包含了 spring-boot-starter-logging ，该依赖内容就是 Spring Boot 默认的日志框架 logback，所以实际开发中我们不需要直接添加该依赖\[ii\]。

因为我们需要对日志进行更多控制，所以需要增加 logback配置。

在项目的 resources 文件夹内新建一个名为 logback-spring.xml 文件。logback-spring.xml 只有在Spring应用程序运行的时候才生效，即带有@SpringBootApplication注解的类启动的时候才会生效\[iii\]。

logback-spring.xml配置主要包含 节点，在它之下有四个常用的子节点：root、contextName、property、appender。

![e748b2cb965228c7c83b959af56dae2a.png][]

我们一般先配置 property节点，定义好变量；接着定义控制台和文件的 appender，最后使用 root 来引用之前配置好的 appender。contextName 节点很少使用。

完整配置文件如下：

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration debug="false">
    
     
    
     <property name="LOG_HOME" value="./log"/>
    
     
    
     <appender name="console" 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>
    
     </encoder>
    
     </appender>
    
     
    
     <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
     
    
     <File>${LOG_HOME}/xx/info.log</File>
    
     
    
     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    
     
    
     <FileNamePattern>${LOG_HOME}/xx/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
    
     
    
     <MaxHistory>3000</MaxHistory>
    
     
    
     <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    
     <maxFileSize>10MB</maxFileSize>
    
     </timeBasedFileNamingAndTriggeringPolicy>
    
     </rollingPolicy>
    
     
    
     <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>
    
     </encoder>
    
     </appender>
    
     
    
     <root level="INFO">
    
     <appender-ref ref="console"/>
    
      <appender-ref ref="timeFileOutput"/>
    
     </root>
    
    </configuration>

比较重要的地方是以下几点：

*  设置日志文件所在的根路径LOG\_HOME；
 *  设置日志输出格式pattern，其中 %logger\{50\} 中的 50 表示可以显示的最大字符数；

日志配置项可以根据业务工程要求进行修改，具体说明如下：  
![07ef1541f5686480950353cf2c938b9f.png][]  
当日志文件超过单个文件最大容量时，会进行分割，形如：

![5c8473fb6ca66e1b17db9bed90053ed7.png][]

--------------------

\[i\] [SpringBoot 日记——日志框架篇][SpringBoot]

\[ii\] [springboot 中日志的使用][springboot]

\[iii\] [logback.xml和logback-spring.xml的区别][logback.xml_logback-spring.xml]

[1124ec6eef6866569a9f69f261ce23ab.png]: /images/20221005/ba3509487ecd4074a8e90a23cd0bfc26.png
[e748b2cb965228c7c83b959af56dae2a.png]: /images/20221005/97a761346ca14a6d90b4a87e49cd1d55.png
[07ef1541f5686480950353cf2c938b9f.png]: /images/20221005/fdee7d4f066343849aab235e0ec12ca2.png
[5c8473fb6ca66e1b17db9bed90053ed7.png]: /images/20221005/0c017fce8d514d71958e110b5607a575.png
[SpringBoot]: https://www.cnblogs.com/iceb/p/9209796.html
[springboot]: https://blog.csdn.net/m0_37732829/article/details/94357336
[logback.xml_logback-spring.xml]: https://zhuanlan.zhihu.com/p/336950227