利用 Logback 的最佳实践：`logback.xml` 与 `logback-spring.xml` 的区别 ...

在开发 Spring Boot 项目时，日志是调试和监控的重要工具。Spring Boot 默认支持 Logback 作为日志系统，并提供了 logback.xml 和 logback-spring.xml 两种配置方式。这篇文章将详细介绍这两者的区别、各自的优缺点以及最佳实践。

---

目录

• 
  
  
  
  • 
    
    
    
    • 一、什么是 Logback？为什么选择它？
      
    • 二、`logback.xml` 与 `logback-spring.xml` 有什么区别？
      
    • 
      
      
      
      • 1. Spring Boot 集成支持
        
      • 2. 属性注入支持
        
      • 3. `` 标签支持
        
      • 4. 主动重启与热加载支持
        
      • 5. 加载优先级
        
      
      
    • 三、什么时候利用 `logback-spring.xml` 或 `logback.xml`
      
    • 
      
      
      
      • 利用 `logback-spring.xml` 的场景
        
      • 利用 `logback.xml` 的场景
        
      
      
    • 四、最佳实践：如何利用 `logback-spring.xml` 设置多环境日志路径
      
    • 
      
      
      
      • 1. 在 `application.yml` 中定义日志路径
        
      • 2. 在 `logback-spring.xml` 中利用日志路径
        
      • 3. 启动不同环境
        
      
      
    • 五、总结
      
    
    
  
  

一、什么是 Logback？为什么选择它？

Logback 是 Java 应用的流行日志框架，以其高性能和丰富的功能在企业级项目中广泛应用。Logback 主要支持控制台和文件日志输出，支持文件滚动（按时间或巨细分割日志），并支持自定义日志格式，帮助开发者有效记录和管理日志。

---

二、logback.xml 与 logback-spring.xml 有什么区别？

在 Spring Boot 项目中，可以利用 logback.xml 或 logback-spring.xml 文件来配置日志输出。但这两者固然都属于 Logback 配置文件，却有不同的用法和特性：
1. Spring Boot 集成支持

• logback-spring.xml 是专门为 Spring Boot 提供的日志配置文件，允许利用 Spring Boot 特有的功能，比如 Spring 配置的属性注入、基于 Profile 的配置切换等。
  
• logback.xml 是标准的 Logback 配置文件，缺少 Spring Boot 特有的集成支持功能，不能直接读取 Spring 配置中的属性。
  

2. 属性注入支持

• logback-spring.xml 支持通过 Spring 的 ${} 占位符引入 application.yml 或 application.properties 中定义的属性。比方，日志文件的存储路径可以直接在 logback-spring.xml 中通过 Spring 配置读取：
  
  1. # application.yml
  2. logging:
  3.   path: /var/log/myapp
  6. <!-- logback-spring.xml -->
  7. <property name="log.path" value="${logging.path}" />

  复制代码
• logback.xml 不支持 Spring 的 ${} 占位符，也无法直接读取 Spring 配置文件中的属性，因此需要手动设置日志路径等参数。
  

3. <springProfile> 标签支持

• logback-spring.xml 支持利用 <springProfile> 标签，根据不同的 Spring Profile（如 dev、prod）动态加载不同的日志配置，方便管理多环境日志。比方：
  
  1. <springProfile name="dev">
  2.     <property name="log.path" value="/dev/logs" />
  3. </springProfile>
  5. <springProfile name="prod">
  6.     <property name="log.path" value="/prod/logs" />
  7. </springProfile>

  复制代码
• logback.xml 不支持 <springProfile> 标签，无法实现基于 Profile 的日志配置切换。
  

4. 主动重启与热加载支持

• logback-spring.xml 支持 Spring Boot DevTools 的热加载，当修改 logback-spring.xml 文件时，Spring Boot 可以主动重启并应用新的日志配置。
  
• logback.xml 固然也支持热加载，但主要依靠 Logback 自身的配置文件监控，Spring Boot 的 DevTools 热加载不会生效。
  

5. 加载优先级

• logback-spring.xml 在 Spring Boot 启动时优先加载。Spring Boot 会首先检测 logback-spring.xml，如果存在，则优先利用它作为日志配置文件。
  
• logback.xml 作为标准配置文件，如果项目中没有 logback-spring.xml，Spring Boot 才会加载 logback.xml。
  

---

三、什么时候利用 logback-spring.xml 或 logback.xml

利用 logback-spring.xml 的场景

• 需要读取 Spring 配置：如果需要从 application.yml 或 application.properties 文件中读取日志配置，比如日志文件路径或日志级别，推荐利用 logback-spring.xml。
  
• 需要按环境配置日志：利用 <springProfile> 标签可以让不同环境（开发、测试、生产）加载不同的日志配置，得当多环境摆设的项目。
  
• 需要主动重启和热加载：在开发中，logback-spring.xml 可以支持 Spring Boot DevTools 的热加载功能，修改后立刻生效，提高开发效率。
  

利用 logback.xml 的场景

• 标准的 Logback 项目：如果项目不是基于 Spring Boot 大概希望利用标准的 Logback 配置文件，利用 logback.xml 即可。
  
• 简朴的日志配置：如果没有多环境需求，或不需要从 Spring 配置中读取属性，logback.xml 充足满意根本的日志需求。
  

---

四、最佳实践：如何利用 logback-spring.xml 设置多环境日志路径

以下是通过 logback-spring.xml 配合 application.yml 设置多环境日志路径的示例：
1. 在 application.yml 中定义日志路径

1. # application.yml
2. spring:
3.   profiles:
4.     active: dev
5.   logging:
6.     path: /default/logs  # 默认路径
8. ---
10. # application-dev.yml
11. logging:
12.   path: /dev/logs
14. ---
16. # application-prod.yml
17. logging:
18.   path: /prod/logs

复制代码

2. 在 logback-spring.xml 中利用日志路径

1. <!-- logback-spring.xml -->
2. <configuration>
3.     <!-- 读取 Spring 配置文件中的日志路径 -->
4.     <property name="log.path" value="${logging.path}" />
6.     <!-- 控制台输出 -->
7.     <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
8.         <encoder>
9.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
10.         </encoder>
11.     </appender>
13.     <!-- 文件输出 -->
14.     <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
15.         <file>${log.path}/sys-info.log</file>
16.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
17.             <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
18.             <maxHistory>30</maxHistory>
19.         </rollingPolicy>
20.         <encoder>
21.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
22.         </encoder>
23.     </appender>
25.     <root level="info">
26.         <appender-ref ref="console" />
27.         <appender-ref ref="file_info" />
28.     </root>
29. </configuration>

复制代码

3. 启动不同环境

利用 spring.profiles.active 参数来切换日志路径：

• 开发环境启动：
  
  1. java -Dspring.profiles.active=dev -jar your-app.jar

  复制代码
• 生产环境启动：
  
  1. java -Dspring.profiles.active=prod -jar your-app.jar

  复制代码

---

五、总结

• logback-spring.xml 是 Spring Boot 项目中的最佳选择，支持 Spring 配置读取、基于环境的配置切换、热加载等功能，得当多环境摆设的项目。
  
• logback.xml 适用于标准的 Logback 项目，配置更为通用，但缺少 Spring Boot 的一些特性支持。
  
• 通过结合 application.yml 与 logback-spring.xml，可以根据环境设置不同的日志路径，便于日志管理和题目排查。
  

希望通过这篇文章，你能更好地明白和运用 Logback，提升日志管理效率。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。