Java日志終極指南

Java日志基礎(chǔ)

Java使用了一種自定義的、可擴(kuò)展的方法來(lái)輸出日志。雖然Java通過(guò)java.util.logging包提供了一套基本的日志處理API，但你可以很輕松的使用一種或者多種其它日志解決方案。這些解決方案盡管使用不同的方法來(lái)創(chuàng)建日志數(shù)據(jù)，但它們的最終目標(biāo)是一樣的，即將日志從你的應(yīng)用程序輸出到目標(biāo)地址。

在這一節(jié)中，我們會(huì)探索Java日志背后的原理，并說(shuō)明如何通過(guò)日志來(lái)讓你成為一個(gè)更好的Java開(kāi)發(fā)人員。

Java日志組件

Java日志API由以下三個(gè)核心組件組成：

Loggers：Logger負(fù)責(zé)捕捉事件并將其發(fā)送給合適的Appender。Appenders：也被稱為Handlers，負(fù)責(zé)將日志事件記錄到目標(biāo)位置。在將日志事件輸出之前，Appenders使用Layouts來(lái)對(duì)事件進(jìn)行格式化處理。Layouts：也被稱為Formatters，它負(fù)責(zé)對(duì)日志事件中的數(shù)據(jù)進(jìn)行轉(zhuǎn)換和格式化。Layouts決定了數(shù)據(jù)在一條日志記錄中的最終形式。

當(dāng)Logger記錄一個(gè)事件時(shí)，它將事件轉(zhuǎn)發(fā)給適當(dāng)?shù)腁ppender。然后Appender使用Layout來(lái)對(duì)日志記錄進(jìn)行格式化，并將其發(fā)送給控制臺(tái)、文件或者其它目標(biāo)位置。另外，F(xiàn)ilters可以讓你進(jìn)一步指定一個(gè)Appender是否可以應(yīng)用在一條特定的日志記錄上。在日志配置中，F(xiàn)ilters并不是必需的，但可以讓你更靈活地控制日志消息的流動(dòng)。

日志框架

在Java中，輸出日志需要使用一個(gè)或者多個(gè)日志框架，這些框架提供了必要的對(duì)象、方法和配置來(lái)傳輸消息。Java在java.util.logging包中提供了一個(gè)默認(rèn)的框架。除此之外，還有很多其它第三方框架，包括Log4j、Logback以及tinylog。還有其它一些開(kāi)發(fā)包，例如SLF4J和Apache Commons Logging，它們提供了一些抽象層，對(duì)你的代碼和日志框架進(jìn)行解耦，從而允許你在不同的日志框架中進(jìn)行切換。

如何選擇一個(gè)日志解決方案，這取決于你的日志需求的復(fù)雜度、和其它日志解決方案的兼容性、易用性以及個(gè)人喜好。Logback基于Log4j之前的版本開(kāi)發(fā)（版本1），因此它們的功能集合都非常類(lèi)似。然而，Log4j在最新版本（版本2）中引用了一些改進(jìn)，例如支持多API，并提升了在用Disruptor庫(kù)的性能。而tinylog，由于缺少了一些功能，運(yùn)行特別快，非常適合小項(xiàng)目。

另外一個(gè)考慮因素是框架在基于Java的各種不同項(xiàng)目上的支持程度。例如Android程序只能使用Log4j、Logback或者第三方包來(lái)記錄日志， Apache Tomcat可以使用Log4j來(lái)記錄內(nèi)部消息，但只能使用版本1的Log4j。

抽象層

諸如SLF4J這樣的抽象層，會(huì)將你的應(yīng)用程序從日志框架中解耦。應(yīng)用程序可以在運(yùn)行時(shí)選擇綁定到一個(gè)特定的日志框架（例如java.util.logging、Log4j或者Logback），這通過(guò)在應(yīng)用程序的類(lèi)路徑中添加對(duì)應(yīng)的日志框架來(lái)實(shí)現(xiàn)。如果在類(lèi)路徑中配置的日志框架不可用，抽象層就會(huì)立刻取消調(diào)用日志的相應(yīng)邏輯。抽象層可以讓我們更加容易地改變項(xiàng)目現(xiàn)有的日志框架，或者集成那些使用了不同日志框架的項(xiàng)目。

配置

盡管所有的Java日志框架都可以通過(guò)代碼進(jìn)行配置，但是大部分配置還是通過(guò)外部配置文件完成的。這些文件決定了日志消息在何時(shí)通過(guò)什么方式進(jìn)行處理，日志框架可以在運(yùn)行時(shí)加載這些文件。在這一節(jié)中提供的大部分配置示例都使用了配置文件。

java.util.logging

默認(rèn)的Java日志框架將其配置存儲(chǔ)到一個(gè)名為 logging.properties 的文件中。在這個(gè)文件中，每行是一個(gè)配置項(xiàng)，配置項(xiàng)使用點(diǎn)標(biāo)記（dot notation）的形式。Java在其安裝目錄的lib文件夾下面安裝了一個(gè)全局配置文件，但在啟動(dòng)一個(gè)Java程序時(shí)，你可以通過(guò)指定 java.util.logging.config.file 屬性的方式來(lái)使用一個(gè)單獨(dú)的日志配置文件，同樣也可以在個(gè)人項(xiàng)目中創(chuàng)建和存儲(chǔ) logging.properties 文件。

下面的示例描述了如何在全局的logging.properties文件中定義一個(gè)Appender：

1 2 3 4 5# default file output is in user's home directory.java.util.logging.FileHandler.pattern = %h/java%u.logjava.util.logging.FileHandler.limit = 50000java.util.logging.FileHandler.count = 1java.util.logging.FileHandler.formatter = java.util.logging.XmlFormatterLog4j

Log4j版本1使用的語(yǔ)法和 java.util.logging 的語(yǔ)法很類(lèi)似。使用了Log4j的程序會(huì)在項(xiàng)目目錄中尋找一個(gè)名為 log4j.properties 的文件。默認(rèn)情況下，Log4j配置會(huì)將所有日志消息輸出到控制臺(tái)上。Log4j同樣也支持XML格式的配置文件，對(duì)應(yīng)的配置信息會(huì)存儲(chǔ)到 log4j.xml 文件中。

Log4j版本2支持XML、JSON和YAML格式的配置，這些配置會(huì)分別存儲(chǔ)到 log4j2.xml、log4j2.json 和 log4j2.yaml 文件中。和版本1類(lèi)似，版本2也會(huì)在工程目錄中尋找這些文件。你可以在每個(gè)版本的文檔中找到相應(yīng)的配置文件示例。

Logback

對(duì)于Logback來(lái)說(shuō)，大部分配置都是在logback.xml文件中完成的，這個(gè)文件使用了和Log4j類(lèi)似的XML語(yǔ)法。Logback同時(shí)也支持通過(guò)Groovy語(yǔ)言的方式來(lái)進(jìn)行配置，配置信息會(huì)存儲(chǔ)到logback.groovy文件中。你可以通過(guò)每種類(lèi)型配置文件的鏈接找到對(duì)應(yīng)的配置文件示例。

Loggers

Loggers是用來(lái)觸發(fā)日志事件的對(duì)象，在我們的Java應(yīng)用程序中被創(chuàng)建和調(diào)用，然后Loggers才會(huì)將事件傳遞給Appender。一個(gè)類(lèi)中可以包含針對(duì)不同事件的多個(gè)獨(dú)立的Loggers，你也可以在一個(gè)Loggers里面內(nèi)嵌一個(gè)Loggers，從而創(chuàng)建一種Loggers層次結(jié)構(gòu)。

創(chuàng)建新Logger

在不同的日志框架下面創(chuàng)建新Logger過(guò)程大同小異，盡管調(diào)用的具體方法名稱可能不同。在使用 java.util.logging 時(shí)，你可以通過(guò) Logger.getLogger().getLogger() 方法創(chuàng)建新Logger，這個(gè)方法接收一個(gè)string參數(shù)，用于指定Logger的名字。如果指定名字的Logger已經(jīng)存在，那么只需要返回已經(jīng)存在的Logger；否則，程序會(huì)創(chuàng)建一個(gè)新Logger。通常情況下，一種好的做法是，我們?cè)诋?dāng)前類(lèi)下使用 class.getName() 作為新Logger的名字。

1Logger logger = Logger.getLogger(MyClass.class.getName());記錄日志事件

Logger提供了幾種方法來(lái)觸發(fā)日志事件。然而，在你記錄一個(gè)事件之前，你還需要設(shè)置級(jí)別。日志級(jí)別用來(lái)確定日志的嚴(yán)重程度，它可以用來(lái)過(guò)濾日志事件或者將其發(fā)送給不同的Appender（想了解更多信息，請(qǐng)參考“日志級(jí)別”一節(jié)），Logger.log() 方法除了日志消息以外，還需要一個(gè)日志級(jí)別作為參數(shù)：

1logger.log(Level.WARNING, “This is a warning!”);

大部分日志框架都針對(duì)輸出特定級(jí)別日志提供了快捷方式。例如，下面語(yǔ)句的作用和上面語(yǔ)句的作用是一樣的：

1logger.warning(“This is a warning!”);

你還可以阻止Logger輸出低于指定日志級(jí)別的消息。在下面的示例中，Logger只能輸出高于WARNING級(jí)別的日志消息，并丟棄日志級(jí)別低于WARNING的消息：

1logger.setLevel(Level.WARNING);

我們還有另外一些方法可以用來(lái)記錄額外的信息。logp()（精確日志）可以讓你指定每條日志記錄的源類(lèi)（source class）和方法，而 logrb()（使用資源綁定的日志）可以讓你指定用于提取日志消息的資源。entering() 和 exiting() 方法可以讓你記錄方法調(diào)用信息，從而追蹤程序的執(zhí)行過(guò)程。

Appenders

Appenders將日志消息轉(zhuǎn)發(fā)給期望的輸出。它負(fù)責(zé)接收日志事件，使用Layout格式化事件，然后將其發(fā)送給對(duì)應(yīng)的目標(biāo)。對(duì)于一個(gè)日志事件，我們可以使用多個(gè)Appenders來(lái)將事件發(fā)送到不同的目標(biāo)位置。例如，我們可以在控制臺(tái)上顯示一個(gè)簡(jiǎn)單的日志事件的同時(shí)，將其通過(guò)郵件的方式發(fā)送給指定的接收者。

請(qǐng)注意，在java.util.logging中，Appenders被稱作Handlers。

增加Appender

大部分日志框架的Appender都會(huì)執(zhí)行類(lèi)似的功能，但在實(shí)現(xiàn)方面大相徑庭。如果使用 java.util.logging，你可以使用 Logger.addHandler() 方法將Appender添加到Logger中。例如，下面的代碼添加了一個(gè)新的ConsoleHandler，它會(huì)將日志輸出到控制臺(tái)：

1logger.addHandler(newConsoleHandler());

一種更常用的添加Appender的方式是使用配置文件。如果使用 java.util.logging，Appenders會(huì)定義一個(gè)以逗號(hào)隔開(kāi)的列表，下面的示例將日志事件輸出到控制臺(tái)和文件：

1handlers=java.util.logging.ConsoleHandler, java.util.logging.FileHandler

如果使用基于XML的配置文件，Appenders會(huì)被添加到

1 2 3<Consolename="console"target="SYSTEM_OUT"><PatternLayoutpattern="[%p] %t: %m%n" />Console>Appenders類(lèi)型

這一節(jié)描述了一些更通用的Appenders，以及它們?cè)诟鞣N日志框架中是如何實(shí)現(xiàn)的。

ConsoleAppender是最常用的Appenders之一，它只是將日志消息顯示到控制臺(tái)上。許多日志框架都將其作為默認(rèn)的Appender，并且在基本的配置中進(jìn)行預(yù)配置。例如，在Log4j中ConsoleAppender的配置參數(shù)如下所示。

一個(gè)完整的Log4j2的配置文件如下所示：