logback logback.xml常用配置详解(一)<configuration> and <logger>

原创文章,转载请指明出处:http://aub.iteye.com/blog/1101260, 尊重他人即尊重自己

详细整理了logback常用配置,

不是官网手册的翻译版,而是使用总结,旨在更快更透彻的理解其配置。

 

logback 配置详解(一)<configuration> and <logger>

 

一:根节点<configuration>包含的属性:

 

scan:

当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。

scanPeriod:

设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。

debug:

当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

例如:

 

Xml代码  收藏代码
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <!-- 其他配置省略-->  
  3. </configuration>  

 

二:根节点<configuration>的子节点:

 

2.1设置上下文名称:<contextName>

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。

 

Xml代码  收藏代码
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <contextName>myAppName</contextName>  
  3.       <!-- 其他配置省略-->  
  4. </configuration>  

 

2.2设置变量: <property>

用来定义变量值的标签,<property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

例如使用<property>定义上下文名称,然后在<contentName>设置logger上下文时使用。

Xml代码  收藏代码
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <property name="APP_Name" value="myAppName" />   
  3.       <contextName>${APP_Name}</contextName>  
  4.       <!-- 其他配置省略-->  
  5. </configuration>   

 

 

2.3获取时间戳字符串:<timestamp>

两个属性 key:标识此<timestamp> 的名字;datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。

        例如将解析配置文件的时间作为上下文名称:

Xml代码  收藏代码
  1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
  2.       <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
  3.       <contextName>${bySecond}</contextName>  
  4.       <!-- 其他配置省略-->  
  5. </configuration>   

 

2.4设置loger:

<loger>

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。

name:

用来指定受此loger约束的某一个包或者具体的某一个类。

level:

用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。

如果未设置此属性,那么当前loger将会继承上级的级别。

addtivity:

是否向上级loger传递打印信息。默认是true。

<loger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。

 

<root>

也是<loger>元素,但是它是根loger。只有一个level属性,应为已经被命名为"root".

level:

用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。

默认是DEBUG。

<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。

 

例如:

LogbackDemo.java类

Java代码  收藏代码
  1. package logback;  
  2.   
  3. import org.slf4j.Logger;  
  4. import org.slf4j.LoggerFactory;  
  5.   
  6. public class LogbackDemo {  
  7.     private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
  8.     public static void main(String[] args) {  
  9.         log.trace("======trace");  
  10.         log.debug("======debug");  
  11.         log.info("======info");  
  12.         log.warn("======warn");  
  13.         log.error("======error");  
  14.     }  
  15. }  

 

logback.xml配置文件

 

第1种:只配置root

Xml代码  收藏代码
  1. <configuration>   
  2.    
  3.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  4.     <!-- encoder 默认配置为PatternLayoutEncoder -->   
  5.     <encoder>   
  6.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  7.     </encoder>   
  8.   </appender>   
  9.    
  10.   <root level="INFO">             
  11.     <appender-ref ref="STDOUT" />   
  12.   </root>     
  13.      
  14.  </configuration>  

 其中appender的配置表示打印到控制台(稍后详细讲解appender );

<root level="INFO">将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。

 

当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

打印结果如下:

Xml代码  收藏代码
  1. 13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  
  2. 13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  
  3. 13:30:38.500 [main] ERROR logback.LogbackDemo - ======error  

 

  第2种:带有loger的配置,不指定级别,不指定appender,

Xml代码  收藏代码
  1. <configuration>   
  2.    
  3.   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  4.     <!-- encoder 默认配置为PatternLayoutEncoder -->   
  5.     <encoder>   
  6.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  7.     </encoder>   
  8.   </appender>   
  9.    
  10.   <!-- logback为java中的包 -->   
  11.   <logger name="logback"/>   
  12.    
  13.   <root level="DEBUG">             
  14.     <appender-ref ref="STDOUT" />   
  15.   </root>     
  16.      
  17.  </configuration>  

 其中appender的配置表示打印到控制台(稍后详细讲解appender );

<logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;

没有设置addtivity,默认为true,将此loger的打印信息向上级传递;

没有设置appender,此loger本身不打印任何信息。

<root level="DEBUG">将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。

 

当执行logback.LogbackDemo类的main方法时,因为LogbackDemo 在包logback中,所以首先执行<logger name="logback" />,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;

root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

打印结果如下:

Xml代码  收藏代码
  1. 13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug  
  2. 13:19:15.406 [main] INFO  logback.LogbackDemo - ======info  
  3. 13:19:15.406 [main] WARN  logback.LogbackDemo - ======warn  
  4. 13:19:15.406 [main] ERROR logback.LogbackDemo - ======error  

 

 第3种:带有多个loger的配置,指定级别,指定appender  

Xml代码  收藏代码
  1. <configuration>   
  2.    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
  3.     <!-- encoder 默认配置为PatternLayoutEncoder -->   
  4.     <encoder>   
  5.       <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
  6.     </encoder>   
  7.   </appender>   
  8.    
  9.   <!-- logback为java中的包 -->   
  10.   <logger name="logback"/>   
  11.   <!--logback.LogbackDemo:类的全路径 -->   
  12.   <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
  13.     <appender-ref ref="STDOUT"/>  
  14.   </logger>   
  15.     
  16.   <root level="ERROR">             
  17.     <appender-ref ref="STDOUT" />   
  18.   </root>     
  19. </configuration>  

其中appender的配置表示打印到控制台(稍后详细讲解appender );

 

<logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;

没有设置addtivity,默认为true,将此loger的打印信息向上级传递;

没有设置appender,此loger本身不打印任何信息。

 

 <logger name="logback.LogbackDemo" level="INFO" additivity="false">控制logback.LogbackDemo类的日志打印,打印级别为“INFO”;

additivity属性为false,表示此loger的打印信息不再向上级传递,

指定了名字为“STDOUT”的appender。

 

<root level="ERROR">将root的打印级别设置为“ERROR”,指定了名字为“STDOUT”的appender。

 

 当执行logback.LogbackDemo类的main方法时,先执行<logger name="logback.LogbackDemo" level="INFO" additivity="false">,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger name="logback"/> 传递打印信息;

<logger name="logback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;

打印结果如下:  

Xml代码  收藏代码
  1. 14:05:35.937 [main] INFO  logback.LogbackDemo - ======info  
  2. 14:05:35.937 [main] WARN  logback.LogbackDemo - ======warn  
  3. 14:05:35.937 [main] ERROR logback.LogbackDemo - ======error  

 如果将<logger name="logback.LogbackDemo" level="INFO" additivity="false">修改为 <logger name="logback.LogbackDemo" level="INFO" additivity="true">那打印结果将是什么呢?

没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次

打印结果如下:  

Xml代码  收藏代码
  1. 14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
  2. 14:09:01.531 [main] INFO  logback.LogbackDemo - ======info  
  3. 14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
  4. 14:09:01.531 [main] WARN  logback.LogbackDemo - ======warn  
  5. 14:09:01.531 [main] ERROR logback.LogbackDemo - ======error  
  6. 14:09:01.531 [main] ERROR logback.LogbackDemo - ======error 
<think>好的,我现在需要帮助用户配置LogbackXML配置文件,并解释结构和参数。用户之前遇到的问题是Logback配置错误导致日志系统初始化失败,特别是在Mac上使用Spring Boot时路径问题。现在用户明确想了解配置文件的结构和参数,需要示例和说明。 首先,回顾之前的解决方案,用户可能已经按照步骤创建了logback-spring.xml,排除了依赖冲突,并设置了环境变量。现在用户希望更深入地理解配置文件的各个部分,以便自己进行调整和优化。 根据用户提供的引用内容,引用1和2提到Logback的高性能、灵活配置,基本结构。引用3指出logback-spring.xmllogback.xml的区别,特别是Spring Profile的支持。引用4解释了appender、logger、root的关系以及日志级别传递机制。需要整合这些信息,形成结构化的回答。 用户需要XML示例和参数说明,因此应该分模块讲解,如基本结构、appender、encoder、logger、root、Spring Profile等。每个部分给出示例代码,并详细解释参数的作用。同时,需要强调logback-spring.xml的优势,比如支持Spring Profile,而普通的logback.xml由日志框架直接加载。 此外,用户之前的问题涉及路径错误,因此在示例中应强调路径的正确写法,特别是Mac使用正斜杠,避免反斜杠。还要提到属性定义和变量替换,比如${LOG_PATH},以及如何通过环境变量设置。 需要确保回答符合系统级指令:行内公式用$...$,独立公式用$$...$$,但Logback配置中可能用不到数学公式,所以可能不需要处理这点。使用中文回答,结构清晰,分步骤说明,最后生成相关问题。 还需要检查是否有依赖冲突的部分是否需要再次提及,但用户当前问题更关注配置结构,可能不需要深入讨论依赖,除非影响配置加载。但引用3提到logback-spring.xml由Spring Boot解析,可能需要强调配置文件名称的重要性。 最后,生成相关问题,比如如何按环境配置、日志级别控制、滚动策略等,这些与用户当前问题相关,帮助用户进步学习。</think>### Logback XML配置文件详解(附示例) #### 、基本结构框架 ```xml <?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="30 seconds"> <!-- 属性定义 --> <property name="LOG_DIR" value="./logs" /> <!-- 输出源定义 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 日志记录器配置 --> <logger name="com.example" level="DEBUG" /> <!-- 根记录器配置 --> <root level="INFO"> <appender-ref ref="CONSOLE" /> </root> </configuration> ``` #### 二、核心参数说明 1. **`<configuration>` 根标签** - `scan="true"`:开启配置文件热更新(生产环境建议关闭)[^3] - `scanPeriod="30 seconds"`:检查配置文件变更的间隔 - `debug="true"`:输出Logback内部调试信息(排查问题时启用) 2. **`<property>` 属性定义** ```xml <property name="LOG_DIR" value="${LOG_PATH:-/tmp/logs}" /> ``` - 支持系统环境变量覆盖:`${ENV_VAR:-默认值}` 语法 - 示例中优先使用`LOG_PATH`环境变量,未定义时使用`/tmp/logs` 3. **`<appender>` 输出源配置** **控制台输出示例**: ```xml <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <target>System.err</target> <!-- 可选System.out/System.err --> <encoder> <pattern>%boldYellow([%thread]) %msg%n</pattern> </encoder> </appender> ``` **文件输出示例**: ```xml <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>${LOG_DIR}/app.log</file> <append>true</append> <!-- true=追加模式,false=覆盖模式 --> <encoder> <pattern>%d{ISO8601} %-5level [%logger{36}] - %msg%n</pattern> </encoder> </appender> ``` 4. **`<encoder>` 格式化参数** | 符号 | 说明 | 示例输出 | |------|-----------------------------|-----------------------| | `%d` | 日期时间 | 2024-03-15 14:30:00 | | `%thread` | 线程名 | main | | `%-5level` | 左对齐5字符的日志级别 | INFO | | `%logger{36}` | 缩短包名显示长度(最多36字符)| c.e.s.ServiceImpl | | `%msg` | 日志消息内容 | User login success | | `%n` | 换行符 | (不可见) | 5. **`<logger>` 与 `<root>` 层级关系** ```xml <logger name="com.example.dao" level="DEBUG" additivity="false"> <appender-ref ref="FILE" /> </logger> <root level="WARN"> <appender-ref ref="CONSOLE" /> </root> ``` - `additivity="false"`:禁止向上级传递日志事件[^4] - 日志级别优先级:`TRACE < DEBUG < INFO < WARN < ERROR` 6. **Spring Boot专属配置** ```xml <springProfile name="dev"> <root level="DEBUG"/> </springProfile> <springProperty scope="context" name="APP_NAME" source="spring.application.name"/> ``` - 使用`logback-spring.xml`时支持的特性[^3] - 可通过`springProfile`实现环境隔离配置 --- ### 完整配置示例(支持多环境) ```xml <?xml version="1.0" encoding="UTF-8"?> <configuration> <property name="LOG_DIR" value="${LOG_PATH:-./logs}" /> <property name="MAX_HISTORY" value="30" /> <!-- 开发环境控制台彩色输出 --> <springProfile name="dev"> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%-5level) %clr([%15.15thread]){cyan} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %msg%n</pattern> </encoder> </appender> </springProfile> <!-- 生产环境滚动日志 --> <springProfile name="prod"> <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_DIR}/app.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_DIR}/app.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern> <maxHistory>${MAX_HISTORY}</maxHistory> </rollingPolicy> <encoder> <pattern>%d{ISO8601} | %-5level | %logger{36} | %msg%n</pattern> </encoder> </appender> </springProfile> <root level="info"> <springProfile name="dev"> <appender-ref ref="CONSOLE" /> </springProfile> <springProfile name="prod"> <appender-ref ref="ROLLING_FILE" /> </springProfile> </root> </configuration> ``` --- ### 关键注意事项 1. **文件路径规范**(Mac系统特别关注) ```xml <!-- 正确写法 --> <file>${user.home}/logs/app.log</file> <!-- 错误写法 --> <file>C:\logs\app.log</file> <!-- Windows路径在Mac上会报错 --> ``` 2. **日志级别继承规则** ```mermaid graph TD Root[ROOT: INFO] --> A[com.example: DEBUG] A --> B[com.example.dao: TRACE] B --> C[com.example.dao.UserDAO: WARN] ``` - 子Logger未设置级别时继承父级配置 - 示例中`UserDAO`最终生效级别为WARN 3. **配置加载优先级**(Spring Boot项目) ```text 1. logback-spring.xml(推荐) 2. logback.groovy 3. logback.xml ``` --- ### 相关问题 1. **如何实现日志文件按大小和时间滚动?** 使用`SizeAndTimeBasedRollingPolicy`: ```xml <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> <fileNamePattern>${LOG_DIR}/app.%d{yyyy-MM-dd}.%i.log</fileNamePattern> <maxFileSize>100MB</maxFileSize> <maxHistory>60</maxHistory> <totalSizeCap>20GB</totalSizeCap> </rollingPolicy> ``` 2. **如何过滤特定包的日志?** 使用`<filter>`标签: ```xml <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>WARN</level> </filter> </appender> ``` 3. **为什么自定义logger没有生效?** 检查顺序问题:logger定义需在root之前,且确保`additivity`属性设置正确[^4]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值