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 = java.util.logging.SimpleFormatter
@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
的