JUL日志架構

文章目錄

1. JUL 簡介
2. 日志的級别
3. 自定義日志級别配置
4. Logger 之間的父子關系
5. 日志的配置檔案
6. JUL配置檔案詳解
7. JUL 執行原理和流程

1. JUL 簡介

JUL全稱 Java util Logging ，是java原生的日志架構，使用時不需要另外引用第三方類庫，相對其他日志架構使用友善，學習簡單，能夠在小型應用中靈活使用。
在JUL中有以下元件：

1、

Loggers

：被稱為記錄器，應用程式通過擷取Logger對象，調用其API來來釋出日志資訊。Logger

通常時應用程式通路日志系統的入口程式。

2、

Appenders

：也被稱為Handlers，每個Logger都會關聯一組Handlers，Logger會将日志交給關聯

Handlers處理，由Handlers負責将日志做記錄。Handlers在此是一個抽象，其具體的實作決定了

日志記錄的位置可以是控制台、檔案、網絡上的其他日志服務或作業系統日志等。

3、

Layouts

：也被稱為Formatters，它負責對日志事件中的資料進行轉換和格式化。Layouts決定了

資料在一條日志記錄中的最終形式。

4、

Level

：每條日志消息都有一個關聯的日志級别。該級别粗略指導了日志消息的重要性和緊迫，可以将Level和Loggers，Appenders做關聯以便于過濾消息。

5、

Filters

：過濾器，根據需要定制哪些資訊會被記錄，哪些資訊會被放過。

小結：

使用者使用Logger來進行日志記錄，Logger持有若幹個Handler，日志的輸出操作是由Handler完成的。

在Handler輸出日志前，會經過Filter的過濾，判斷哪些日志級别過濾放行哪些攔截，Handler會将日

志内容輸出到指定位置（日志檔案、控制台等）。Handler在輸出日志時會使用Layout，将輸出内容進

行排版。

快速入門

//快速入門
@Test
public void testQuick() throws Exception {
    // 1.擷取日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630.JULTest");
    // 2. 日志記錄輸出
    logger.info("hello jul!");

    // 通用方法進行日志記錄
    logger.log(Level.INFO, "info msg!");

    // 通過占位符方式 輸出變量值
    String name = "xdr630";
    Integer age = 24;
    logger.log(Level.INFO, "使用者資訊：{0},{1}", new Object[]{name, age});
}

2. 日志的級别

JUL 中定義的日志級别：

SEVERE（最高值）
WARNING
INFO （預設級别）
CONFIG
FINE
FINER
FINEST（最低值）

還有兩個特殊的級别：

OFF，可用來關閉日志記錄。
ALL，啟用所有消息的日志記錄。

例如：檢視tomcat的日志，能明顯的看到不同級别的日志，其實 tomcat 預設使用的就是 JUL ：

測試了7個日志級别，但是預設隻實作 info 以上的級别

// 日志級别
@Test
public void testLogLevel() {
    // 1. 擷取日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630.JULTest");
    // 2. 日志記錄的輸出
    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL 預設日志基本 INFO
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");

}

發現隻能夠列印的隻有三行，這是為什麼呢？

找一下這個檔案，下圖是 jdk8 的日志配置檔案：

可以看到 jdk8 預設日志級别就是 INFO
java.util.logging.ConsoleHandler.level = INFO ：表示在控制台上預設的級别是 INFO，隻能列印 INFO 或 INFO 級别以上的日志，是以在上面的測試代碼中 INFO 下面的就列印不出。
java.util.logging.ConsoleHandler.formatter ：表示輸出日志的格式

3. 自定義日志級别配置

在日志中發現，可以給日志對象添加各種 handler ，就是處理器，比如 ConsoleHandler 專門處理控制台日志， FileHandler 可以處理檔案。

1、輸出全部級别的日志資訊

// 自定義日志級别
@Test
public void testLogConfig() throws IOException {
    // 1. 擷取日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630.JULTest");

    // 關閉系統預設配置
    logger.setUseParentHandlers(false);

    // 自定義日志級别
    // 建立 ConsoleHandler 控制台的輸出
    ConsoleHandler consoleHandler = new ConsoleHandler();

    // 建立簡單格式轉換對象
    SimpleFormatter simpleFormatter = new SimpleFormatter();

    // 進行關聯
    consoleHandler.setFormatter(simpleFormatter);
    logger.addHandler(consoleHandler);

    // 配置日志具體級别
    logger.setLevel(Level.ALL);
    consoleHandler.setLevel(Level.ALL);

    // 2. 日志記錄的輸出
    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL 預設日志基本 INFO
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
}

2、也可以把日志資訊以檔案的方式輸出

@Test
public void testLogConfig() throws IOException {
    // 1. 擷取日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630.JULTest");

    // 關閉系統預設配置
    logger.setUseParentHandlers(false);

    // 自定義日志級别
    // 建立 ConsoleHandler 控制台的輸出
    ConsoleHandler consoleHandler = new ConsoleHandler();

    // 建立簡單格式轉換對象
    SimpleFormatter simpleFormatter = new SimpleFormatter();

    // 進行關聯
    consoleHandler.setFormatter(simpleFormatter);
    logger.addHandler(consoleHandler);

    // 配置日志具體級别
    logger.setLevel(Level.ALL);
    consoleHandler.setLevel(Level.ALL);

    // 建立 FileHandler 檔案輸出 的形式
    FileHandler fileHandle = new FileHandler("E:/logs/jul.log");
    fileHandle.setFormatter(simpleFormatter);

    // 進行關聯
    fileHandle.setFormatter(simpleFormatter);
    logger.addHandler(fileHandle);

    // 2. 日志記錄的輸出
    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL 預設日志基本 INFO
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
}

4. Logger 之間的父子關系

JUL中Logger之間存在父子關系，這種父子關系通過樹狀結構存儲，JUL在初始化時會建立一個頂層

RootLogger作為所有Logger父Logger，存儲上作為樹狀結構的根節點，父子關系通過路徑來關聯。
Logger 對象父子關系

// Logger 對象父子關系
@Test
public void testLogParent() {

    Logger logger1 = Logger.getLogger("com.xdr630");
    Logger logger2 = Logger.getLogger("com");

    // 測試
    System.out.println(logger1.getParent() == logger2);
    // 所有日志記錄器的頂級父類元素 LogManager$RootLogger, name為 “” 空字元串
    // 父對象沒有指定的情況下會繼承 LogManager$RootLogger
    System.out.println("logger Parent" + logger2.getParent() + ",logger Parent name:" + logger2.getParent().getName());
    
}

設定 logger2 的處理器，隻要是父包包含子包就會預設繼承父包的日志設定，logger2 沒有定義父包的話，就會繼承 RootLogger ， RootLogger 有預設的處理器和可視轉換器，關閉系統預設配置，可以對其進行自定義，定義完成後，logger1 預設啟用的就是 logger2 定義的日志處理器

@Test
public void testLogParent() {

    Logger logger1 = Logger.getLogger("com.xdr630");
    Logger logger2 = Logger.getLogger("com");

    // 測試
    System.out.println(logger1.getParent() == logger2);
    // 所有日志記錄器的頂級父類元素 LogManager$RootLogger, name為 “” 空字元串
    // 父對象沒有指定的情況下會繼承 LogManager$RootLogger
    System.out.println("logger Parent" + logger2.getParent() + ",logger Parent name:" + logger2.getParent().getName());

    // 設定 logger2的日志級别

    // 關閉系統預設配置
    logger2.setUseParentHandlers(false);

    // 自定義日志級别
    // 建立 ConsoleHandler 控制台的輸出
    ConsoleHandler consoleHandler = new ConsoleHandler();

    // 建立簡單格式轉換對象
    SimpleFormatter simpleFormatter = new SimpleFormatter();

    // 進行關聯
    consoleHandler.setFormatter(simpleFormatter);
    logger2.addHandler(consoleHandler);

    // 配置日志具體級别
    logger2.setLevel(Level.ALL);
    consoleHandler.setLevel(Level.ALL);

    logger1.severe("severe");
    logger1.warning("warning");
    logger1.info("info");
    logger1.config("config");
    logger1.fine("fine");
    logger1.finer("finer");
    logger1.finest("finest");

}

結果可以看到，logger1 啟用的是定義好的 logger2 處理器

預設繼承的頂父元素 RootLogger 日志級别是 INFO

5. 日志的配置檔案

預設配置檔案路徑 $JAVA_HOME\jre\lib\logging.properties
把上面的 logging.properties 複制到項目的 resources 目錄下，修改後：把日志級别設定為 ALL，并輸出到指定目錄下

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

.level= ALL

java.util.logging.FileHandler.pattern = /logs/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 = ALL
java.util.logging.ConsoleHandler.formatter =

@Test
public void testProperties() throws Exception {
    // 讀取自定義配置檔案
    InputStream ins = JULTest.class.getClassLoader().getResourceAsStream("logging.properties");
    // 擷取日志管理器對象
    LogManager logManager = LogManager.getLogManager();
    // 通過日志管理器加載配置檔案
    logManager.readConfiguration(ins);

    // 建立日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630");

    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); // JUL 預設日志基本 INFO
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
}

可以看到輸出的檔案格式是 logging.properties 定義好的 XML 格式輸出的

6. JUL配置檔案詳解

logging.properties

# RootLogger 頂級父元素指定的預設處理器為：ConsoleHandler
handlers= java.util.logging.ConsoleHandler, java.util.logging.FileHandler

# RootLogger 頂級父元素預設的日志級别：ALL
.level= ALL

# 自定義 Logger 使用
com.xdr630.handlers = java.util.logging.ConsoleHandler
com.xdr630.level = CONFIG

# 關閉預設配置
com.xdr630.UseParentHandlers = false

# 向日志檔案輸出的 handler 對象
# 指定日志檔案路徑 /logs/java0.log
java.util.logging.FileHandler.pattern = /logs/java%u.log
# 指定日志檔案的内容大小
java.util.logging.FileHandler.limit = 50000
# 指定日志檔案的數量
java.util.logging.FileHandler.count = 1
# 指定 handler 對象日志消息格式對象
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
# 指定追加的方式添加日志内容
java.util.logging.FileHandler.append = true

# 向控制台輸出的 handler 對象
java.util.logging.ConsoleHandler.level = ALL
# 指定 handler 對象的日志級别
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
# 指定 handler 對象的字元集
java.util.logging.ConsoleHandler.encoding = UTF-8

# 自動日志消息格式
java.util.logging.SimpleFormatter.formatter = %4$s: %5$s [%1$tc]%n

使用自定義日志配置後，就隻會輸出對應的日志資訊

@Test
public void testProperties() throws Exception {
    // 讀取自定義配置檔案
    InputStream ins = JULTest.class.getClassLoader().getResourceAsStream("logging.properties");
    // 擷取日志管理器對象
    LogManager logManager = LogManager.getLogManager();
    // 通過日志管理器加載配置檔案
    logManager.readConfiguration(ins);

    // 建立日志記錄器對象
    Logger logger = Logger.getLogger("com.xdr630");

    logger.severe("severe");
    logger.warning("warning");
    logger.info("info"); 
    logger.config("config");
    logger.fine("fine");
    logger.finer("finer");
    logger.finest("finest");
    
}

7. JUL 執行原理和流程

初始化 LogManager

LogManager 加載logging.properties配置(項目下的檔案或系統的預設配置檔案)
添加Logger（包含RootLogger、預設的頂級對象、自定義對象）到LogManager

從單例 LogManager 擷取 Logger
設定級别 Level ，并指定日志記錄 LogRecord
Filter 提供了日志級别之外更細粒度的控制
Handler 是用來處理日志輸出位置（控制台或日志檔案）
Formatter 是用來格式化 LogRecord 的

JUL日志架構

文章目錄

1. JUL 簡介

2. 日志的級别

3. 自定義日志級别配置

4. Logger 之間的父子關系

5. 日志的配置檔案

6. JUL配置檔案詳解

7. JUL 執行原理和流程

繼續閱讀

關于Gradle配置的小結

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method