log4j學習總結

標籤：style   blog   java   color   使用   strong   

一直使用log4j來記錄日誌，但是一直以來沒有深入研究過log4j，最近研究了下log4j，下面總結一下：

log4j配置：

1. 配置根Logger，其文法為： 

 log4j.rootLogger = [level] , appenderName1, appenderName2, … 

其中，level 是日誌記錄的優先順序，分為 OFF、FATAL、ERROR、WARN、INFO、
DEBUG、ALL 或者您定義的層級。Log4j 建議只使用四個層級，優先順序從高到低分
別是 ERROR、WARN、INFO、DEBUG。
2. 配置日誌資訊輸出目的地Appender，其文法為：

log4j.appender.appenderName = fully.qualified.name.of.appender.class  log4j.appender.appenderName.option1 = value1  …  log4j.appender.appenderName.option = valueN  

  其中，Log4j 提供的appender有以下幾種： 
  org.apache.log4j.ConsoleAppender（控制台）， 
  org.apache.log4j.FileAppender（檔案）， 
  org.apache.log4j.DailyRollingFileAppender（每天產生一個記錄檔）， 
  org.apache.log4j.RollingFileAppender （檔案大小到達指定尺寸的時候產生一個新的檔案）， 
  org.apache.log4j.WriterAppender（將日誌資訊以流格式發送到任意指定的地方） 
3. 配置日誌資訊的格式（布局），其文法為：

log4j.appender.appenderName.layout= fully.qualified.name.of.layout.class  log4j.appender.appenderName.layout.option1 = value1  …  log4j.appender.appenderName.layout.option = valueN  

  其中，Log4j 提供的layout有以下幾種： 
  org.apache.log4j.HTMLLayout（以HTML 表格形式布局）， 
  org.apache.log4j.PatternLayout（可以靈活地指定配置模式）， 
  org.apache.log4j.SimpleLayout（包含日誌資訊的層級和資訊字串），
  org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等資訊）
  Log4J 採用類似 C 語言中的 printf 函數的列印格式格式化日誌資訊，列印參數如下： 
  %m 輸出代碼中指定的訊息
  %p 輸出優先順序，即DEBUG，INFO，WARN，ERROR，FATAL 
  %r 輸出自應用啟動到輸出該log資訊耗費的毫秒數 
  %c 輸出所屬的類目，通常就是所在類的全名 
  %t 輸出產生該日誌事件的線程名 
  %n 輸出一個斷行符號分行符號，Windows平台為“\r\n”，Unix 平台為“\n” 
  %d 輸出日誌時間點的日期或時間，預設格式為 ISO8601，也可以在其後指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002 年10 月18 日 22：10：28，921 
  %l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)   

在代碼中使用Log4j
1. 得到記錄器
使用Log4j， 第一步就是擷取日誌記錄器， 這個記錄器將負責控制日誌資訊。其文法為：

public static Logger getLogger( String name)  public static Logger getLogger( Class clazz) ``` getLogger( Class class)//其實調用的是getLogger(class.getName())

 

2. 插入記錄資訊（格式化日誌資訊）
當上兩個必要步驟執行完畢，您就可以輕鬆地使用不同優先順序別的
語句插入到您想記錄日誌的任何地方，其文法如下：

Logger.debug ( Object message ) ; Logger.info ( Object message ) ; Logger.warn ( Object message ) ; Logger.error ( Object message ) ; 

深入Log4j

1. Log4j總結
所有的logger都會繼承rootLogger，logger通過名字中的"."來確定繼承關係，如com.test繼承com。
通過Logger logger =Logger.getLogger(loggerName)擷取logger時，Log4j首先檢查設定檔中是否存在名為loggerName的logger，若存在則返回這個logger；若不存在則建立一個名為loggerName的logger並繼承離它最近的父logger直到rootLogger。
關於loggerName的命名，最佳實務為按類名命名。

log4j.rootLogger=INFO,Consolelog4j.appender.Console=org.apache.log4j.ConsoleAppenderlog4j.appender.Console.layout=org.apache.log4j.PatternLayoutlog4j.appender.Console.layout.ConversionPattern= %d{yyyy-MM-dd HH:mm:ss} %x %-5p [%c{3}] %m%n###自訂logger名為cn.hdt同時會繼承rootLogger的appender,即包cn.hdt下的日子寫入檔案和控制台log4j.logger.cn.hdt=info,Filelog4j.appender.File=org.apache.log4j.FileAppenderlog4j.appender.File.File=logs/catalina.outlog4j.appender.File.Append=truelog4j.appender.File.DatePattern=‘.‘yyyy-MM-ddlog4j.appender.File.layout=org.apache.log4j.PatternLayoutlog4j.appender.File.layout.ConversionPattern=%d{ABSOLUTE} %-5p [%c] %m%n###自訂logger名為com.test，修改日誌記錄層級為error，即包com.test下的error日誌會被列印log4j.logger.com.test=error

2. 自訂appender
自訂log4j appender需要繼承log4j公用的基類AppenderSkeleton並實現下列方法：

•  列印日誌核心方法：abstract protected void append(LoggingEvent event);
•  初始化載入資源：public void activateOptions()，預設實現為空白
•  釋放資源：public void close()
•  是否需要按格式輸出文本：public boolean requiresLayout()
•  正常情況下我們只需要覆蓋append方法即可。然後就可以在log4j中使用了

demo代碼：

package cn.hdt;import org.apache.log4j.AppenderSkeleton;import org.apache.log4j.spi.LoggingEvent;public class MyAppender extends AppenderSkeleton{  private String account ;   public String getAccount() {  return account; } public void setAccount(String account) {  this.account = account; } @Override protected void append(LoggingEvent event) {    System.out.println("Hello, " + account + " : "+ event.getMessage());     } @Override public void close() {     } @Override public boolean requiresLayout() {    return false; }  @Override   public void activateOptions() {     System.out.print("myappender init");  }}

 

設定檔：

log4j.rootLogger=INFO,hellolog4j.appender.hello=org.apache.log4j.ConsoleAppenderlog4j.appender.hello.layout=org.apache.log4j.PatternLayoutlog4j.appender.hello.layout.ConversionPattern= %d{yyyy-MM-dd HH:mm:ss} %x %-5p [%c{3}] %m%nlog4j.appender.hello=cn.hdt.MyAppenderlog4j.appender.hello.account=World

測試代碼：

package cn.hdt;import org.apache.log4j.Logger;public class LogTest { public static void main(String[] args) {  Logger logger = Logger.getLogger(LogTest.class);  logger.info("this is info") ; }}

 

執行main函數，輸出結果：

Myappender  initHello, World : this is info

由於未實現布局格式，所以輸出為未格式化；MyAppender帶有一個account的屬性，可在設定檔中指定該屬性的值，通過appenderName後加".propertyName = value"指定，如log4j.appender.hello.account=World。
注意為了給MyAppender的account注入值，MyAppender中必須有account的setter方法。
關於log4j的xml配置方法和property配置大體差不多