logback的使用和原理

logback的使用和原理

1 依赖关系

在pom文件中引入springboot starter依赖，自动引入了这三个依赖，而这三个依赖，就是logback日志框架进行日志操作的。

1.     <dependencies>
2.         <dependency>
3.             <groupId>org.springframework.boot</groupId>
4.             <artifactId>spring-boot-starter</artifactId>
5.         </dependency>
6.     </dependencies>

复制代码

可以看到，logback-classic依赖于logback-core和slf4j-api。
2 执行流程

当我们在一个类中，使用 LoggerFactory.getLogger(xxx.class) 获取一个类的 Logger 对象时，发生了什么事，是在什么时候加载的logback.xml文件中的配置的，这是本文要解决的问题。

1. package org.example;
3. import org.slf4j.Logger;
4. import org.slf4j.LoggerFactory;
5. import java.util.Date;
6. import java.util.UUID;
8. public class LogPathOnLinuxApp
9. {
10.     private static final Logger logger =  LoggerFactory.getLogger(LogPathOnLinuxApp.class);
11.     public static void main(String[] args) {
12.         logger.info(new Date().toString() + "生成了 UUID: " + UUID.randomUUID());
13.     }
14. }

复制代码

单独的 T 代表一个类型 ，而 Class代表这个类型所对应的类， Class表示类型不确定的类，Class表示类型不确定的类是A的子类

常见的调用方式，使用 LoggerFactory.getLogger(LogPathOnLinuxApp.class) 获取 Logger 对象，然后使用 logger.info() 使用日志框架，输出日志信息。
首先，从 LoggerFactory.getLogger入手，他位于 org.slf4j 包中
LoggerFactory 类中，

1. // 1.1 使用时传入的class对象，调用的是这个方法
2. public static Logger getLogger(Class<?> clazz) {
3.         // 1.2 调用上面的方法，传入一个String类型的class的名字，返回一个Logger对象，这个就是最终返回的Logger对象，ctrl+鼠标左键，点进去
4.         Logger logger = getLogger(clazz.getName());
5.         if (DETECT_LOGGER_NAME_MISMATCH) {
6.             Class<?> autoComputedCallingClass = Util.getCallingClass();
7.             if (autoComputedCallingClass != null && nonMatchingClasses(clazz, autoComputedCallingClass)) {
8.                 Util.report(String.format("Detected logger name mismatch. Given name: "%s"; computed name: "%s".", logger.getName(), autoComputedCallingClass.getName()));
9.                 Util.report("See http://www.slf4j.org/codes.html#loggerNameMismatch for an explanation");
10.             }
11.         }
12.                 // 最终返回给调用者的logger
13.         return logger;
14.     }
16. // 1.2
17. public static Logger getLogger(String name) {
18.             // 1.3 调用getILoggerFactory方法，返回一个ILoggerFactory对象，点进去
19.         ILoggerFactory iLoggerFactory = getILoggerFactory();
20.             // 最终返回iLoggerFactory.getLogger(name)的Logger对象
21.         return iLoggerFactory.getLogger(name);
22.     }
25. // 这是类中的静态变量，在类加载的时候初始化
26. static final int UNINITIALIZED = 0; // 未初始化
27. static final int ONGOING_INITIALIZATION = 1; // 正在初始化
28. static final int FAILED_INITIALIZATION = 2; // 初始化失败
29. static final int SUCCESSFUL_INITIALIZATION = 3; // 初始化成功
30. static final int NOP_FALLBACK_INITIALIZATION = 4; // 无回退初始化
31. static volatile int INITIALIZATION_STATE = 0; // 初始化状态
33. // 1.3
34. public static ILoggerFactory getILoggerFactory() {
35.             // 如果未初始化，就进行初始化操作
36.         if (INITIALIZATION_STATE == 0) {
37.             Class var0 = LoggerFactory.class;
38.             // 对LoggerFactory类加锁
39.             synchronized(LoggerFactory.class) {
40.                 // 如果未初始化，将状态设置为正在初始化，执行performInitialization()
41.                 if (INITIALIZATION_STATE == 0) {
42.                     INITIALIZATION_STATE = 1;
43.                     // 执行初始化
44.                     performInitialization();
45.                 }
46.             }
47.         }
48.                 // 判断初始化状态
49.         switch (INITIALIZATION_STATE) {
50.             case 1:
51.                 return SUBST_FACTORY;
52.             case 2:
53.                 throw new IllegalStateException("org.slf4j.LoggerFactory in failed state. Original exception was thrown EARLIER. See also http://www.slf4j.org/codes.html#unsuccessfulInit");
54.             // 如果初始化成功，返回 StaticLoggerBinder.getSingleton().getLoggerFactory();
55.             case 3:
56.                 // 1.4 看这个方法 getLoggerFactory
57.                 return StaticLoggerBinder.getSingleton().getLoggerFactory();
58.             case 4:
59.                 return NOP_FALLBACK_FACTORY;
60.             default:
61.                 throw new IllegalStateException("Unreachable code");
62.         }
63.     }

复制代码

StaticLoggerBinder 类中，

1. private static StaticLoggerBinder SINGLETON = new StaticLoggerBinder();
2. private LoggerContext defaultLoggerContext = new LoggerContext();
3. static {
4.         SINGLETON.init();
5.     }
6. void init() {
7.         try {
8.             try {
9.                 // 自动配置，autoConfig 点进去
10.                 (new ContextInitializer(this.defaultLoggerContext)).autoConfig();
11.             } catch (JoranException var2) {
12.                 Util.report("Failed to auto configure default logger context", var2);
13.             }
15.             if (!StatusUtil.contextHasStatusListener(this.defaultLoggerContext)) {
16.                 StatusPrinter.printInCaseOfErrorsOrWarnings(this.defaultLoggerContext);
17.             }
19.             this.contextSelectorBinder.init(this.defaultLoggerContext, KEY);
20.             this.initialized = true;
21.         } catch (Exception var3) {
22.             Util.report("Failed to instantiate [" + LoggerContext.class.getName() + "]", var3);
23.         }
25.     }

复制代码

ContextInitializer 类中，

1. // 此处的静态常量，表示的是logback的配置文件名
2. public static final String AUTOCONFIG_FILE = "logback.xml";
3. public static final String TEST_AUTOCONFIG_FILE = "logback-test.xml";
4. public static final String CONFIG_FILE_PROPERTY = "logback.configurationFile";
5. final LoggerContext loggerContext;
7. //
8. public void autoConfig() throws JoranException {
9.         StatusListenerConfigHelper.installIfAsked(this.loggerContext);
10.             // 没有任何配置文件时url为null
11.         URL url = this.findURLOfDefaultConfigurationFile(true);
12.         if (url != null) {
13.             // 读取自定义的配置文件，logback.xml文件配置生效
14.             this.configureByResource(url);
15.         } else {
16.             Configurator c = (Configurator)EnvUtil.loadFromServiceLoader(Configurator.class);
17.             if (c != null) {
18.                 try {
19.                     c.setContext(this.loggerContext);
20.                     c.configure(this.loggerContext);
21.                 } catch (Exception var4) {
22.                     throw new LogbackException(String.format("Failed to initialize Configurator: %s using ServiceLoader", c != null ? c.getClass().getCanonicalName() : "null"), var4);
23.                 }
24.             } else {
25.                 // 这一段代码保证了，没有任何配置文件时，也可以进行基础的自动配置，进行日志输出
26.                 BasicConfigurator basicConfigurator = new BasicConfigurator();
27.                 basicConfigurator.setContext(this.loggerContext);
28.                 basicConfigurator.configure(this.loggerContext);
29.             }
30.         }
32.     }

复制代码

3 日志滚动配置

需要注意在linux下执行的路径问题

1. <configuration>
2.    
3.        
4.    
5.         <contextListener  />
6.     <appender name="dailyRollingFileAppender" >
7.         <File>${LOG_PATH}/${PROJECT_NAME}/logs/LogsPathTest.log</File>
8.         <rollingPolicy >
9.             
10.             <FileNamePattern>${LOG_PATH}/${PROJECT_NAME}/logs/LogsPathTest.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
11.             
12.             <MaxHistory>15</MaxHistory>
13.             
14.             <MaxFileSize>2MB</MaxFileSize>
15.         </rollingPolicy>
16.         <encoder>
17.             <Pattern>%date{yyyy-MM-dd HH:mm:ss}\t%level\t%logger{96}\t%msg%n</Pattern>
18.         </encoder>
19.         <filter >
20.             <level>INFO</level>
21.         </filter>
22.     </appender>
25.    
26.     <appender name="STDOUT" >
27.         
28.         <encoder>
29.             <Pattern>%date{yyyy-MM-dd HH:mm:ss}\t%level\t%logger{96}\t%msg%n</Pattern>
30.         </encoder>
31.         <filter >
32.             <level>INFO</level>
33.         </filter>
34.     </appender>
36.     <root level="INFO">
37.         <appender-ref ref="dailyRollingFileAppender"/>
38.         <appender-ref ref="STDOUT"/>
39.     </root>
41. </configuration>

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！