Log4j 2.0在開發中的高級使用詳解

log4j與slf4j、logback比較

而log4j slf4j logback就是目前主流的日誌框架。但後二者效率高是第一個。推薦使用:slf4j 或者 logback(spring-boot默認日誌實現)java

  • log4j是apache實現的一個開源日誌組件。(Wrapped implementations)
  • logback一樣是由log4j的做者設計完成的,擁有更好的特性,用來取代log4j的一個日誌框架。是slf4j的原生實現。(Native implementations)
  • enter image description here
    上圖能夠看到應用程序對日誌框架的調用關係。應用程序調用slf4j api,而日誌的輸出最終是由底層的日誌框架來實現的。這張圖也提現了log4j和logback的不一樣。
  • logback是直接實現了slf4j的接口,是不消耗內存和計算開銷的。web

  • 而log4j不是對slf4j的原生實現,因此slf4j api在調用log4j時須要一個適配層。spring

    總結:sql

  • slf4j是java的一個日誌門面,實現了日誌框架一些通用的api,log4j和logback是具體的日誌框架。
  • 他們能夠單獨的使用,也能夠綁定slf4j一塊兒使用。
  • 單獨使用。分別調用框架本身的方法來輸出日誌信息。
  • 綁定slf4j一塊兒使用。調用slf4j的api來輸入日誌信息,具體使用與底層日誌框架無關(須要底層框架的配置文件)

 

級別Loggers 

Loggers組件在此係統中被分爲五個級別:DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的。
DEBUG Log4j有一個規則:假設Loggers級別爲P,若是在Loggers中發生了一個級別Q比P高,則能夠啓動,不然屏蔽掉。好比:你定義的級別是info,那麼error和warn的日誌能夠顯示而比他低的debug信息就不顯示了,其語法表示爲: apache

  • org.apache.log4j.ConsoleAppender(控制檯)   
  • org.apache.log4j.FileAppender(文件) 
  • org.apache.log4j.DailyRollingFileAppender(天天產生一個日誌文件) 
  • org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件) 
  • org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)    

   配置時使用方式爲: json

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

這樣就爲日誌的輸出提供了至關大的便利。api

1.ConsoleAppender選項 

Threshold=WARN:指定日誌消息的輸出最低層次。 
ImmediateFlush=true:默認值是true,意謂着全部的消息都會被當即輸出。 
Target=System.err:默認狀況下是:System.out,指定輸出控制檯 多線程

2.FileAppender 選項 

Threshold=WARN:指定日誌消息的輸出最低層次。 
ImmediateFlush=true:默認值是true,意謂着全部的消息都會被當即輸出。 
File=mylog.txt:指定消息輸出到mylog.txt文件。 
Append=false:默認值是true,即將消息增長到指定文件中,false指將消息覆蓋指定的文件內容。 app

3.DailyRollingFileAppender 選項 

Threshold=WARN:指定日誌消息的輸出最低層次。 
ImmediateFlush=true:默認值是true,意謂着全部的消息都會被當即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。 
Append=false:默認值是true,即將消息增長到指定文件中,false指將消息覆蓋指定的文件內容。 
DatePattern='.'yyyy-ww:每週滾動一次文件,即每週產生一個新的文件。固然也能夠指定按月、周、天、時和分。
即對應的格式以下: 1)'.'yyyy-MM: 每個月 
2)'.'yyyy-ww: 每週  
3)'.'yyyy-MM-dd: 天天 
4)'.'yyyy-MM-dd-a: 天天兩次 
5)'.'yyyy-MM-dd-HH: 每小時 
6)'.'yyyy-MM-dd-HH-mm: 每分鐘 框架


4.RollingFileAppender 選項 

Threshold=WARN:指定日誌消息的輸出最低層次。 
ImmediateFlush=true:默認值是true,意謂着全部的消息都會被當即輸出。 File=mylog.txt:指定消息輸出到mylog.txt文件。 
Append=false:默認值是true,即將消息增長到指定文件中,false指將消息覆蓋指定的文件內容。 
MaxFileSize=100KB: 後綴能夠是KB, MB 或者是 GB. 在日誌文件到達該大小時,將會自動滾動,即將原來的內容移到mylog.log.1文件。 
MaxBackupIndex=2:指定能夠產生的滾動文件的最大數。    
 

佈局Layouts 

有時用戶但願根據本身的喜愛格式化本身的日誌輸出.Log4j能夠在Appenders的後面附加Layouts來完成這個功能。
Layouts提供了 四種日誌輸出樣式,
如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式等等。 其語法表示爲:    

  • org.apache.log4j.HTMLLayout(以HTML表格形式佈局),   
  • org.apache.log4j.PatternLayout(能夠靈活地指定佈局模式),    
  • org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串),   
  • org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息)    

  配置時使用方式爲:    

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


1.HTMLLayout 選項 

LocationInfo=true:默認值是false,輸出java文件名稱和行號 Title=my app file: 默認值是 Log4J Log Messages. 


2.PatternLayout 選項 

ConversionPattern=%m%n :指定怎樣格式化指定的消息。 

3.XMLLayout 選項 

LocationInfo=true:默認值是false,輸出java文件和行號 實際應用: 
log4j.appender.A1.layout=org.apache.log4j.PatternLayout 
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n 
這裏須要說明的就是日誌信息格式中幾個符號所表明的含義:    
-X號: X信息輸出時左對齊; 
%p: 輸出日誌信息優先級,即DEBUG,INFO,WARN,ERROR,FATAL, 
%d: 輸出日誌時間點的日期或時間,默認格式爲ISO8601,也能夠在其後指定格式,好比:%d{yyy MMM dd HH:mm:ss,SSS},輸出相似:2002年10月18日 22:10:28,921 
%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"輸出日誌信息換行 
能夠在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如: 
1)%20c:指定輸出category的名稱,最小的寬度是20,若是category的名稱小於20的話,默認的狀況下右對齊。 
2)%-20c:指定輸出category的名稱,最小的寬度是20,若是category的名稱小於20的話,"-"號指定左對齊。 
3)%.30c:指定輸出category的名稱,最大的寬度是30,若是category的名稱大於30的話,就會將左邊多出的字符截掉,但小於30的話也不會有空格。 
4)%20.30c:若是category的名稱小於20就補空格,而且右對齊,若是其名稱長於30字符,就從左邊交遠銷出的字符截掉。 
  這裏上面三個步驟是對前面Log4j組件說明的一個簡化;下面給出一個具體配置例子,在程序中能夠參照執行: 

log4j.rootLogger=INFO,A1,B2 

log4j.appender.A1=org.apache.log4j.ConsoleAppender   log4j.appender.A1.layout=org.apache.log4j.PatternLayout log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n 

 

 

Log4j手動讀取配置文件

log4j中配置日誌文件存放的位置不必定在src下面,即根目錄下。這個時候咱們須要解決如何加載配置文件的問題。在log4j1.x中解決的方法就比較多了。如:PropertyConfigurator.configure();和DOMConfigurator.configure ();這兩種方法讀取。而在log4j2.x當中,這兩個類都已經不存在了。這個時候咱們該如何去加載配置文件呢?

答案也很簡單,就是log4j2.x的版本給我提供了ConfigurationSource和Configurator這兩個類。咱們可使用它們進行手動的加載任意位置的配置文件信息。

我就主要介紹三種方法:log4j 2讀取配置文件的三種方法。

log4j 2讀取的配置文件能夠分爲三類:src下的配置文件、絕對路徑的配置文件、相對路徑的配置文件。咱們一一給例子。直接看代碼:

import java.io.File;
import java.io.FileInputStream;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.ConfigurationSource;
import org.apache.logging.log4j.core.config.Configurator;

/**
 * log4j 2讀取配置文件
 * log4j 2讀取的配置文件能夠分爲三類:src下的配置文件、絕對路徑的配置文件、相對路徑的配置文件
 */
public class Log4jConfigTest {
	private static Logger logger = LogManager.getLogger(Log4jConfigTest.class);

	public static void main(String[] args) {
		test0();
		System.out.println("===============================");
		test1();
		System.out.println("===============================");
		test2();
	}

	/**
	 * 第一類 加載src下的配置文件
	 * @author:spinach
	 * @date:2018年4月22日上午11:37:59
	 */
	public static void test0() {
		// src下的配置文件會默認的被log4j的框架加載,咱們就不顯示的加載了
		// 直接測試
		logger.info("我打印了.......");
		logger.trace("trace...");
		logger.debug("debug...");
		logger.info("info...");
		logger.warn("warn...");
		logger.error("error...");
		logger.fatal("fatal...");
	}

	/**
	 * 第二類 絕對路徑的配置文件
	 * @author:spinach
	 * @date:2018年4月22日上午11:38:04
	 */
	public static void test1() {
		// 這是須要手動的加載
		ConfigurationSource source;
		String logPath = "D:/log4j.properties";
		try {
			// 方法1 使用 public ConfigurationSource(InputStream stream) throws IOException 構造函數
			source = new ConfigurationSource(new FileInputStream(logPath));

			// 方法2 使用 public ConfigurationSource(InputStream stream, File file)構造函數
			File config = new File(logPath);
			//source = new ConfigurationSource(new FileInputStream(config), config);

			// 方法3 使用 public ConfigurationSource(InputStream stream, URL url) 構造函數
			//source = new ConfigurationSource(new FileInputStream(logPath), new File(logPath).toURL());
			
			// source.setFile(new File("D:\log4j2.xml"));
			// source.setInputStream(new FileInputStream("D:\log4j2.xml"));
			Configurator.initialize(null, source);
			Logger logger = LogManager.getLogger(ConfigTest.class.getName());
			test0();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	/**
	 * 第三類 相對路徑的配置文件加載
	 * @author:spinach
	 * @date:2018年4月22日上午11:38:10
	 */
	public static void test2() {
		// 這裏須要注意路徑中不要出現中文和空格,若是存在中文,請使用url轉碼
		ConfigurationSource source;
		String logPath = "src/main/resources/log4j.properties";
		try {
			// 方法1 使用getResource()
			source = new ConfigurationSource(new FileInputStream(new File(logPath)));
			Configurator.initialize(null, source);

			// 方法2 使用System.getProperty
			String config = System.getProperty("user.dir");
			source = new ConfigurationSource(new FileInputStream(config +"/"+ logPath));
			Configurator.initialize(null, source);
			
			test0();
			
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

}

log4j 1加載方式:

public void initLog4j() {
		String time = "【" + DatetimeUtils.format(System.currentTimeMillis(), "yyyy-MM-dd HH:mm:ss") + "】";
		System.out.println(time + "開始初始化log4j...");
		ConfigurationSource source = new ConfigurationSource(new FileInputStream("D:\\log4j2.xml"));  
		DOMConfigurator.configure(confPath + "/log4j.xml");
		LOGGER.info("log4j初始化成功...");
	}

 

log4j.properties

### set log levels ###
log4j.rootLogger = INFO,C

### Output to the console ###
log4j.appender.C = org.apache.log4j.ConsoleAppender
log4j.appender.C.Target = System.out
log4j.appender.C.layout = org.apache.log4j.PatternLayout
log4j.appender.C.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%p] %c{2}:%L %m%n
#log4j.logger.org.hibernate.cache=debug

### SQL ###
#log4j.logger.java.sql.Connection=debug
#log4j.logger.java.sql.PreparedStatement = debug    
#log4j.logger.java.sql.Statement = debug    
#log4j.logger.java.sql.ResultSet =debug
#log4j.logger.com.ibatis=DEBUG
#log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG
#log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG
#log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
log4j.logger.com.spinach.business=DEBUG

### Save infos to log file ###
log4j.appender.I = org.apache.log4j.DailyRollingFileAppender
log4j.appender.I.encoding=UTF-8
log4j.appender.I.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-info.log
log4j.appender.I.DatePattern = '.'yyyy-MM-dd
log4j.appender.I.MaxFileSize=50MB
log4j.appender.I.MaxBackupIndex=10
log4j.appender.I.Append = true
log4j.appender.I.Threshold = DEBUG
log4j.appender.I.layout = org.apache.log4j.PatternLayout
log4j.appender.I.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [%p] %l%m%n%n

### Save debugs to log file ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.encoding=UTF-8
log4j.appender.D.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-debug.log
log4j.appender.D.DatePattern = '.'yyyy-MM-dd
log4j.appender.D.MaxFileSize=50MB
log4j.appender.D.MaxBackupIndex=10
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} [%p] %l%m%n%n

### Save errors to a log file ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.encoding=UTF-8
log4j.appender.E.File = ${catalina.base}/logs/oa_sys_web/WEB-INF/logs/oa_sys_web-error.log
log4j.appender.E.DatePattern = '.'yyyy-MM-dd
log4j.appender.E.MaxFileSize=50MB
log4j.appender.E.MaxBackupIndex=10
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} [%p] %l%m%n%n

#log4j.logger.org.hibernate.SQL=debug
相關文章
相關標籤/搜索