Log4j日志实现

简介

• 本篇是关于Log4j日志框架的介绍。
• 阅读本文请至少了解JUL日志框架，因为大部分的知识点是类似的。

Log4j日志框架

• Log4j全称是Log for Java，它是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输出的位置是控制台、文件还是GUI组件，输出位置甚至可以是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；
• 使用Log4j也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。

入门案例

• 所使用的项目使用Maven构建，需要引入Log4j依赖：

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

• Log4j默认情况下是需要提供配置文件的，如果resource目录下不存在log4j.properties配置文件，则控制台中会输出相应的警告信息。
• 考虑以下代码：

@Test
public void test() {
    // 1.在没有log4j.properties的情况下，获取日志记录器对象Logger
    Logger logger = Logger.getLogger(Log4jTest.class);

    // 2.尝试输出日志记录
    logger.info("Hey, log4j.");
}

• 此时控制台输出为：

• 接触过JUL的都知道，当普通的Logger没有进行额外的配置时，其默认会继承并使用RootLogger的配置。
• 同样地，Log4j中也存在RootLogger，但由于默认情况下RootLogger不具有任何的Appender（即Handler）。
• 如果代码仅为了测试某项功能，并不想编写复杂的log4j.properties，可以使用Log4j提供的默认配置，在获取Logger前使用以下代码加载默认配置：BasicConfigurator.configure();
• 查看configure()方法的源码：

/**
   Add a {@link ConsoleAppender} that uses {@link PatternLayout}
   using the {@link PatternLayout#TTCC_CONVERSION_PATTERN} and
   prints to <code>System.out</code> to the root category.  */
static
public
void configure() {
  Logger root = Logger.getRootLogger();
  root.addAppender(new ConsoleAppender(
         new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN)));
}

• 古早时期的源码格式有点不太现代，但意义明确：为RootLogger对象添加一个Appender，其中Appender的类型为控制器输出的ConsoleAppender，输出的格式使用PatternLayout.TTCC_CONVERSION_PATTERN。
• 以下为PatternLayout.TTCC_CONVERSION_PATTERN源码：

/** A conversion pattern equivalent to the TTCCCLayout.
    Current value is <b>%r [%t] %p %c %x - %m%n</b>. */
public final static String TTCC_CONVERSION_PATTERN
                                           = "%r [%t] %p %c %x - %m%n";

• 关于PatternLayout的相关格式化规则，后续会列举出来。
• 于是，使用以下代码加载默认配置并输出日志：

@Test
public void testQuick() {
    // 1.初始化配置信息，使用默认的配置，如果不加载默认配置同时不具有log4j.properties配置文件，程序将发出警告
    BasicConfigurator.configure();

    // 2.获取日志记录器对象Logger
    Logger logger = Logger.getLogger(Log4jTest.class);

    // 3.日志记录输出
    logger.info("Hey, log4j.");
}

• 此时控制台输出为：

日志级别

• Log4j中的日志级别与JUL的不同，一共提供了6中日志级别：
  1. FATAL：严重错误，一般会造成系统崩溃并终止运行；
  2. ERROR：错误信息，不会影响系统运行；
  3. WARN：警告信息，可能会发生问题；
  4. INFO：运行信息，数据连接、网络连接、I/O操作等等；
  5. DEBUG：调试信息，一般在开发中使用，记录程序变量参数传递信息等等。默认级别；
  6. TRACE：追踪信息，记录程序所有的流程信息。
• 参考以下示例代码：

@Test
public void testQuick() {
    // 1.初始化配置信息，使用默认的配置，如果不加载默认配置同时不具有log4j.properties配置文件，程序将发出警告
    BasicConfigurator.configure();

    // 2.获取日志记录器对象Logger
    Logger logger = Logger.getLogger(Log4jTest.class);

    // 3.日志级别测试
    logger.fatal("[FATAL] 严重错误，一般会造成系统崩溃并终止运行。");
    logger.error("[ERROR] 错误信息，不会影响系统运行。");
    logger.warn("[WARN] 警告信息，可能会发生问题。");
    logger.info("[INFO] 运行信息，数据连接、网络连接、I/O操作等等。");
    logger.debug("[DEBUG] 调试信息，一般在开发中使用，记录程序变量参数传递信息等等。默认级别。");
    logger.trace("[TRACE] 追踪信息，记录程序所有的流程信息。");
}

• 运行输出，得到：

• 输出的日志仍然由默认的日志级别所决定，其中默认级别为DEBUG。
• 为了测试默认日志级别，可以使用以下代码测试RootLogger：
  1. 使用getRootLogger()获取RootLogger对象；
  2. 使用RootLogger中的相关方法获取日志对象的日志等级及其关联的Appender详情。

@Test
public void testDetails() {
    // 1.初始化配置信息，使用默认的配置，如果不加载默认配置，将无法正常运行
    BasicConfigurator.configure();

    // 2.获取日志记录器对象RootLogger
    final Logger rootLogger = Logger.getRootLogger();

    // 3.输出配置详情
    System.out.println("Logger level: " + rootLogger.getLevel());
    final Enumeration allAppenders = rootLogger.getAllAppenders();
    while (allAppenders != null && allAppenders.hasMoreElements()) {
        final Appender appender = (Appender) allAppenders.nextElement();
        System.out.println("Appender is: " +appender.getClass().getSimpleName());
    }
}

• 运行输出：

• 注意，对于Log4j中的Appender来说，它们不具有日志等级，只有Logger对象具有日志等级。

Log4j相关组件

• Log4J主要由Loggers (日志记录器)、Appenders（输出端）和Layout（日志格式化器）组成：
  • Loggers：控制日志的输出级别与日志是否输出；
  • Appenders：指定日志的输出方式（输出到控制台、文件等）；
  • Layout：控制日志信息的输出格式。

a. Logger

• 日志记录器，负责收集处理日志记录，Logger的实例命名通常是类的全限定类名。
• Logger的名字大小写敏感，其命名有继承机制。
  • 例如：name为org.apache.commons的logger会继承name为org.apache的logger。
• 自log4j 1.2版以来， Logger类已经取代了Category类。对于熟悉早期版本的log4j的人来说，Logger类可以被视为Category类的别名。

b. Appenders

• Appender用来指定日志输出到哪个地方，可以同时指定日志的输出目的地。
• Log4j常用的输出目的地有以下几种：

输出端类型	作用
ConsoleAppender	将日志输出到控制台
FileAppender	将日志输出到文件中
DailyRollingFileAppender	将日志输出到一个日志文件，周期为天，即每天输出
RollingFileAppender	将日志信息输出到一个日志文件，并且指定文件的大小，当超过指定大小，会自动将文件重命名，同时产生一个新的文件
JDBCAppender	将日志信息保存到数据库中

c. Layouts

• 布局器Layouts用于控制日志输出内容的格式，我们可以使用各种自定义格式输出日志。
• Log4j常用的Layouts有以下几种:

格式化器类型	作用
HTMLLayout	格式化日志输出为HTML表格形式
SimpleLayout	简单的日志输出格式，打印的日志格式为info-message
PatternLayout	最强大的格式化方式，可以根据自定义格式输出日志，如果没有指定转换格式，则使用默认的转换格式

• PatternLayout中的格式化规则：

* log4j采用类似C语言的printf函数的打印格式格式化日志信息，具体的占位符及其含义如下：
    %m 	输出代码中指定的日志信息
    %p 	输出优先级，及DEBUG、INFO等
    %n 	换行符（Windows平台的换行符为"\n"，Unix平台为"\n"）
    %r 	输出自应用启动到输出该 log 信息耗费的毫秒数
    %c 	输出打印语句所属的类的全名
    %t 	输出产生该日志的线程全名
    %d 	输出服务器当前时间，默认为ISO8601，也可以指定格式，如：%d{yyyy年MM月dd日 HH:mm:ss}
    %l 	输出日志时间发生的位置，包括类名、线程、及在代码中的行数。如：Test.main(Test.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字符，就从左边交远销出的字符截掉

自定义配置

• 使用Log4j不需要显式地加载配置文件，对于Maven项目来说，程序会自动扫描resources目录下的log4j.properties配置文件。

• 自定义配置如下：

  1. 日志输出等级为INFO，此时RootLogger拥有三个Appender：
     1. ConsoleAppender：配置中的命名为Console；
     2. DailyRollingFileAppender：配置中的命名为UserDefinedName；
     3. JDBCAppender：配置中的命名为logDB。
  2. RootLogger的默认输出级别配置在log4j.rootLogger的首位，随后紧跟的是关联的Appender的名称，表示其默认支持输出的方式有哪些。

# 指定日志的输出级别与输出端
log4j.rootLogger=INFO, Console, UserDefinedName, logDB

# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n

# 文件输出配置
log4j.appender.UserDefinedName=org.apache.log4j.DailyRollingFileAppender
# 指定日志的输出路径
log4j.appender.UserDefinedName.File=log4j.log
# 是否以追加日志的形式添加
log4j.appender.UserDefinedName.Append=true
# 使用自定义日志格式化器
log4j.appender.UserDefinedName.layout=org.apache.log4j.PatternLayout
# 指定日志的输出格式
log4j.appender.UserDefinedName.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
# 指定日志的文件编码
log4j.appender.UserDefinedName.encoding=UTF-8

# MySQL输出配置
log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.cj.jdbc.Driver
log4j.appender.logDB.URL=jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&useAffectedRows=true
log4j.appender.logDB.User=root
log4j.appender.logDB.Password=root
log4j.appender.logDB.Sql=INSERT INTO log(project_name, create_date, level, category, file_name, thread_name, line, all_category, message) \
  values('log4j', '%d{yyyy-MM-dd HH:mm:ss}', '%p', '%c', '%F', '%t', '%L', '%l', '%m')

• 配置中包含了sql输出日志的方式，log表的创建代码为：

CREATE TABLE `log` (
	`log_id` INT ( 11 ) NOT NULL AUTO_INCREMENT,
	`project_name` VARCHAR ( 255 ) DEFAULT NULL COMMENT '项目名称',
	`create_date` VARCHAR ( 255 ) DEFAULT NULL COMMENT '创建时间',
	`level` VARCHAR ( 255 ) DEFAULT NULL COMMENT '优先级',
	`category` VARCHAR ( 255 ) DEFAULT NULL COMMENT '所在类的全名',
	`file_name` VARCHAR ( 255 ) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ',
	`thread_name` VARCHAR ( 255 ) DEFAULT NULL COMMENT '日志事件的线程名',
	`line` VARCHAR ( 255 ) DEFAULT NULL COMMENT '行号',
	`all_category` VARCHAR ( 255 ) DEFAULT NULL COMMENT '日志事件的发生位置',
	`message` VARCHAR ( 4000 ) DEFAULT NULL COMMENT '输出代码中指定的消息',
	PRIMARY KEY ( `log_id` ) 
);

• 让特定名称的logger使用特定的配置：
  1. 一个log4j.properties中可以配置多个且可重复的Appender，但Appender的命名不可重复；
  2. 通过log4j.logger.{loggerName}的方式，让指定名为loggerName的logger使用该配置；
  3. 由于该logger仍然是隶属于rootLogger，因此输出是累加的形式：
     • 例：如果RootLogger使用了ConsoleAppender，同时Logger也使用了ConsoleAppender，此时控制台将输出两次日志记录，一次为Logger继承自RootLogger的输出，另一次则为Logger自身的输出。
  4. 但日志等级level则取决于子日志Logger与RootLogger，以等级高的一方为准。
     • 例：此时RootLogger和Logger同时使用了ConsoleAppender，但输出等级分别为INFO和WARN，此时控制台输出的日志等级仅有高于等于WARN的记录，即使此时RootLogger的等级为INFO。
• 有如下log4j.properties配置文件：
  • 其中RootLogger和名为cn.hanna的Logger使用同一个ConsoleAppender，但日志等级不一致。

# 指定日志的输出级别与输出端
log4j.rootLogger=INFO, Console

# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n

# 让名为“cn.hanna”的logger使用名为Another的Appender
# 此时仍会使用rootLogger中的控制台输出，而Level则以两者间较高的为准
log4j.logger.cn.hanna=WARN, Console

• 测试代码如下：

@Test
public void testAnother() {
    // 1.获取日志记录器对象Logger
    Logger logger = Logger.getLogger("cn.hanna");

    // 2.日志级别测试
    logger.fatal("[FATAL] 严重错误，一般会造成系统崩溃并终止运行。");
    logger.error("[ERROR] 错误信息，不会影响系统运行。");
    logger.warn("[WARN] 警告信息，可能会发生问题。");
    logger.info("[INFO] 运行信息，数据连接、网络连接、I/O操作等等。");
    logger.debug("[DEBUG] 调试信息，一般在开发中使用，记录程序变量参数传递信息等等。默认级别。");
    logger.trace("[TRACE] 追踪信息，记录程序所有的流程信息。");
}

• 运行输出：

• 输出印证了之前所陈述的观点，不再赘述。
• 此时，如果一定需要使用ConsoleAppender，但不希望控制台输出两次记录，有两种方式：
  1. 摒弃RootLogger的输出，即断开指定Logger与RootLogger的继承关系；
  2. 摒弃Logger的输出，即指定名称的Logger直接使用RootLogger关联的Appender，不再额外指定。
• 如果选择断开指定Logger与RootLogger的继承关系，需修改配置文件如下：

# 指定日志的输出级别与输出端
log4j.rootLogger=INFO, Console

# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n

# 名为“cn.hanna”的Logger不再继承使用RootLogger中的Appender
log4j.additivity.cn.hanna=false
log4j.logger.cn.hanna=WARN, Console

• 如果选择直接使用RootLogger关联的Appender，需修改配置文件如下：

# 指定日志的输出级别与输出端
log4j.rootLogger=INFO, Console

# 控制台输出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n

# 对于名称“cn.hanna”的Logger来说，将直接使用RootLogger中关联的Appender，但日志等级由自身决定
log4j.logger.cn.hanna=WARN

• 两种方式的测试类运行结果均为：

• 实际应用中，应该灵活选择适合与代码的方式，去编写配置文件。

完整的配置文件示例

• 同样，在此给出一个完整的log4j配置文件示例：

log4j.rootLogger=INFO, Console

log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n

log4j.appender.UserDefinedName=org.apache.log4j.DailyRollingFileAppender
log4j.appender.UserDefinedName.File=log4j.log
log4j.appender.UserDefinedName.Append=true
log4j.appender.UserDefinedName.layout=org.apache.log4j.PatternLayout
log4j.appender.UserDefinedName.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
log4j.appender.UserDefinedName.encoding=UTF-8

log4j.appender.logDB=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.logDB.layout=org.apache.log4j.PatternLayout
log4j.appender.logDB.Driver=com.mysql.cj.jdbc.Driver
log4j.appender.logDB.URL=jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&useAffectedRows=true
log4j.appender.logDB.User=root
log4j.appender.logDB.Password=root
log4j.appender.logDB.Sql=INSERT INTO log(project_name, create_date, level, category, file_name, thread_name, line, all_category, message) \
  values('log4j', '%d{yyyy-MM-dd HH:mm:ss}', '%p', '%c', '%F', '%t', '%L', '%l', '%m')

log4j.appender.Another=org.apache.log4j.DailyRollingFileAppender
log4j.appender.Another.File=hanna.log
log4j.appender.Another.Append=true
log4j.appender.Another.layout=org.apache.log4j.PatternLayout
log4j.appender.Another.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t:%r] - [%p] %m%n
log4j.appender.Another.encoding=UTF-8

log4j.logger.cn.xyz=WARN, Another
log4j.additivity.cn.xyz=false

• 说明：其中log4j.appeder.APPENDER_NAME中的APPENDER_NAME为相应Appender的名称，可以自行定义。

总结

• Log4j日志框架近似于JUL日志框架，但功能性上要优于JUL。