【Java日志系列】Log4j日志框架

目录

前言

一、Log4j简介

二、Log4j组件介绍

1. Loggers

2. Appenders

3. Layouts

三、快速入门

1. 入门代码

2. 日志级别

四、配置文件的使用

五、自定义日志输出格式

六、配置不同的Appender

1. 输出到文件

2. 输出到数据库

七、自定义Logger配置

总结 

---

前言

  日志是软件开发中不可或缺的一部分，它能够帮助开发者追踪程序的运行状态，诊断问题，以及监控系统性能。Apache Log4j作为一款成熟的日志框架，因其高度的灵活性和可配置性，在Java开发领域得到了广泛的应用。本文将介绍Log4j的基本概念、组成部分、如何配置及使用。

一、Log4j简介

  Log4j是Apache的一个开源项目，通过使用Log4j，我们开源控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

二、Log4j组件介绍

  Log4j主要由Loggers（日志记录器）、Appenders（输出控制器）和Layout（日志格式化器）组成。其中Loggers控制日志的输出以及输出级别；Appenders指定日志的输出方式（输出到控制台、文件等）；Layout控制日志信息的输出格式。

1. Loggers

  日志记录器，负责收集处理日志记录，实例的命名就是类的全限定名，如com.bjpowernode.log4j.XX，Logger的名字大小写敏感，其命名具有继承机制：例如：name为com.bjpowernode.log4的logger会继承name为com.bjpowernode。Log4j中有一个特殊的logger叫做“root”，他是所有logger的根，也就意味着其他所有的logger都会直接或者间接地继承自root。root logger可以用Logger.getRootLogger()方法获取。自log4j 1.2 版本以来，Logger类已经取代了Category类。对于熟悉早期版本的log4j的人来说，Logger类可以被视为Category类的别名。

  关于日志级别信息，例如DEBUG、INOFO、WARN、ERROR...级别是分大小的，DEBUG < INFO < WARN < ERROR，分别用来指定这条日志信息的重要程度，Log4j输出日志级别的规则是：只输出级别不低于设定级别的日志信息，假设Loggers级别设定为INFO，则INFO、WARN、ERROR级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

2. Appenders

  记录日志以及定义日志的级别仅仅是Log4j的基本功能，Log4j日志系统还提供许多强大的功能，比如允许把日志输出到不同的地方，比如控制台、文件等，可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其他地方等等。以下是一些常用的Appenders：

• ConsoleAppender：将日志输出到控制台。
• FileAppender：将日志输出到文件中。
• DailyRollingFileAppender：将日志输出到一个日志文件，并且根据时间的不同输出不同的文件，默认每天输出一个文件。
• RollingFileAppender：将日志信息输出到一个日志文件，并且指定文件的尺寸，当文件大小达到指定尺寸时，会自动把文件改名，同时产生一个新的文件。
• JDBCAppender：把日志信息保存到数据库中。

3. Layouts

  有时用户希望根据自己的喜好格式化自己的日志输出，Log4j可以再Appenders的后面附加Layouts来完成这个功能。Layouts提供四种日志输出样式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。以下是一些常用的Layouts：

• HTMLLayout：格式化日志输出为HTML表格形式。
• SimpleLayout：简单的日志输出格式化，打印的日志如默认INFO级别的消息。
• PatternLayout：最强大的格式化组件，可以根据自定义格式输出日志，如果没有指定转换格式，就是用默认的转换格式。

三、快速入门

1. 入门代码

  在正式编写代码之前，我们首先需要导入log4j的依赖，下面是一个示例：

<dependency>
     <groupId>log4j</groupId>
     <artifactId>log4j</artifactId>
     <version>1.2.12</version>
</dependency>

  接下来编写我们的快速入门代码，代码示例如下：

// 快速入门
@Test
public void testQuick() {
    BasicConfigurator.configure(); // 加载初始化配置
    Logger logger = Logger.getLogger(Log4jTest.class);
    logger.info("info");
}

补充：可以在代码的最前面加上LogLog.setInternalDebugging(true); 输出日志加载更加详细的信息。

  这里需要注意的是，我们需要写上BasicConfigurator.configure()来加载初始化的配置信息，否则在运行的时候会给我们弹出如下的警告：

2. 日志级别

  Log4j提供了8个级别的日志输出，分别为：

• ALL 最低等级，用于打开所有级别的日志记录。
• TRACE 表示程序推进下的追踪信息，这个追踪信息的日志级别非常低，一般情况下是不会使用的DEBUG 指出细粒度信息事件堆调试应用程序是非常有帮助的，主要是配合开发，在开发过程中打印一些重要的运行信息。
• INFO 消息的粗粒度级别运行信息。
• WARN 表示警告，程序在运行过程中会出现的有可能会发生的隐形的错误 注意：有些信息不是错误，但是这弓级别的输出目的就是给程序员以提示。
• ERROR 系统的错误信息，发生的错误不影响系统的运行 一般情况下，如果不想输出太多的日志，则使用该级别即可。
• FATAL 表示严重错误，它是那种一旦发生系统就不可能继续运行的严重错误 如果这中级别的错误出现了，表示程序可以停止运行了
• OFF 最高等级的级别，用户关闭所有的日志记录其中。

  其中，DEBUG是我们在没有进行设置的情况下，默认的日志输出级别。

四、配置文件的使用

  在使用Log4j的时候，我们可能需要通过自定义配置文件来定义一些配置信息，增加编码的灵活性，那么，我们该在哪里定义我们的配置文件呢？配置文件中的属性又该如何定义呢？下面的视频将对这个问题进行一个源码的追踪：

  有关源码追踪的步骤如下图所示：

  下面是一个简单的自定义配置示例：

log4j.rootLogger=trace,console
# 配置appender输出方式
log4j.appender.console=org.apache.log4j.ConsoleAppender
# 配置输出的格式
log4j.appender.console.layout=org.apache.log4j.SimpleLayout

五、自定义日志输出格式

  我们可以在配置文件中使用PatternLayout组件，并添加上自定义的格式配置，让日志格式按照程序员的想法进行输出，与自定义日志输出格式的相关配置示例如下所示：

log4j.rootLogger=all,console
# console组件
log4j.appender.console=org.apache.log4j.ConsoleAppender
# layout组件
log4j.appender.console.layout=org.apache.log4j.PatternLayout
# 自定义输出格式
log4j.appender.console.layout.conversionPattern=%r [%t] %p %c %x - %m%n

  在最后一行定义了日志的相关输出格式，这种格式化输出采用类似于C语言的printf函数的打印格式格式化日志信息，具体的占位符及其含义如下：

占位符	含义
%m	输出代码中指定的消息
%p	输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r	输出自应用启动到输出该log信息耗费的毫秒数
%c	输出所属的类目，通常就是所在类的全名
%t	输出产生该日志事件的线程名
%n	输出一个回车换行符
%d	输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l	输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)
%F	输出日志消息产生时所在的文件名称
%L	输出代码中的行号
%%	出一个"%"字符

  可以在%与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对齐方式，如：

• %5c  输出category名称，最小宽度是5，category < 5，默认的情况下右对齐。
• %-5c  输出category名称，最小宽度是5，category < 5，"-"号指定左对齐，会有空格。
• %.5c  输出category名称，最大宽度是5，category > 5，就会将左边多出的字符截掉，< 5不会有空格。
• %20.30c  输出category名称，< 20补空格，并且右对齐；> 30字符，就从左边交远销出的字符截掉。

六、配置不同的Appender

1. 输出到文件

    有关文件形式的输出，有三个Appender，分别为FileAppender、RollingFileAppender和DailyRollingFileAppender。后两者是对第一者的一个增强，其中RollingFileAppender中可以配置每个日志文件的大小以及日志文件的数量，当日志文件的数量超过设定的数量时，默认将覆盖保留时间最久的日志文件，原则就是保留新的，覆盖旧的。而DailyRollingFileAppender是默认按照天来记录日志，每天记录一个日志文件，该Appender暂不支持日志文件的覆盖。下面是对三者的一个配置：

# 配置输出形式为文件

# Appender组件
log4j.appender.file=org.apache.log4j.FileAppender
# 第一个file是我们自己命名的appenderName，第二个file是我们用来指定文件位置的属性
log4j.appender.file.file=1.log
# 指定编码
log4j.appender.file.encoding=UTF-8
# layout组件
log4j.appender.file.layout=org.apache.log4j.PatternLayout
# 自定义输出格式
log4j.appender.file.layout.conversionPattern=%r [%t] %p %c %x - %m%n

# 以文件大小来切分文件

# Appender组件
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
# 第一个file是我们自己命名的appenderName，第二个file是我们用来指定文件位置的属性
log4j.appender.rollingFile.file=1.log
# 指定编码
log4j.appender.rollingFile.encoding=UTF-8
# 指定日志文件的内容大小
log4j.appender.rollingFile.maxFileSize=1MB
# 指定日志文件的数量
log4j.appender.rollingFile.maxBackupIndex=5
# layout组件
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
# 自定义输出格式
log4j.appender.rollingFile.layout.conversionPattern=%r [%t] %p %c %x - %m%n

# 以时间来切分文件

# Appender组件
log4j.appender.dailyRollingFile=org.apache.log4j.DailyRollingFileAppender
# 指定文件名称
log4j.appender.dailyRollingFile.file=1.log
# 指定编码
log4j.appender.dailyRollingFile.encoding=UTF-8
# 指定日志文件的时间形式
log4j.appender.dailyRollingFile.datePattern='.'yyyy-MM-dd
# layout组件
log4j.appender.dailyRollingFile.layout=org.apache.log4j.PatternLayout
# 自定义输出格式
log4j.appender.dailyRollingFile.layout.conversionPattern=%r [%t] %p %c %x - %m%n

  使用上述配置，RollingFileAppender输出的结果如下图所示：

  使用上述配置，DailyRollingFileAppender输出的结果如下图所示：

补充：对于日志文件的时间形式，我们也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：

1. '.'yyyy-MM：每月
2. '.'yyyy-ww：每周
3. '.'yyyy-MM-dd：每天
4. '.'yyyy-MM-dd-a：每天两次
5. '.'yyyy-MM-dd-HH：每小时
6. '.'yyyy-MM-dd-HH-mm：每分钟

2. 输出到数据库

  在这里，我先使用Navicat在我本机虚拟机的数据库中创建了如下图所示的log表：

   接下来在maven中导入mysql连接的依赖，并在配置文件中编写数据库连接有关的配置：

<dependency>
     <groupId>com.mysql</groupId>
     <artifactId>mysql-connector-j</artifactId>
     <version>8.3.0</version>
</dependency>

# Appender组件
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
# 指定数据库驱动
log4j.appender.logDB.Driver=com.mysql.jdbc.Driver
# 指定数据库地址
log4j.appender.logDB.URL=jdbc:mysql://192.168.56.107:3307/logtest
# 指定连接的用户名
log4j.appender.logDB.User=root
# 指定连接的密码
log4j.appender.logDB.Password=123456
# 定义执行的SQL语句
log4j.appender.logDB.Sql=insert into log(create_time, level, category, file_name, message) values('%d{yyyy-MM-dd HH:mm:ss}', '%p', '%c', '%F', '%m')
# Layout组件
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
# 自定义输出格式
log4j.appender.logDB.layout.conversionPattern=%r [%t] %p %c %x - %m%n

   使用该配置运行后，输出到数据库的结果如下图所示：

七、自定义Logger配置

  我们以前所创建出来的Logger对象，默认都是继承rootLogger的，我们也可以自定义logger，让其他logger继承自自定义logger，这种继承关系就是按照包结构的关系来进行指定的，例如：   Logger logger = Logger.getLogger(Log4jTest.class); 路径是cn.sumou.Log4jTest，它的父Logger就是上层路径或者更上层的路径，如cn.sumou、cn。在配置文件中，我们可以按照如下图所示的方式自定义Logger的配置：

  输出结果如下图所示：

补充：如果根节点的logger和自定义logger配置的输出位置是不同的，则取二者的并集；如果二者配置的日志级别不同，则按照自定义的logger的级别输出。

总结 

  本文从Log4j的基本概念入手，介绍了其核心组件（Loggers、Appenders、Layouts），并通过实际示例演示了如何配置和使用Log4j。通过本文的学习，您应该能够理解Log4j的工作原理，掌握日志记录的基本操作，以及如何自定义日志输出的格式和目的地。此外，文章还介绍了如何通过配置文件灵活地控制日志记录的行为，这对于生产环境中日志管理和监控尤为重要。

  最后，虽然Log4j是一个较为成熟的日志框架，但在选择日志工具时还需要考虑项目的需求和技术栈的发展趋势。近年来，也有一些新的日志框架如Logback和SLF4J逐渐成为主流，它们在某些方面可能提供了更好的性能和特性支持。因此，在实际项目中选择合适的日志框架也是值得考虑的因素之一。