日志框架——JUL

一、什么是 JUL

  JUL 全称 java util Logging 是 Java 原生的日志框架，使用时不需要另外引用第三方类库，相对其他日志框架使用方便，能够在小型应用中灵活使用。

二、架构介绍

• Loggers：被称为记录器，应用程序通过获取 Logger 对象，调用其 API 来发布日志信息。Logger 通常是应用程序访问日志系统的入口程序。
• Appenders：也被称为 Handlers，每个 Logger 都会关联一组 Handlers，Logger 会将日志交给关联 Handlers 处理，由 Handlers 负责将日志做记录。Handlers 在此是一个抽象，其具体的实现决定了日志记录的位置可以是控制台、文件、网络上的其他日志服务或操作系统日志等。
• Layouts：也被称为 Formatters，它负责对日志事件中的数据进行转换和格式化。Layouts 决定了数据在一条日志记录中的最终形式。
• Level：每条日志消息都有一个关联的日志级别。该级别粗略指导了日志的重要性和紧迫，我们可以将 Level、Loggers、Appenders 做关联以便于我们过滤消息。
• Filters：过滤器，根据需要定制哪些信息会被记录，哪些信息会被放过。

  用户使用 Logger 来进行日志记录，Logger 持有若干个 Handler，日志的输出操作是由 Handler 完成的。在 Handler 输出日志前，会经过 Filter 的过滤，判断哪些日志级别放行，哪些拦截。Handler 会将日志内容输出到指定位置（日志文件、控制台等）。Handler 在输出日志时会使用 Layout 对输出内容进行排版。

三、JUL 简单的操作

1、入门案例

 1import java.util.logging.Level;
 2import java.util.logging.Logger;
 3
 4public class Test {
 5
 6    public static void main(String[] args) {
 7        // 创建日志记录器对象
 8        Logger logger=Logger.getLogger("top.zyxwmj.journal.demo.Test");
 9        // 日志记录输出
10        logger.info("zyxwmj.top");
11
12        logger.log(Level.INFO,"Yi-Xing");
13
14        String name="Yi-Xing";
15        int age=18;
16        // 参数注入
17        logger.log(Level.INFO,"用户信息：{0},{1}",new Object[]{name,age});
18    }
19}

2、日志级别

  Level 类定义了一组可用于控制记录输出的标准日志级别，这些级别可用于控制日志记录输出。

• SEVERE：最高的日志级别，用来记录错误信息，当我们的程序出现了严重的问题，造成了程序的终止，我们可以使用该级别的日志。
• WARNING：用来记录警告信息，它是来记录一些程序发生的一些问题，这些问题不造成程序的终止。
• INFO：用来记录消息信息，比如：记录数据库的连接信息，网络通信信息等等。（默认级别）
• CONFIG：用来记录配置信息，比如：加载了配置文件，读取了配置文件的参数等。
• FINE、FINER、FINEST：用来记录 debug 记录信息，记录程序运行的状态，执行的流程，参数的传递等信息。
• ALL、OFF：ALL 是开启所有日志级别，OFF 是关闭所有日志级别。

四、JUL 的配置

1、编码配置

 1import java.io.IOException;
 2import java.util.logging.*;
 3
 4public class Test {
 5
 6    public static void main(String[] args) throws IOException {
 7        // 创建日志记录器对象
 8        Logger logger = Logger.getLogger("top.zyxwmj.journal.demo.Test");
 9        // 关闭系统默认配置
10        logger.setUseParentHandlers(false);
11
12        // 创建 ConsoleHandler，控制台输出
13        ConsoleHandler consoleHandler = new ConsoleHandler();
14        // 创建简单格式转换对象
15        SimpleFormatter simpleFormatter = new SimpleFormatter();
16        // 进行关联
17        consoleHandler.setFormatter(simpleFormatter);
18        logger.addHandler(consoleHandler);
19
20        // 创建FileHandler 文件输出
21        FileHandler fileHandler = new FileHandler("E:\\logger.log");
22        // 进行关联
23        fileHandler.setFormatter(simpleFormatter);
24        logger.addHandler(fileHandler);
25
26
27        // 配置日志具体级别
28        logger.setLevel(Level.ALL);
29        consoleHandler.setLevel(Level.ALL);
30        fileHandler.setLevel(Level.ALL);
31
32        // 日志记录输出
33        logger.severe("severe");
34        logger.warning("warning");
35        logger.info("info");
36        logger.config("config");
37        logger.fine("fine");
38        logger.finer("finer");
39        logger.finest("finest");
40    }
41}

2、文件配置

  创建配置文件 logging.properties，内容如下：

1# 读取的配置
2handlers = java.util.logging.ConsoleHandler
3
4# 配置全局的日志级别
5.level=ALL
6
7java.util.logging.ConsoleHandler.level = ALL
8java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

  使用代码读取配置文件。

 1import java.io.IOException;
 2import java.io.InputStream;
 3import java.util.logging.*;
 4
 5public class Test {
 6
 7    public static void main(String[] args) throws IOException {
 8        // 读取配置文件，通过类加载器
 9        InputStream inputStream = Test.class.getClassLoader().getResourceAsStream("logging.properties");
10        // 创建LogManager
11        LogManager logManager = LogManager.getLogManager();
12        // 通过LogManager加载配置文件
13        logManager.readConfiguration(inputStream);
14
15        // 创建日志记录器对象
16        Logger logger = Logger.getLogger("top.zyxwmj.journal.demo.Test");
17
18        // 日志记录输出
19        logger.severe("severe");
20        logger.warning("warning");
21        logger.info("info");
22        logger.config("config");
23        logger.fine("fine");
24        logger.finer("finer");
25        logger.finest("finest");
26    }
27}

更多配置如下：

 1# RootLogger 顶级父元素指定的默认处理器为ConsoleHandler
 2# 多个处理器用逗号分隔
 3handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
 4
 5# 配置全局的日志级别
 6.level=ALL
 7
 8# 向控制台输出 handler 对象
 9# 指定日志级别
10java.util.logging.ConsoleHandler.level = ALL
11# 指定 handler 对象的日志消息格式对象
12java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
13# 指定 handler 对象的字符集
14java.util.logging.ConsoleHandler.encoding = UTF-8
15
16# 指定日志消息格式
17java.util.logging.SimpleFormatter.format = %4$s: %5$s [%1$tc]%n
18
19# 向日志文件输出的 handler 对象
20# 指定日志文件路径 %u表示第几个文件
21java.util.logging.FileHandler.pattern = E:\\logger%u.log
22# 指定日志文件内容大小
23java.util.logging.FileHandler.limit = 50000
24# 指定日志文件数量
25java.util.logging.FileHandler.count = 2
26# 指定 handler 对象日志消息格式对象
27java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
28# 指定追加方式添加日志内容，false（默认）重写，true续写
29java.util.logging.FileHandler.append = true

五、Logger 对象的父子关系

  Logger 对象具有继承关系，如下：logger2 是 logger1 的父包，所以 logger1 继承 logger2 的配置。

 1import java.util.logging.*;
 2
 3public class Test {
 4
 5    public static void main(String[] args) {
 6        // 创建日志记录器对象
 7        Logger logger1 = Logger.getLogger("top.zyxwmj.journal.demo");
 8        Logger logger2 = Logger.getLogger("top.zyxwmj.journal");
 9        // 测试
10        // 关闭系统默认配置
11        logger2.setUseParentHandlers(false);
12
13        // 创建 ConsoleHandler，控制台输出
14        ConsoleHandler consoleHandler = new ConsoleHandler();
15        // 创建简单格式转换对象
16        SimpleFormatter simpleFormatter = new SimpleFormatter();
17        // 进行关联
18        consoleHandler.setFormatter(simpleFormatter);
19        logger2.addHandler(consoleHandler);
20
21        // 配置日志具体级别
22        logger2.setLevel(Level.ALL);
23        consoleHandler.setLevel(Level.ALL);
24        // 日志记录输出
25        logger1.severe("severe");
26        logger1.warning("warning");
27        logger1.info("info");
28        logger1.config("config");
29        logger1.fine("fine");
30        logger1.finer("finer");
31        logger1.finest("finest");
32    }
33}

六、Logger 原理解析

1. 初始化 LogManager， LogManager 加载 logging.properties 配置，添加 Logger 到 LogManager
2. 从单例 LogManager 获取 Logger
3. 设置级别 Level，并指定日志记录 LogRecord
4. Filter 提供了日志级别之外更细粒度的控制
5. Handler 是用来处理日志输出位置
6. Formatter 是用来格式化 LogRecord 的