更多 Java 基礎(chǔ)知識方面的文章,請參見文集《Java 基礎(chǔ)知識》
Java日志組件
Java 日志 API 由以下三個核心組件組成:
Loggers:Logger 負(fù)責(zé)捕捉事件并將其發(fā)送給合適的 Appender。
Appenders:也被稱為 Handlers,負(fù)責(zé)將日志事件記錄到目標(biāo)位置。在將日志事件輸出之前, Appenders 使用Layouts來對事件進(jìn)行格式化處理。
Layouts:也被稱為 Formatters,它負(fù)責(zé)對日志事件中的數(shù)據(jù)進(jìn)行轉(zhuǎn)換和格式化。Layouts 決定了數(shù)據(jù)在一條日志記錄中的最終形式。
當(dāng) Logger 記錄一個事件時,它將事件轉(zhuǎn)發(fā)給適當(dāng)?shù)?Appender。然后 Appender 使用 Layout 來對日志記錄進(jìn)行格式化,并將其發(fā)送給控制臺、文件或者其它目標(biāo)位置。另外,F(xiàn)ilters 可以讓你進(jìn)一步指定一個 Appender 是否可以應(yīng)用在一條特定的日志記錄上。在日志配置中,F(xiàn)ilters 并不是必需的,但可以讓你更靈活地控制日志消息的流動。
日志框架
1. java.util.logging
默認(rèn)的 Java 日志框架。
2. 第三方框架
例如:
3. 抽象層開發(fā)包
例如:
諸如 SLF4J 這樣的抽象層,會將你的應(yīng)用程序從日志框架中解耦。
應(yīng)用程序可以在運(yùn)行時選擇綁定到一個特定的日志框架(例如 java.util.logging、Log4j 或者 Logback),這通過在應(yīng)用程序的類路徑中添加對應(yīng)的日志框架來實(shí)現(xiàn)。
如果在類路徑中配置的日志框架不可用,抽象層就會立刻取消調(diào)用日志的相應(yīng)邏輯。
抽象層可以讓我們更加容易地改變項(xiàng)目現(xiàn)有的日志框架,或者集成那些使用了不同日志框架的項(xiàng)目。
《阿里巴巴Java開發(fā)手冊(正式版)》 中提出:
應(yīng)用中不可直接使用日志系統(tǒng)(Log4j、Logback)中的 API,而應(yīng)依賴使用日志框架SLF4J 中的 API,使用門面模式的日志框架,有利于維護(hù)和各個類的日志處理方式統(tǒng)一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
日志級別 Log Levels
Log levels provide a way to categorize and identify logs based on their severity. 日志級別用來確定日志的嚴(yán)重程度,它可以用來過濾日志事件或者將其發(fā)送給不同的 Appender。
java.util.logging 框架提供了如下的日志級別:
- SEVERE (HIGHEST LEVEL)
- WARNING
- INFO
- CONFIG
- FINE
- FINER
- FINEST (LOWEST LEVEL)
Loggers
創(chuàng)建新Logger
通過 Logger.getLogger() 方法創(chuàng)建新 Logger,這個方法接收一個 String 參數(shù),用于指定 Logger 的名字。
- 如果指定名字的
Logger已經(jīng)存在,那么只需要返回已經(jīng)存在的Logger; - 否則,程序會創(chuàng)建一個新
Logger。
通常情況下,一種好的做法是,我們在當(dāng)前類下使用 class.getName() 作為新 Logger 的名字。
示例:
Logger logger = Logger.getLogger(MyClass.class.getName());
記錄日志事件
logger.log() 方法除了日志消息以外,還需要一個日志級別作為參數(shù):
logger.log(Level.WARNING, "This is a warning!");
大部分日志框架都針對輸出特定級別日志提供了快捷方式。例如,下面語句的作用和上面語句的作用是一樣的:
logger.warning("This is a warning!");
你還可以阻止 Logger 輸出低于指定日志級別的消息。在下面的示例中,Logger 只能輸出 等于或者高于 WARNING 級別的日志消息,并丟棄日志級別低于 WARNING的消息:
logger.setLevel(Level.WARNING);
Appenders
Appenders 將日志消息轉(zhuǎn)發(fā)給期望的輸出。它負(fù)責(zé)接收日志事件,使用 Layout 格式化事件,然后將其發(fā)送給對應(yīng)的目標(biāo)。
對于一個日志事件,我們可以使用多個 Appenders 來將事件發(fā)送到不同的目標(biāo)位置。
例如,我們可以在控制臺上顯示一個簡單的日志事件的同時,將其通過郵件的方式發(fā)送給指定的接收者。
增加 Appender
- 如果使用
java.util.logging,你可以使用logger.addHandler()方法將 Appender 添加到Logger中。例如,下面的代碼添加了一個新的ConsoleHandler,它會將日志輸出到控制臺:
logger.addHandler(new ConsoleHandler()); - 使用配置文件:
- 如果使用
java.util.logging,Appenders 會定義一個以逗號隔開的列表,下面的示例將日志事件輸出到控制臺和文件:
handlers=java.util.logging.ConsoleHandler, java.util.logging.FileHandler - 如果使用 Log4j,可以通過 XML 形式:
- 如果使用
<Console name="console" target="SYSTEM_OUT">
<PatternLayout pattern="[%p] %t: %m%n" />
</Console>
Appenders類型
1. ConsoleAppender
它只是將日志消息顯示到控制臺上。許多日志框架都將其作為默認(rèn)的 Appender,并且在基本的配置中進(jìn)行預(yù)配置。
一個完整的 Log4j2 的配置文件如下所示:
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn" name="MyApp">
<Appenders>
<Console name="MyAppender" target="SYSTEM_OUT">
<PatternLayout pattern="%m%n"/>
</Console>
</Appenders>
<Loggers>
<Root level="error">
<AppenderRef ref="MyAppender"/>
</Root>
</Loggers>
</Configuration>
你也可以使用 Logback 實(shí)現(xiàn)完全一樣的效果:
<configuration>
<appender name="MyAppender" class="ch.qos.Logback.core.ConsoleAppender">
<encoder>
<pattern>%m%n</pattern>
</encoder>
</appender>
<root level="error">
<appender-ref ref="MyAppender" />
</root>
</configuration>
2. FileAppenders
將日志記錄寫入到文件中,它負(fù)責(zé)打開、關(guān)閉文件,向文件中追加日志記錄,并對文件進(jìn)行加鎖,以免數(shù)據(jù)被破壞或者覆蓋。
Log4j 示例:
<Appenders>
<File name="MyFileAppender" fileName="myLog.log" append="true" locking="true">
<PatternLayout pattern="%m%n"/>
</File>
</Appenders>
Logback 示例:
<appender name="FileAppender" class="ch.qos.Logback.core.FileAppender">
<file>myLog.log</file>
<append>true</append>
<prudent>true</prudent>
<encoder>
<pattern>%m%n</pattern>
</encoder>
</appender>
3. SyslogAppender
將日志記錄發(fā)送給本地或者遠(yuǎn)程系統(tǒng)的日志服務(wù)。
syslog 是一個接收日志事件服務(wù),這些日志事件來自操作系統(tǒng)、進(jìn)程、其它服務(wù)或者其它設(shè)備。事件的范圍可以從診斷信息到用戶登錄硬件失敗等。syslog的事件按照設(shè)備進(jìn)行分類,它指定了正在記錄的事件的類型。
Log4j 示例:
<Appenders>
<Syslog name="SyslogAppender" host="localhost" port="514" protocol="UDP" facility="Auth" />
</Appenders>
Logback 示例:
<appender name="SyslogAppender" class="ch.qos.Logback.classic.net.SyslogAppender">
<syslogHost>localhost</syslogHost>
<port>514</port>
<facility>Auth</facility>
</appender>
4. 其它 Appender
例如,Log4j 中的 RollingFileAppender 擴(kuò)展了 FileAppender,它可以在滿足特定條件時自動創(chuàng)建新的日志文件;
SMTPAppender 會將日志內(nèi)容以郵件的形式發(fā)送出去;
FailoverAppender 會在處理日志的過程中,如果一個或者多個 Appender 失敗,自動切換到其他 Appender上。
如果想了解更多關(guān)于其他 Appender 的信息,可以查看 Log4j Appender參考 以及 Logback Appender參考。
Layouts
Layouts 將日志記錄的內(nèi)容從一種數(shù)據(jù)形式轉(zhuǎn)換成另外一種。
日志框架為純文本、HTML、syslog、XML、JSON、序列化以及其它日志提供了 Layouts。
例如,java.util.logging 提供了兩種 Layouts:SimpleFormatter 和 XMLFormatter。
- 默認(rèn)情況下,
ConsoleHandlers使用SimpleFormatter - 默認(rèn)情況下,
FileHandlers使用XMLFormatter
配置Layout
在 Log4j 和 Logback 中最常用的 Layouts 是 PatternLayout。它可以讓你決定日志事件中的哪些部分需要輸出,這是通過 轉(zhuǎn)換模式 Conversion Pattern 完成的,轉(zhuǎn)換模式在每一條日志事件的數(shù)據(jù)中扮演了占位符的角色。
例如,Log4j 默認(rèn)的 PatternLayout 使用了如下轉(zhuǎn)換模式:
PatternLayout pattern = "%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"
%d{HH:mm:ss.SSS} 將日期轉(zhuǎn)換成時、分、秒和毫秒的形式,%level 顯示日志事件的嚴(yán)重程度,%C 顯示生成日志事件的類的名字,%t 顯示 Logger 的當(dāng)前線程,%m 顯示時間的消息,最后,%n 為下一個日志事件進(jìn)行了換行。
改變Layouts
java.util.logging 中的示例代碼如下:
Handler ch = new ConsoleHandler();
ch.setFormatter(new XMLFormatter());
logger.addHandler(ch);
轉(zhuǎn)換模式 Conversion Patterns
Log4j 和 Logback 中的 PatternLayout 類都支持轉(zhuǎn)換模式,它決定了我們?nèi)绾螐拿恳粭l日志事件中提取信息以及如何對信息進(jìn)行格式化。
- 消息
%m - 級別/嚴(yán)重程度
%p - 異常
%ex - 線程
%t - Logger
%c - 方法
%M
一個 java.util.logging 完整的示例
Java 代碼:
import java.util.logging.Logger;
public class LoggerTest {
public static void main(String[] args) {
Logger logger = Logger.getLogger(MyClass.class.getName());
logger.finest("this is finest");
logger.finer("this is finer");
logger.fine("this is fine");
logger.config("this is config");
logger.info("this is info");
logger.warning("this is a warning");
logger.severe("this is severe");
}
}
默認(rèn)的 java.util.logging 配置:JRE_DIRECTORY/lib/logging.properties
handlers= java.util.logging.ConsoleHandler
.level= INFO
java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
因此默認(rèn)輸出如下:注意配置,只輸出 等于或者高于 INFO 級別的日志消息
Feb 13, 2017 3:18:52 PM basic.LoggerTest main
INFO: this is info
Feb 13, 2017 3:18:52 PM basic.LoggerTest main
WARNING: this is a warning
Feb 13, 2017 3:18:52 PM basic.LoggerTest main
SEVERE: this is severe
自定義配置文件 logging.properties:
handlers=java.util.logging.FileHandler
.level= ALL
java.util.logging.FileHandler.pattern = logger_test.xml
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
運(yùn)行參數(shù):java LoggerTest -Djava.util.logging.config.file=logging.properties
因此輸出到 XML 文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log SYSTEM "logger.dtd">
-<log>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445252</millis>
<sequence>0</sequence>
<logger>basic.MyClass</logger>
<level>FINEST</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is finest</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>1</sequence>
<logger>basic.MyClass</logger>
<level>FINER</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is finer</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>2</sequence>
<logger>basic.MyClass</logger>
<level>FINE</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is fine</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>3</sequence>
<logger>basic.MyClass</logger>
<level>CONFIG</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is config</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>4</sequence>
<logger>basic.MyClass</logger>
<level>INFO</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is info</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>5</sequence>
<logger>basic.MyClass</logger>
<level>WARNING</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is a warning</message>
</record>
-<record>
<date>2017-02-13T15:37:25</date>
<millis>1486971445307</millis>
<sequence>6</sequence>
<logger>basic.MyClass</logger>
<level>SEVERE</level>
<class>basic.LoggerTest</class>
<method>main</method>
<thread>1</thread>
<message>this is severe</message>
</record>
</log>