日誌框架 開發一個大型系統的簡易步驟: 寫一個統一的介面層: 日誌門面,(日誌的一個抽象層) 給項目導入具體的日誌實現,之前的框架都是實現的抽象層 主流的日誌框架 JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j.... 日誌門面(日誌的抽象層): J ...
日誌框架
開發一個大型系統的簡易步驟:
- system.out.println("..") 將關鍵的數據在控制台輸出
- 框架記錄系統的一些運行時的信息,---日誌框架。
- 牛逼的功能---非同步模式,自動歸檔等等。。。
- 進一步發展,卸掉舊得框架,並且修改之前的API,
- JDBC 資料庫驅動,JDC 資料庫驅動:
寫一個統一的介面層: 日誌門面,(日誌的一個抽象層)
給項目導入具體的日誌實現,之前的框架都是實現的抽象層
主流的日誌框架
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....
日誌門面(日誌的抽象層):
Springboot :底層是Spring框架,Spring 預設框架是JCL,
SLF4J使用
1 ,如何在 系統中使用SLF4J https://www.slf4j.org
在開發的時候,日誌的記錄方法的調用,不應該直接調用日誌的實現類,而是調用日誌抽象成裡面的方法。
給系統導入slf4j 的jar ,和logback 的jar
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class HelloWorld { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(HelloWorld.class); logger.info("Hello World"); } }
每一個日誌的實現框架都有自己的配置文件,使用slf4j 之後 ,配置文件還是做成日誌實現框架自己的本身的配置文件。
遺留問題:
開發的時候,
A 系統: 可能會用到 (slf4j+logback): Spring(commons-logging預設)、Hibernate(預設:jboss-logging)、MyBatis、xxxx
如何統一 日誌記錄? 即使用別的框架,也統一使用 slf4j 進行輸出
slf4j 日誌適配圖
如何實現系統所有日誌統一到slf4j :
- 將系統中所有的其他日誌框架先排除出去
- 用中間包來替換原有的日誌框架
- 導入slf4j 的其他實現jar
springboot的日誌關係
如果使用IDEA ,那麼idea 有個很好的工具可以讓我們可視化的查看依賴關係,在pom.xml 中右鍵選擇diagrams ---show dependencies 就可以查看
啟動器:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency>
springboot 使用的日誌功能組件:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </dependency>
底層依賴關係:
歸納:
@SuppressWarnings("rawtypes") public abstract class LogFactory { static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j"; static LogFactory logFactory = new SLF4JLogFactory();
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <exclusions> <exclusion> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> </exclusion> </exclusions> </dependency>
SpringBoot能自動適配所有的日誌,而且底層使用slf4j+logback的方式記錄日誌,引入其他框架的時候,只需要把這個框架依賴的日誌框架排除掉即可
SringBoot預設配置
SpringBoot預設幫我們配置好了日誌;
//記錄器 Logger logger = LoggerFactory.getLogger(getClass()); @Test public void contextLoads() { //System.out.println(); //日誌的級別; //由低到高 trace<debug<info<warn<error //可以調整輸出的日誌級別;日誌就只會在這個級別以以後的高級別生效 logger.trace("這是trace日誌..."); logger.debug("這是debug日誌..."); //SpringBoot預設給我們使用的是info級別的,沒有指定級別的就用SpringBoot預設規定的級別;root級別 logger.info("這是info日誌..."); logger.warn("這是warn日誌..."); logger.error("這是error日誌..."); }
日誌輸出格式: %d表示日期時間, %thread表示線程名, %-5level:級別從左顯示5個字元寬度 %logger{50} 表示logger名字最長50個字元,否則按照句點分割。 %msg:日誌消息, %n是換行符 --> %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
SpringBoot修改日誌的預設配置
#設置日誌的預設輸出級別
logging.level.com.atguigu=trace #logging.path= # 不指定路徑在當前項目下生成springboot.log日誌 # 可以指定完整的路徑; #logging.file=G:/springboot.log # 在當前磁碟的根路徑下創建spring文件夾和裡面的log文件夾;使用 spring.log 作為預設文件 logging.path=/spring/log # 在控制台輸出的日誌的格式 logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n # 指定文件中日誌輸出的格式 logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
logging.path | Example | Description | |
---|---|---|---|
(none) | (none) | 只在控制台輸出 | |
指定文件名 | (none) | my.log | 輸出日誌到my.log文件 |
(none) | 指定目錄 | /var/log | 輸出到指定目錄的 spring.log 文件中 |
指定配置:
給類路徑下放上每個日誌框架自己的配置文件即可,Springboot就不使用預設配置的了
Logging System | Customization |
---|---|
Logback | logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy |
Log4j2 | log4j2-spring.xml or log4j2.xml |
JDK (Java Util Logging) |
logback.xml : 會直接被日誌框架識別。
logback-spring.xml : 日誌框架就不直接識別載入日誌的配置項,由springboot解析日誌配置,可以使用SpringBoot的高級profile 功能。
<springProfile name="staging"> <!-- configuration to be enabled when the "staging" profile is active --> 可以指定某段配置只在某個環境下生效 </springProfile>
比如:
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <!-- 日誌輸出格式: %d表示日期時間, %thread表示線程名, %-5level:級別從左顯示5個字元寬度 %logger{50} 表示logger名字最長50個字元,否則按照句點分割。 %msg:日誌消息, %n是換行符 --> <layout class="ch.qos.logback.classic.PatternLayout"> <springProfile name="dev"> <!-- 設置不同環境的日誌列印方式 --> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern> </springProfile> <springProfile name="!dev"> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern> </springProfile> </layout> </appender>
如果使用logback.xml 作為配置文件,還要使用profile 功能會報 no applicable action for [springProfile] 的錯誤
日誌框架的切換
可以按照上面的 slf4j 的日誌適配圖,進行相關的切換:
slf4j + log4j 的方式:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <artifactId>logback-classic</artifactId> <groupId>ch.qos.logback</groupId> </exclusion> <exclusion> <artifactId>log4j-over-slf4j</artifactId> <groupId>org.slf4j</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> </dependency>
切換為log4j2 :
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <artifactId>spring-boot-starter-logging</artifactId> <groupId>org.springframework.boot</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency>