如何在项目中使用 log4j

1. 导入

maven

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.32</version>
</dependency>

2. 使用

public class ReadTest {
    // 通过工厂获取logger实例
    Logger logger = LoggerFactory.getLogger(ReadTest.class);
    
    @Test
    public void simpleRead() {
        logger.debug("123");
    }
}

也可以通过 lombok 获取实例

首先导入 maven 依赖

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.24</version>
</dependency>

@Slf4j
public class ReadTest {
    @Test
    public void simpleRead() {
        log.debug("123");
    }
}

3. 配置文件

3.1 Log4j 简介

Log4j有三个主要的组件：

• Loggers(记录器):日志类别和级别;
• Appenders (输出源):日志要输出的地方;
• Layouts(布局):日志以何种形式输出

Loggers

Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL

按优先级来分为：DEBUG < INFO < WARN < ERROR < FATAL

当我们指定一个级别后，Log4j 只会输出级别不低于这个值的日志信息

Appenders

Appenders 控制日志的输出，如控制台、文件等

Layouts

Layouts 控制日志输出的样式

3.2 配置详解

在resource目录下创建 log4j.properties 文件

配置根Logger

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false：表示Logger不会在父Logger的appender里输出，默认为true。

1. level 指定日志最低级别
2. appenderName 指定日志要输出到哪里，可以有多个

示例：

log4j.rootLogger = debug,stdout

配置日志信息输出目的地

log4j.appender.appenderName = className

1. appenderName 是随意指定的
2. className 有5个可选值

可选值	含义
org.apache.log4j.ConsoleAppender	控制台
org.apache.log4j.FileAppender	文件
org.apache.log4j.DailyRollingFileAppender	每天产生一个日志文件
org.apache.log4j.RollingFileAppender	文件大小到达指定尺寸的时候产生一个新的文件
org.apache.log4j.WriterAppender	将日志信息以流格式发送到任意指定的地方

示例：

log4j.appender.mylog = org.apache.log4j.ConsoleAppender

---

上文中每一个 Appender 类都拥有自己的配置，当然阅读文章的你应该想要快速使用，那么请直接阅读输出格式配置，稍后也可以回过头来阅读这段配置

ConsoleAppender

参数	含义	默认值
Threshold	指定日志信息的最低输出级别	DEBUG
ImmediateFlush	表示所有消息都会被立即输出，设为 false 则不输出	true
Target	输出方式	System.out

这里以 ConsoleAppender 为例，简单演示一下如何配置

log4j.appender.mylog.Target = System.out
log4j.appender.mylog.ImmediateFlush = true
log4j.appender.mylog.Threshold = DEBUG

当然如果你只需要默认值，那么就不需要进行配置

FileAppender

参数	含义	默认值
Threshold	指定日志信息的最低输出级别	DEBUG
ImmediateFlush	表示所有消息都会被立即输出，设为 false 则不输出	true
Append	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容	true
File	例如 D:/logs/logging.log4j ，指定消息输出到logging.log4j文件中

DailyRollingFileAppender

参数	含义	默认值
Threshold	指定日志信息的最低输出级别	DEBUG
ImmediateFlush	表示所有消息都会被立即输出，设为 false 则不输出	true
Append	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容	true
File	例如 D:/logs/logging.log4j ，指定消息输出到logging.log4j文件中
DatePattern	每次滚动日志文件时，用来区分日期的后缀名pattern，例如 '.'yyyy-MM-dd

RollingFileAppender

参数	含义	默认值
Threshold	指定日志信息的最低输出级别	DEBUG
ImmediateFlush	表示所有消息都会被立即输出，设为 false 则不输出	true
Append	true 表示消息增加到指定文件中，false 则将消息覆盖指定的文件内容	true
File	例如 D:/logs/logging.log4j ，指定消息输出到logging.log4j文件中
MaxFileSize	后缀可以是KB, MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件中
MaxBackupIndex	指定可以产生的滚动文件的最大数，例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件

配置日志信息的输出格式

log4j.appender.appenderName.layout=className

className 可选值如下

可选值	含义
org.apache.log4j.HTMLLayout	以HTML表格形式布局
org.apache.log4j.PatternLayout	可以灵活地指定布局模式
org.apache.log4j.SimpleLayout	包含日志信息的级别和信息字符串
org.apache.log4j.TTCCLayout	包含日志产生的时间、线程、类别等等信息

一般都是使用 PatternLayout 进行自定义布局

log4j.appender.mylog.layout.ConversionPattern=pattern

格式化字符串 pattern 符号说明：

符号	含义
%p	输出日志信息的优先级，即 DEBUG，INFO，WARN，ERROR，FATAL
%d	输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}
%r	输出自应用程序启动到输出该log信息耗费的毫秒数
%t	输出产生该日志事件的线程名
%l	输出日志事件的发生位置，相当于%c.%M(%F:%L)的组合，包括类全名、方法、文件名以及在代码中的行数。例如：test.TestLog4j.main(TestLog4j.java:10)
%c	输出日志信息所属的类目，通常就是所在类的全名
%M	输出产生日志信息的方法名
%F	输出日志消息产生时所在的文件名称
%L	输出代码中的行号
%m	输出代码中指定的具体日志信息
%n	输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”
%x	输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像java servlets这样的多客户多线程的应用中
%%	输出一个”%”字符

示例：

log4j.appender.mylog.layout.ConversionPattern = [%-5p] %d{HH:mm:ss} %l: %m

输出样例：

[DEBUG] 10:54:53 easyexcel.ReadTest.simpleRead(ReadTest.java:16): 日志信息

另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。

修饰符	含义
c	指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐
%-20c	“-“号表示左对齐
%.30c	指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格

3.3 配置文件示例

# 设置根 #
log4j.rootLogger = debug, mylog, logfile

# 输出信息到控制抬 #
log4j.appender.mylog = org.apache.log4j.ConsoleAppender
log4j.appender.mylog.Target = System.out
log4j.appender.mylog.layout = org.apache.log4j.PatternLayout
log4j.appender.mylog.layout.ConversionPattern = [%-5p] %d{HH:mm:ss} %l: %n%m%n

# 输出到文件 #
log4j.appender.logfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.Threshold = INFO
log4j.appender.logfile.File = E:/logs/logging.log
log4j.appender.logfile.DatePattern =  '.'yyyy-MM-dd
log4j.appender.logfile.layout = org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern = [%-5p] %d{HH:mm:ss} %l: %n%m%n

4. 参考文章

• Log4j.properties配置详解