Log4J 日志框架
Log4J 介绍
程序中的日志可以用来记录程序在运行时的所有信息，并可以进行持久化存储。
日志与输出语句的区别：
| 功能 | 输出语句 | 日志技术 |
|---|---|---|
| 取消输出 | 需要修改代码，灵活性比较差 | 不需要修改代码，灵活性比较好 |
| 输出位置 | 只能是控制台 | 可以将日志信息写入到文件或者数据库中 |
| 多线程 | 和业务代码处于一个线程中 | 多线程方式记录日志，不影响业务代码的性能 |
Java 日志体系：
什么是 Log4J：
- Log4j 是 Apache 的一个开源项目。
- 通过使用 Log4j，我们可以控制日志信息输送的目的地是控制台、文件等位置。
- 我们也可以控制每一条日志的输出格式。
- 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。
- 最令人感兴趣的就是，这些功能都可以只通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
入门案例
使用步骤：
- 导入 log4j 的相关 jar 包
- 编写 log4j 配置文件
- 在代码中获取日志的对象
- 按照级别设置记录日志信息
示例：
- log4j 配置文件：命名为 log4j.properties，放在 src 根目录下
log4j.rootLogger=debug, consoleAppender, fileAppender
# 输出源为控制台的相关配置
log4j.appender.consoleAppender=org.apache.log4j.ConsoleAppender
log4j.appender.consoleAppender.ImmediateFlush=true
log4j.appender.consoleAppender.Target=System.out
log4j.appender.consoleAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.consoleAppender.layout.ConversionPattern=%d %t %5p %c{1}:%L - %m%n
# 输出源为文件的相关配置
log4j.appender.fileAppender=org.apache.log4j.FileAppender
log4j.appender.fileAppender.ImmediateFlush = true
log4j.appender.fileAppender.Append=true
log4j.appender.fileAppender.File=./log4j-log.log
log4j.appender.fileAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.fileAppender.layout.ConversionPattern=%d %5p %c{1}:%L - %m%n
log4j.appender.fileAppender.encoding=UTF-8
- 测试类：
package com.demo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
// 测试类
public class Log4JTest {
// 方式一：使用log4j的api来获取日志的对象
// 弊端：如果以后我们更换日志的实现类，那么下面的代码就需要跟着改
// 不推荐使用
// private static final Logger LOGGER = Logger.getLogger(Log4JTest.class);
// 方式二：使用slf4j里面的api来获取日志的对象
// 好处：如果以后我们更换日志的实现类，那么下面的代码不需要跟着修改
// 推荐使用
private static final Logger logger = LoggerFactory.getLogger(Log4JTest.class);
public static void main(String[] args) {
// 1.导入jar包
// 2.编写配置文件
// 3.在代码中获取日志的对象
// 4.按照日志级别设置日志信息
logger.debug("debug级别的日志");
logger.info("info级别的日志");
logger.warn("warn级别的日志");
logger.error("error级别的日志");
/*
2021-10-04 23:32:46,965 main DEBUG Log4JTest:24 - debug级别的日志
2021-10-04 23:32:46,973 main INFO Log4JTest:25 - info级别的日志
2021-10-04 23:32:46,973 main WARN Log4JTest:26 - warn级别的日志
2021-10-04 23:32:46,974 main ERROR Log4JTest:27 - error级别的日志
*/
}
}
配置文件详解
三个核心
-
Loggers（记录器）：设定日志的级别。- Loggers 组件在此系统中常见的五个级别：DEBUG、INFO、WARN、ERROR 和 FATAL。
- DEBUG < INFO < WARN < ERROR < FATAL。
- 规则：只输出级别不低于设定级别的日志信息。
-
Appenders（输出源）：日志要输出的地方。如控制台（Console）、文件（Files）等。- org.apache.log4j.ConsoleAppender（控制台）
- org.apache.log4j.FileAppender（文件）
-
Layouts（布局）：日志输出的格式。可以根据自己的喜好规定日志输出的格式，常用的布局管理器如下：- org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
- org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
- org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）
配置根 Logger
-
格式：log4j.rootLogger=日志级别, appenderName1, appenderName2, …
-
日志级别：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 或者自定义的级别。
-
appenderName1：就是指定日志信息要输出到哪里。可以同时指定多个输出目的地，用逗号隔开，例如：log4j.rootLogger＝INFO, ca, fa
ConsoleAppender 配置项
-
ImmediateFlush=true
- 表示所有消息都会被立即输出，设为 false 则不输出，默认值是 true。
-
Target=System.err
- 默认值是 System.out。
FileAppender 配置项
-
ImmediateFlush=true
- 表示所有消息都会被立即输出。设为 false 则不输出，默认值是 true。
-
Append=false
- true 表示将消息添加到指定文件中，原来的消息不覆盖；
- false 则将消息覆盖指定的文件内容，默认值是 true。
-
File=D:/logs/logging.log4j
- 指定将消息输出到指定路径的 logging.log4j 文件中。
PatternLayout 配置项
- ConversionPattern=%m%n：设定以怎样的格式显示消息。
