之前項(xiàng)目開(kāi)發(fā)過(guò)程中，遇到線(xiàn)上問(wèn)題時(shí)運(yùn)維找不到具體的日志文件，然后把鍋丟給了開(kāi)發(fā)組，對(duì)于開(kāi)發(fā)來(lái)說(shuō)，日志是自己記錄的，所以找起來(lái)容易，但對(duì)于運(yùn)維卻很困難，于是開(kāi)始反思是不是我們的日志打得太low了，在網(wǎng)上看了許多的博文，發(fā)現(xiàn)這篇博文java日志框架log4j詳細(xì)配置及與slf4j聯(lián)合使用教程
寫(xiě)得很不錯(cuò)，于是做了借鑒總結(jié)。
日志在系統(tǒng)開(kāi)發(fā)的過(guò)程中扮演著不可替代的角色，對(duì)于開(kāi)發(fā)人員來(lái)說(shuō)，好的日志處理和好的日志習(xí)慣有助于后期發(fā)現(xiàn)問(wèn)題，解決問(wèn)題。對(duì)于運(yùn)維人員來(lái)說(shuō)，日志更是處理線(xiàn)上問(wèn)題的有利線(xiàn)索和證據(jù)，當(dāng)我們遇到線(xiàn)上服務(wù)異常或者線(xiàn)上服務(wù)器宕機(jī)時(shí)，日志的分析變得尤為重要，因此結(jié)構(gòu)清晰，描述清楚日志是每一個(gè)開(kāi)發(fā)人員都必須具備能力。
一，概念
self4j：按百科來(lái)說(shuō)，SLF4J，即簡(jiǎn)單日志門(mén)面（Simple Logging Facade for Java），不是具體的日志解決方案，它只服務(wù)于各種各樣的日志系統(tǒng)。實(shí)際上，SLF4J所提供的核心API是一些接口以及一個(gè)LoggerFactory的工廠(chǎng)類(lèi)。從某種程度上，SLF4J有點(diǎn)類(lèi)似JDBC，不過(guò)比JDBC更簡(jiǎn)單，在JDBC中，你需要指定驅(qū)動(dòng)程序，而在使用SLF4J的時(shí)候，不需要在代碼中或配置文件中指定你打算使用哪個(gè)具體的日志系統(tǒng)。如同使用JDBC基本不用考慮具體數(shù)據(jù)庫(kù)一樣，SLF4J提供了統(tǒng)一的記錄日志的接口，只要按照其提供的方法記錄即可，最終日志的格式、記錄級(jí)別、輸出方式等通過(guò)具體日志系統(tǒng)的配置來(lái)實(shí)現(xiàn)，因此可以在應(yīng)用中靈活切換日志系統(tǒng)。
log4j：log4j是Apache的一個(gè)開(kāi)源項(xiàng)目，可以靈活地記錄日志信息，我們可以通過(guò)Log4j的配置文件靈活配置日志的記錄格式、記錄級(jí)別、輸出格式，而不需要修改已有的日志記錄代碼。
二，log4j基本用法
首先，如果使用maven構(gòu)建工程，則只需要引入相應(yīng)的依賴(lài)即可，如果是普通的web工程，則只需要將jar包build path即可。
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
然后，在src/main/java目錄（包的根目錄即classpath）新建log4j.properties文件。
log4j.rootLogger=INFO,console
log4j.additivity.org.apache=true
#console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=INFO
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
測(cè)試類(lèi)：
public class Main {
public static void main(String[] args) {
new Test().test();
}
}
class Test {
final Logger log = Logger.getLogger(Test.class);
public void test() {
log.info("this is log.info()");
}
}
三，log4j.properties路徑
log4j.properties要放在哪以及怎樣配置才能被解析呢？不同工程類(lèi)型配置方式不同。
3.1 普通java或spring工程
這是最常見(jiàn)的java工程類(lèi)型，寫(xiě)demo用的多，把log4j.properties放在src/main/java目錄（包的根目錄）就行了。
3.2 spring mvc工程
web工程里用spring mvc構(gòu)建的比較多了，把log4j.properties放在src/main/resources的conf目錄（web工程配置文件通常在resources或WEB-INF目錄），編輯web.xml，添加
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:/conf/log4j.properties</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
3.3 普通web工程
沒(méi)有了spring提供的listener加載log4j.properties，我們要怎么加載這個(gè)文件呢？同樣，把log4j.properties放在src/main/resources的conf目錄，用servlet加載。
public class Log4jServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
public void init(ServletConfig config) throws ServletException {
String prefix = this.getClass().getClassLoader().getResource("/").getPath();
String path = config.getInitParameter("log4j-path");
PropertyConfigurator.configure(prefix + path);
}
public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}
public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}
public void destroy() {}
}
編輯web.xml，添加
<servlet>
<servlet-name>log4j</servlet-name>
<servlet-class>com.xmyself.log4j.Log4jServlet</servlet-class>
<init-param>
<param-name>log4j-path</param-name>
<param-value>conf/log4j.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
看著是不是和spring mvc的很像，甚至你也想到了，普通java工程沒(méi)有指定log4j.properties的路徑，那說(shuō)明log4j的jar包一定有一個(gè)默認(rèn)的路徑。另外，建議，log4j的配置放在第一個(gè)，因?yàn)楹罄m(xù)加載其他組件就要開(kāi)始使用日志記錄了
現(xiàn)在，你可以在多種類(lèi)型的java工程中打出日志了，但都是控制臺(tái)的日志，輸出內(nèi)容也很有限，下面我們就來(lái)詳細(xì)介紹log4j.properties內(nèi)容怎么配置。
四，log4j.properties內(nèi)容
接下來(lái)介紹的內(nèi)容看起來(lái)獨(dú)立，其實(shí)相互關(guān)聯(lián)，并且很有規(guī)律，我們要輸出日志，首先得有日志對(duì)象（logger），那這些日志對(duì)象把日志輸出到哪里呢，控制臺(tái)還是文件，這就要設(shè)置輸出位置（appender），輸出的格式與內(nèi)容又是什么樣的呢，這就要設(shè)置輸出樣式（layout），這些設(shè)置完，log4j的配置也就完了。
在此之前，先介紹下log4j日志等級(jí)的概念，日志等級(jí)就是日志的重要程度，log4j日志分為7個(gè)等級(jí)：ALL、DEBUG、INFO、WARN、ERROR、FATAL、OFF，從左到右等級(jí)由低到高，分等級(jí)是為了設(shè)置日志輸出的門(mén)檻，只有等級(jí)等于或高于這個(gè)門(mén)檻的日志才有機(jī)會(huì)輸出。
4.1 logger
日志實(shí)例，就是代碼里實(shí)例化的Logger對(duì)象。
log4j.rootLogger=LEVEL,appenderName1,appenderName2,...
log4j.additivity.org.apache=false：表示不會(huì)在父logger的appender里輸出，默認(rèn)true
這是全局logger的配置，LEVEL用來(lái)設(shè)定日志等級(jí)，appenderName定義日志輸出器，示例中的“console”就是一個(gè)日志輸出器
下面給出一個(gè)更清晰的例子，配置“com.demo.test”包下所有類(lèi)中實(shí)例化的Logger對(duì)象。
log4j.logger.com.demo.test=DEBUG,test
log4j.additivity.com.demo.test=false
4.2 appender
日志輸出器，指定logger的輸出位置
log4j.appender.appenderName=className
appender有5種選擇
org.apache.log4j.ConsoleAppender（控制臺(tái)）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個(gè)日志文件）
org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件）
org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方
每種appender都有若干配置項(xiàng)，下面逐一介紹
ConsoleAppender（常用）
Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)DEBUG
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)值是true
Target=System.err：默認(rèn)值是System.out
FileAppender
Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)DEBUG
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)true
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)true
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件
DailyRollingFileAppender（常用）
hreshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)DEBUG
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)true
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)true
File=D:/logs/logging.log4j：指定當(dāng)前消息輸出到logging.log4j文件
DatePattern='.'yyyy-MM：每月滾動(dòng)一次日志文件，即每月產(chǎn)生一個(gè)新的日志文件。當(dāng)前月的日志文件名為logging.log4j，前一個(gè)月的日志文件名為logging.log4j.yyyy-MM
另外，也可以指定按周、天、時(shí)、分等來(lái)滾動(dòng)日志文件，對(duì)應(yīng)的格式如下：
1)'.'yyyy-MM：每月
2)'.'yyyy-ww：每周
3)'.'yyyy-MM-dd：每天
4)'.'yyyy-MM-dd-a：每天兩次
5)'.'yyyy-MM-dd-HH：每小時(shí)
6)'.'yyyy-MM-dd-HH-mm：每分鐘
RollingFileAppender
Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)DEBUG
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)true
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)true
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件
MaxFileSize=100KB：后綴可以是KB,MB或者GB。在日志文件到達(dá)該大小時(shí)，將會(huì)自動(dòng)滾動(dòng)，即將原來(lái)的內(nèi)容移到logging.log4j.1文件
MaxBackupIndex=2：指定可以產(chǎn)生的滾動(dòng)文件的最大數(shù)，例如，設(shè)為2則可以產(chǎn)生logging.log4j.1，logging.log4j.2兩個(gè)滾動(dòng)文件和一個(gè)logging.log4j文件
4.3 layout
指定logger輸出內(nèi)容及格式。
log4j.appender.appenderName.layout=className
layout有4種選擇。
org.apache.log4j.HTMLLayout（以HTML表格形式布局）
org.apache.log4j.PatternLayout（可以靈活地指定布局模式）
org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串）
org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線(xiàn)程、類(lèi)別等信息）
layout也有配置項(xiàng)，下面具體介紹
HTMLLayout
LocationInfo=true：輸出java文件名稱(chēng)和行號(hào)，默認(rèn)false
Title=My Logging： 默認(rèn)值是Log4J Log Messages
PatternLayout（最常用的配置）
ConversionPattern=%m%n：設(shè)定以怎樣的格式顯示消息
設(shè)置格式的參數(shù)說(shuō)明如下
%p：輸出日志信息的優(yōu)先級(jí)，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL
%d：輸出日志時(shí)間點(diǎn)的日期或時(shí)間，默認(rèn)格式為ISO8601，可以指定格式如：%d{yyyy/MM/dd HH:mm:ss,SSS}
%r：輸出自應(yīng)用程序啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)
%t：輸出產(chǎn)生該日志事件的線(xiàn)程名
%l：輸出日志事件的發(fā)生位置，相當(dāng)于%c.%M(%F:%L)的組合，包括類(lèi)全名、方法、文件名以及在代碼中的行數(shù)
%c：輸出日志信息所屬的類(lèi)目，通常就是類(lèi)全名
%M：輸出產(chǎn)生日志信息的方法名
%F：輸出日志消息產(chǎn)生時(shí)所在的文件名
%L：輸出代碼中的行號(hào)
%m：輸出代碼中指定的具體日志信息
%n：輸出一個(gè)回車(chē)換行符，Windows平臺(tái)為"rn"，Unix平臺(tái)為"n"
%x：輸出和當(dāng)前線(xiàn)程相關(guān)聯(lián)的NDC(嵌套診斷環(huán)境)
%%：輸出一個(gè)"%"字符
五，log4j完整配置示例
介紹完了log4j.properties內(nèi)容，我們來(lái)配置一些常用的日志輸出吧
log4j.rootLogger=DEBUG,console,dailyFile,rollingFile,logFile
log4j.additivity.org.apache=true
控制臺(tái)console日志輸出器
# 控制臺(tái)(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
文件logFile日志輸出器
# 日志文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
滾動(dòng)文件rollingFile日志輸出器
# 滾動(dòng)文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
定期滾動(dòng)文件dailyFile日志輸出器
# 定期滾動(dòng)日志文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
六，log4j局部日志配置
以上介紹的配置都是全局的，整個(gè)工程的代碼使用同一套配置，意味著所有的日志都輸出在了相同的地方，你無(wú)法直接了當(dāng)?shù)娜タ磾?shù)據(jù)庫(kù)訪(fǎng)問(wèn)日志、用戶(hù)登錄日志、操作日志，它們都混在一起，因此，需要為包甚至是類(lèi)配置單獨(dú)的日志輸出，下面給出一個(gè)例子，為“com.demo.test”包指定日志輸出器“test”，“com.demo.test”包下所有類(lèi)的日志都將輸出到/log/test.log文件。
log4j.logger.com.demo.test=DEBUG,test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
也可以讓同一個(gè)類(lèi)輸出不同的日志，為達(dá)到這個(gè)目的，需要在這個(gè)類(lèi)中實(shí)例化兩個(gè)logger。
private static Log logger1 = LogFactory.getLog("myTest1");
private static Log logger2 = LogFactory.getLog("myTest2");
然后分別配置
log4j.logger.myTest1= DEBUG,test1
log4j.additivity.myTest1=false
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=/log/test1.log
log4j.appender.test1.layout=org.apache.log4j.PatternLayout
log4j.appender.test1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
log4j.logger.myTest2=DEBUG,test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=/log/test2.log
log4j.appender.test2.layout=org.apache.log4j.PatternLayout
log4j.appender.test2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
七，slf4j與log4j聯(lián)合使用
slf4j是什么？slf4j只是定義了一組日志接口，但并未提供任何實(shí)現(xiàn)，既然這樣，為什么要用slf4j呢？log4j不是已經(jīng)滿(mǎn)足要求了嗎？
是的，log4j滿(mǎn)足了要求，但是，日志框架并不只有l(wèi)og4j一個(gè)，你喜歡用log4j，有的人可能更喜歡logback，有的人甚至用jdk自帶的日志框架，這種情況下，如果你要依賴(lài)別人的jar，整個(gè)系統(tǒng)就用了兩個(gè)日志框架，如果你依賴(lài)10個(gè)jar，每個(gè)jar用的日志框架都不同，豈不是一個(gè)工程用了10個(gè)日志框架，那就亂了！
如果你的代碼使用slf4j的接口，具體日志實(shí)現(xiàn)框架你喜歡用log4j，其他人的代碼也用slf4j的接口，具體實(shí)現(xiàn)未知，那你依賴(lài)其他人jar包時(shí)，整個(gè)工程就只會(huì)用到log4j日志框架，這是一種典型的門(mén)面模式應(yīng)用，與jvm思想相同，我們面向slf4j寫(xiě)日志代碼，slf4j處理具體日志實(shí)現(xiàn)框架之間的差異，正如我們面向jvm寫(xiě)java代碼，jvm處理操作系統(tǒng)之間的差異，結(jié)果就是，一處編寫(xiě)，到處運(yùn)行。況且，現(xiàn)在越來(lái)越多的開(kāi)源工具都在用slf4j了
那么，怎么用slf4j呢？
首先，得弄到slf4j的jar包，maven依賴(lài)如下，log4j配置過(guò)程完全不變。
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.21</version>
</dependency>
然后，弄到slf4j與log4j的關(guān)聯(lián)jar包，通過(guò)這個(gè)東西，將對(duì)slf4j接口的調(diào)用轉(zhuǎn)換為對(duì)log4j的調(diào)用，不同的日志實(shí)現(xiàn)框架，這個(gè)轉(zhuǎn)換工具不同
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.21</version>
</dependency>
當(dāng)然了，slf4j-log4j12這個(gè)包肯定依賴(lài)了slf4j和log4j，所以使用slf4j+log4j的組合只要配置上面這一個(gè)依賴(lài)就夠了
最后，代碼里聲明logger要改一下，原來(lái)使用log4j是這樣的
import org.apache.log4j.Logger;
class Test {
final Logger log = Logger.getLogger(Test.class);
public void test() {
log.info("hello this is log4j info log");
}
}
現(xiàn)在要改成這樣
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
class Test {
Logger log = LoggerFactory.getLogger(Test.class);
public void test() {
log.info("hello, my name is {}", "chengyi");
}
}
依賴(lài)的Logger變了，而且，slf4j的api還能使用占位符，很方便。
作者：凌承一
出處：http://www.cnblogs.com/ywlaker/
聲明：本文版權(quán)歸作者和博客園共有，歡迎轉(zhuǎn)載，但轉(zhuǎn)載必須保留此段聲明，并在文章頁(yè)面明顯位置給出原文鏈接，否則作者將保留追究法律責(zé)任的權(quán)利。
