五分钟秒懂Java日志组件

Java中有许多种日志记录方式，有些API有占位符，有些API没占位符，初学的人可能会搞不清楚这些日志组件的由来。我一开始的时候也是很懵逼的，后来一点点弄懂了于是就又了这篇文章。

在Java中进行日志记录常见有三种方式，分别是JDKLog、Log4J、LogBack。

一、JDKLog

JDKLog记录方式是JDK官方提供的一个记录日志的方式，直接在JDK中就可以使用。但JDKLog其功能比较简单，现在用的人也很少。

import java.util.logging.Logger;

/**
 * JDKLog Demo
 */
public class JDKLog
{
    public static void main( String[] args )
    {
        Logger logger = Logger.getLogger("JDKLog");
        logger.info("Hello World.");
    }
}

二、LOG4J

LOG4J 是 Apache 的一个日志开源框架，使用的人数也不少，有多个分级（DEBUG/INFO/WARN/ERROR）记录，但LOG4J本身不支持使用占位符，这给日志记录带来了极大的不便。虽然LOG4J确实有一些不便之处，但是LOG4J已经能够满足很多项目的需求，如果把JDKLog比喻成一把小刀的话，那么LOG4J就是一把手枪了。

LOG4J 有 1.X 版本和 2.X 版本，现在官方推荐使用 2.X 版本，2.X 版本在架构上进行了一些升级，配置文件也发生了一些变化，但好在官方的配置说明文档非常清楚。下面我们就以 LOG4J 2.6.2 为例来介绍如何使用 LOG4J。

使用 LOG4J 2.6.2 首先需要导入所依赖的两个 Jar 包：

<!-- Log4J -->
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
  <version>2.6.2</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.6.2</version>
</dependency>

增加配置文件 log4j2.xml 放在 resource 目录下：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

<Root>节点的 level 属性表示输出的最低级别。

编写测试类：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
 * Log4J Demo
 */
public class Log4jLog {
    public static void main(String args[]) {
        Logger logger = LogManager.getLogger(Log4jLog.class);
        logger.debug("Debug Level");
        logger.info("Info Level");
        logger.warn("Warn Level");
        logger.error("Error Level");
    }
}

运行测试类输出结果：

10:16:08.279 [main] INFO  com.chanshuyi.Log4jLog - Info Level
10:16:08.280 [main] WARN  com.chanshuyi.Log4jLog - Warn Level
10:16:08.280 [main] ERROR com.chanshuyi.Log4jLog - Error Level

如果没有配置 log4j2.xml 配置文件，那么LOG4J讲自动启用类似于下面的的配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

输出结果：

ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.
11:40:07.377 [main] ERROR com.chanshuyi.Log4jLog - Error Level

如果你没有配置文件，那么控制台会输出提示你没有编写配置文件。

三、LogBack

LogBack 可以对比起 Log4J 有更快的运行速度，更好的内部实现，并且 LogBack 内部集成了 SLF4J 可以更原生地实现一些日志记录的实现。如果说 Log4J 是手枪的话，那么 LogBack 就是步枪，大大提高了日志记录的效率。

使用 LogBack 需要首先引入依赖：

<!-- LogBack -->
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.1.7</version>
</dependency>

配置 logback.xml 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
    </appender>
    <logger name="com.chanshuyi" level="TRACE"/>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

LogBack 的日志级别区分可以细分到类或者包，这样就可以使日志记录变得更加灵活。之后在类文件中引入Logger类，并进行日志记录：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * LogBack Demo
 */
public class LogBack {
    static final Logger logger = LoggerFactory.getLogger(LogBack.class);
    public static void main(String[] args) {
        logger.trace("Trace Level.");
        logger.debug("Debug Level.");
        logger.info("Info Level.");
        logger.warn("Warn Level.");
        logger.error("Error Level.");
    }
}

输出结果：

14:34:45.747 [main] TRACE com.chanshuyi.LogBack - Trace Level.
14:34:45.749 [main] DEBUG com.chanshuyi.LogBack - Debug Level.
14:34:45.749 [main] INFO  com.chanshuyi.LogBack - Info Level.
14:34:45.749 [main] WARN  com.chanshuyi.LogBack - Warn Level.
14:34:45.749 [main] ERROR com.chanshuyi.LogBack - Error Level.

但掌握了上面几种日志记录组件还不够，有时候一些项目因为各种原因使用的是LOG4J记录组件，代码中写了许多LOG4J方式的代码。此时如果要转到LogBack日志组件方式就会很痛苦，我们总不能把之前所有的日志代码方法都改一下吧。这时候就可以用各种日志转接包，将JDKLog、LOG4J统一使用LogBack 输出。这就是下一篇要说的：2.日志组件的统一门面

参考资料：

[1]Log4j – Configuring Log4j 2 - Apache Log4j 2. [DB/OL]. https://logging.apache.org/log4j/2.x/manual/configuration.html, 2016-07-15

[2]Reasons to prefer logback over log4j. [DB/OL]. http://logback.qos.ch/reasonsToSwitch.html, 2016-07-15

[3]How to setup SLF4J and LOGBack in a web app - fast. [DB/OL]. https://wiki.base22.com/display/btg/How+to+setup+SLF4J+and+LOGBack+in+a+web+app+-+fast, 2016-07-15