日誌管理-log4j與slf4j的使用
一、概述
1、log4j:
Log4j是Apache的一個開源專案,通過使用Log4j,我們可以控制日誌資訊輸送的目的地是控制檯、檔案、GUI元件,甚至是套介面伺服器、NT的事件記錄器、UNIX Syslog守護程序等;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌資訊的級別,我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是,這些可以通過一個配置檔案來靈活地進行配置,而不需要修改應用的程式碼。
2、slf4j:
SLF4J,即簡單日誌門面(Simple Logging Facade for Java),不是具體的日誌解決方案,它只服務於各種各樣的日誌系統。按照官方的說法,SLF4J是一個用於日誌系統的簡單Facade,允許終端使用者在部署其應用時使用其所希望的日誌系統。實際上,SLF4J所提供的核心API是一些介面以及一個LoggerFactory的工廠類。從某種程度上,SLF4J有點類似JDBC,不過比JDBC更簡單,在JDBC中,你需要指定驅動程式,而在使用SLF4J的時候,不需要在程式碼中或配置檔案中指定你打算使用那個具體的日誌系統。如同使用JDBC基本不用考慮具體資料庫一樣,SLF4J提供了統一的記錄日誌的介面,只要按照其提供的方法記錄即可,最終日誌的格式、記錄級別、輸出方式等通過具體日誌系統的配置來實現,因此可以在應用中靈活切換日誌系統。
二、實踐
1、匯入對應的jar包,推薦使用maven工程匯入。
a、使用傳統jar的方式引入
b、使用maven工程匯入
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.turtle</groupId> <artifactId>log</artifactId> <version>1.0-SNAPSHOT</version> <name>log</name> <!-- FIXME change it to the project's website --> <url>http://www.example.com</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.11</version> <scope>test</scope> </dependency> <!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency> <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.25</version> </dependency> </dependencies> </project>
2、編寫測試程式碼:
package com.turtle.log; import com.turtle.OutputStreamUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.text.SimpleDateFormat; import java.util.Date; public class TestLog_01 { private final static Logger logger = LoggerFactory.getLogger(TestLog_01.class); public static void main(String[] args) { logger.info("programer processing......"); try{ // 會產生除以0的異常資訊 System.out.println(1/0); }catch (Exception e){ // 將異常資訊列印到日誌檔案中去 String exception = new OutputStreamUtil().util(e); // 輸出日誌檔案 logger.error("Programer error:"+ exception+"\t"+"【"+new SimpleDateFormat("yyyy-MM-dd/HH.mm.ss").format(new Date())+"】"); } logger.debug("start Debug detail......"); } }
3、配置檔案
### set log levels ### |
三、詳細解釋
1、og4j定義了8個級別的log(除去OFF和ALL,可以說分為6個級別)
優先順序從高到低依次為:OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。
- ALL LEVEL 最低等級的,用於開啟所有日誌記錄。
- TRACE 很低的日誌級別,一般不會使用。
- DEBUG 指出細粒度資訊事件對除錯應用程式是非常有幫助的,主要用於開發過程中列印一些執行資訊。
- INFO 訊息在粗粒度級別上突出強調應用程式的執行過程。列印一些你感興趣的或者重要的資訊,這個可以用於生產環境中輸出程式執行的一些重要資訊,但是不能濫用,避免列印過多的日誌。
- WARN 表明會出現潛在錯誤的情形,有些資訊不是錯誤資訊,但是也要給程式設計師的一些提示。
- ERROR 指出雖然發生錯誤事件,但仍然不影響系統的繼續執行。列印錯誤和異常資訊,如果不想輸出太多的日誌,可以使用這個級別。
- FATAL 指出每個嚴重的錯誤事件將會導致應用程式的退出。這個級別比較高了。重大錯誤,這種級別你可以直接停止程式了。
- OFF LEVEL 最高等級的,用於關閉所有日誌記錄。
如果將log level設定在某一個級別上,那麼比此級別優先順序高的log都能打印出來。例如,如果設定優先順序為WARN,那麼OFF、FATAL、ERROR、WARN 4個級別的log能正常輸出,而INFO、DEBUG、TRACE、 ALL級別的log則會被忽略。Log4j建議只使用四個級別,優先順序從高到低分別是ERROR、WARN、INFO、DEBUG。
2、rootLogger = DEBUG,stdout,D,E #配置根logger,
基本格式為 log4j.rootLogger = LEVEL, appenderName1 , appenderName2 ,只能有一個等級的哦,不能存在多個等級,否則會報錯
3、log4j.appender.stdout=org.apache.log4j.ConsoleAppender #配置日誌資訊輸出目的地Appender
- org.apache.log4j.ConsoleAppender(控制檯)
- org.apache.log4j.FileAppender(檔案)
- org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌檔案)
- org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案)
- org.apache.log4j.WriterAppender(將日誌資訊以流格式傳送到任意指定的地方)
4、Target , File 分別就是輸出目的地的目標、檔名啦。此處可將相應的內容寫到相應的目的地及檔案中.
5、Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
6、Threshold=DEBUG:指定日誌訊息的輸出最低層次。
應當注意每個appender的級別應該是不同的,比如error類的單獨放到一個檔案中,更方便我們排除錯誤,所以推薦對不同級別的日誌輸出到不同的日誌檔案中。
7、當選擇RollingFileAppender時,MaxFileSize=100KB
字尾可以是KB, MB 或者是 GB. 在日誌檔案到達該大小時,將會自動滾動,即將原來的內容移到mylog.log.1檔案。MaxBackupIndex=2:指定可以產生的滾動檔案的最大數。
8、log4j.appender.stdout.layout=org.apache.log4j.PatternLayout # 定義名為stdout的輸出端的layout型別
- org.apache.log4j.HTMLLayout(以HTML表格形式佈局)
- org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)
- org.apache.log4j.SimpleLayout(包含日誌資訊的級別和資訊字串)
- org.apache.log4j.TTCCLayout(包含日誌產生的時間、執行緒、類別等等資訊)
9、log4j.appender.stdout.layout.ConversionPattern= [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n
如果使用pattern佈局就要指定的列印資訊的具體格式ConversionPattern,列印引數如下:
- %p: 輸出日誌資訊優先順序,即DEBUG,INFO,WARN,ERROR,FATAL,
- %r: 輸出自應用啟動到輸出該log資訊耗費的毫秒數
- %c: 輸出日誌資訊所屬的類目,通常就是所在類的全名
- %t: 輸出產生該日誌事件的執行緒名
- %l: 輸出日誌事件的發生位置,相當於%C.%M(%F:%L)的組合,包括類目名、發生的執行緒,以及在程式碼中的行數。舉例:Testlog4.main (TestLog4.Java:10)
- %x: 輸出和當前執行緒相關聯的NDC(巢狀診斷環境),尤其用到像Java servlets這樣的多客戶多執行緒的應用中。
- %%: 輸出一個"%"字元
- %F: 輸出日誌訊息產生時所在的檔名稱
- %L: 輸出程式碼中的行號
- %m: 輸出程式碼中指定的訊息,產生的日誌具體資訊 (注意下文log的使用時傳入的引數)
- %n: 輸出一個回車換行符,Windows平臺為"/r/n",Unix平臺為"/n"輸出日誌資訊換行
- %d: 輸出日誌時間點的日期或時間,預設格式為ISO8601,也可以在其後指定格式
可以在%與模式字元之間加上修飾符來控制其最小寬度、最大寬度、和文字的對齊方式。如:
- %20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,預設的情況下右對齊。
- %-20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,"-"號指定左對齊。
- %.30c:指定輸出category的名稱,最大的寬度是30,如果category的名稱大於30的話,就會將左邊多出的字元截掉,但小於30的話也不會有空格。
- %20.30c:如果category的名稱小於20就補空格,並且右對齊,如果其名稱長於30字元,就從左邊較遠輸出的字元截掉。
四、案例:
執行對應的程式碼,就可以得到對應的日誌,這是log4j與slf4j日誌系統的使用
程式碼:
package com.turtle.log; import com.turtle.utils.ExceptionOutputStreamUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.text.SimpleDateFormat; import java.util.Date; public class LogTest { private final static Logger logger = LoggerFactory.getLogger(LogTest.class); public static void main(String[] args) { logger.info("programer processing......"); try{ // 會產生除以0的異常資訊 System.out.println(1/0); }catch (Exception e){ // 將異常資訊列印到日誌檔案中去 String exception = ExceptionOutputStreamUtil.getTrace(e); // 輸出日誌檔案 logger.error("Programer error:"+ exception+"\t"+"【"+new SimpleDateFormat("yyyy-MM-dd/HH.mm.ss").format(new Date())+"】"); } logger.debug("start Debug detail......"); } }com.turtle.log.LogTest
package com.turtle.log1; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class LogTest { private final static Logger logger = LoggerFactory.getLogger(LogTest.class); public static void main(String [] args){ logger.info("com.turtle.log1.LogTest的Info級別日誌"); logger.debug("com.turtle.log1.LogTest的Debug級別日誌"); } }com.turtle.log1.LogTest
package com.turtle.log2; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class LogTest { private final static Logger logger = LoggerFactory.getLogger(LogTest.class); public static void main(String [] args){ logger.info("com.turtle.log2.LogTest的Info級別日誌"); logger.debug("com.turtle.log2.LogTest的Debug級別日誌"); } }com.turtle.log2.LogTest
package com.turtle.utils; import java.io.PrintWriter; import java.io.StringWriter; public class ExceptionOutputStreamUtil { /** * 將傳入的具體錯誤資訊轉換為輸出流進行輸出 * @param t * @return */ public static String getTrace(Throwable t) { StringWriter stringWriter= new StringWriter(); PrintWriter writer= new PrintWriter(stringWriter); t.printStackTrace(writer); writer.close(); StringBuffer buffer= stringWriter.getBuffer(); return buffer.toString(); } }com.turtle.utils.ExceptionOutputStreamUtil
### set log levels ### log4j.rootLogger = DEBUG,stdout,D,E # 配置日誌資訊輸出目的地 log4j.appender.stdout = org.apache.log4j.ConsoleAppender # Target是輸出目的地的目標 log4j.appender.stdout.Target = System.out # 指定日誌訊息的輸出最低層次 log4j.appender.stdout.Threshold = INFO # 定義名為stdout的輸出端的layout型別 log4j.appender.stdout.layout = org.apache.log4j.PatternLayout # 如果使用pattern佈局就要指定的列印資訊的具體格式ConversionPattern log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n # 名字為D的對應日誌處理 log4j.appender.D = org.apache.log4j.DailyRollingFileAppender # File是輸出目的地的檔名 log4j.appender.D.File = LOG//app_debug.log #false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容 log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.TTCCLayout # 名字為E的對應日誌處理 log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File = LOG//app_error.log log4j.appender.E.Append = true log4j.appender.E.Threshold = ERROR log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n log4j.logger.com.turtle.log1 = DEBUG,A1 log4j.logger.com.turtle.log2 = ERROR,A2 log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender log4j.appender.A1.File = LOG//A1_app_debug.log log4j.appender.A1.Append = true log4j.appender.A1.Threshold = DEBUG log4j.appender.A1.layout = org.apache.log4j.TTCCLayout log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender log4j.appender.A2.File = LOG//A2_app_error.log log4j.appender.A2.Append = true log4j.appender.A2.Threshold = ERROR log4j.appender.A2.layout = org.apache.log4j.TTCCLayoutlog4j.properties
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.turtle</groupId> <artifactId>log</artifactId> <version>1.0-SNAPSHOT</version> <name>log</name> <!-- FIXME change it to the project's website --> <url>http://www.example.com</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.11</version> <scope>test</scope> </dependency> <!-- https://mvnrepository.com/artifact/log4j/log4j --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.25</version> </dependency> <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>1.7.25</version> </dependency> </dependencies> </project>pom.xml
五、總結:
日誌的關鍵配置包括輸出目標,資訊等級,檔案形式和格式控制,各個配置靈活調整,可在不同的檔案中找到不同的有用的資訊,格式控制中%c/%t/%l在一個龐大的專案中十分有用。有些配置檔案自己老是會忘記,所以花點時間,把log4j與slf4j的使用進行一個彙總,總結一下,理出屬於自己的思路,方便後面的復