java項目中日志處理 · TUNA-daily

[TOC] ## 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提供了統一的記錄日志的接口，只要按照其提供的方法記錄即可，最終日志的格式、記錄級別、輸出方式等通過具體日志系統的配置來實現，因此可以在應用中靈活切換日志系統。如果你開發的是類庫或者嵌入式組件，那么就應該考慮采用SLF4J，因為不可能影響最終用戶選擇哪種日志系統。在另一方面，如果是一個簡單或者獨立的應用，**確定只有一種日志系統，那么就沒有使用SLF4J的必要**。假設你打算將你使用log4j的產品賣給要求使用JDK 1.4 Logging的用戶時，面對成千上萬的log4j調用的修改，相信這絕對不是一件輕松的事情。但是如果開始便使用SLF4J，那么這種轉換將是非常輕松的事情。 ## 3. 在Java項目中如何使用log4j和slf4j實現日志打印？ ### 3.1 添加相關jar包 1、log4j 2、slf4j-api 3、slf4j-log4j12 若是maven項目，pom.xml文件中添加配置（x-具體版本號）： ~~~ <slf4j.version>1.7.25</slf4j.version> <log4j.version>1.2.17</log4j.version> <slf4j-log4j12.version>1.7.25</slf4j-log4j12.version>  <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>${log4j.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>${slf4j-log4j12.version}</version> </dependency> ~~~ ### 3.2 添加log4j配置文件在項目類路徑下添加log4j.properties配置文件，具體內容如下： ~~~ ### set log levels ### log4j.rootLogger = DEBUG,stdout,D,E log4j.appender.stdout = org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target = System.out log4j.appender.stdout.Threshold = INFO log4j.appender.stdout.layout = org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = F://logs/log.log log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File =F://logs/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 ~~~ ### 3.3 配置說明 #### 3.3.1 log4j.rootCategory=DEBUG, stdout , D,E 定義日志級別此句為將等級為INFO以上的日志信息輸出到stdout和D,E這三個目的地，stdout和D,E的定義在下面的代碼，可以任意起名。 #### 3.3.2 等級可分為： OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 如果配置OFF則不打出任何信息，如果配置為INFO這樣只顯示INFO, WARN, ERROR的log信息，而DEBUG信息不會被顯示。stdout和D,E定義的輸出日志級別如log4j.appender.D.Threshold的值必須比log4j.rootLogger定義的級別高才生效。例如：log4j.rootLogger定義的級別為INFO，log4j.appender.D.Threshold定義的級別為DEBUG，D也只會輸出INFO以上級別的日志。 #### 3.3.3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender **此句為定義名為stdout的輸出端是哪種類型**，可以是： > 1. org.apache.log4j.ConsoleAppender（控制臺） > 2. org.apache.log4j.FileAppender（文件） > 3. org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件） > 4. org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件） > 5. org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方） #### 3.3.4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout **此句為定義名為stdout的輸出端的layout是哪種類型，可以是：** > 1. org.apache.log4j.HTMLLayout（以HTML表格形式布局） > 2. org.apache.log4j.PatternLayout（可以靈活地指定布局模式） > 3. org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串） > 4. org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息） #### 3.3.5 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: 輸出代碼中指定的消息,產生的日志具體信息 %n: 輸出一個回車換行符，Windows平臺為"/r/n"，Unix平臺為"/n"輸出日志信息換行 %d: 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式 ### 3.4 在項目的web.xml文件中添加log4j配置 ~~~  <context-param> <param-name>log4jConfigLocation</param-name> <param-value>classpath:log4j.properties</param-value> </context-param>  <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> ~~~ ### 3.5 在類中添加日志 ~~~ // 導入slf4j類 import org.slf4j.Logger; import org.slf4j.LoggerFactory; // 添加slf4j日志實例對象 private final static Logger logger = LoggerFactory.getLogger(Test.class); // 輸出日志 logger.info("輸出日志"); ~~~ ### 3.6 啟動服務器運行項目 ## 4. 項目中log的問題