Log4j 和 Log4j2

Log4j 是一个 JAVA 应用日志框架。 Log4j2 是它的第二个版本。

使用 log4j2 需要在 classpath 下提供一个 log4j2.xml 配置文件。

使用 log4j2 需要导入的包：

log4j-api

log4j-core

如果是通过 slf4j 『间接』使用 log4j2，那么还需要导入：

slf4j-api

log4j-slf4j-impl

通常情况下，都是通过 slf4j 间接使用 log4j（或其他日志框架，如：logback），而非直接使用 log4j。具体内容及原因在 slf4j 处讲解。

文件基本格式如下：

一、Log4j2 的基本使用

Log4j 由三个重要的组件构成：

日志信息的优先级

日志信息的优先级从高到低有 ERROR、WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度。

日志信息的输出目的地

指定日志将打印到控制台，还是 文件中，或其他地方。

日志信息的输出格式

设置日志信息的显示内容

二、定义配置文件

输出目的地 Appender

其语法为：


       ... 
          ... 
   ...

常见的 输出目的地 有

Console：表示日志信息输送到控制台。

File：表示日志信息输送到一个文件中。

RollingFile：表示日志信息输送到一个滚动文件中。

日志输出格式 PatternLayout

其语法为：

log4j 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息。

基本的打印参数有：

占位符	说明
`%d` or `%date`	日志生产时间
	`%d{DEFAULT}` 2012-11-02 14:34:02,123
	`%d{DEFAULT_MICROS}` 2012-11-02 14:34:02,123456
	`%d{DEFAULT_NANOS}` 2012-11-02 14:34:02,123456789
	`%d{yyy-MM-dd HH:mm:ss}` 2012-11-02 14:34:02
	`%d{yyy-MM-dd HH:mm:ss,SSS}` 2012-11-02 14:34:02,123
`%t` or `%thread`	输出当前线程名称
`%p` or `%level`	输出日志级别，-5 表示左对齐并且固定输出 5 个字符，如果不足在右边补 0
`%m` or `%msg`	输出日志的内容
%n	换行符

其它常见的打印参数有：

占位符	说明
`%c` or `%logger`	输出 logger 的名称。这个名称就是创建 Logger 对象时所传入的字符串
	`%c{1}`：org.apache.commons.Foo 输出 `Foo`
	`%c{2}`：org.apache.commons.Foo 输出 `commons.Foo`
	`%c{10}`：org.apache.commons.Foo 输出 `org.apache.commons.Foo`
	`%c{1.}`：org.apache.commons.Foo 输出 `o.a.c.Foo`
	`%c{1.1.~.~}`：org.apache.commons.test.Foo 输出 `o.a.~.~.Foo`
	`%c{.}`：org.apache.commons.test.Foo 输出 `....Foo`
`%C` or `%class`	输出打印 Java 类名的全名。格式的长度设置与 %logger 类似
`%L` or `%line`	输出行号
`%M` or `%method`	方法名
hostName	本地机器名
hostAddress	本地ip地址

参见配置组合有（为便于理解，简写形式已全改为全写形式）：

%date %level %class{1.} [%thtread] %msg%n

%date [%thread] %-5level [%logger] - %msg%n

%class{1}.%method %msg %ex%n

[%date{HH:mm:ss.SSS}][%thread][%level][%class][%line]:%msg%n

%-date [%thread] [%class:%line] - [%level] %msg%n

%date [%thread] %-5level %logger{36} - %msg%n

%date [%thread] %class %method %l- %-5level %logger{36} %msg%n

%date %5level --- [%t] %-40.40c{1.} : %m%n%xwEx

%date [%t] %-5level %logger{36} - %msg%n

%date{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %line %method - %msg%xEx%n

详细配置参见官方文档：http://logging.apache.org/log4j/2.x/manual/layouts.html

启用及其相关配置

这里的元素表示设置一个根元素，表示默认情况下，所有的日志输出都符合其下的设置。

是一个特例，即指定特定包或者类的日志输出规则。除此之外的，按 Root 的输出来。

因为 com.foo.Bar 没有自己的 Appender，所以会使用 ROOT 的 Appender，如果自己也配置了在控制台打印，就要注意可加性：如下配置，会 ERROR 以上的会打印两次。

如果我们不想遵循父类的 Appender，可以加上 additivity="false" 参数。

三、简单示例

一个更复杂的样例

SLF4j

Log4j 不是唯一的日志工具库，与之齐名的还有 commons-logging 库，除此之外市面上还有各种各样形形色色的日志工具库，它们各自都各有特色。

从出现的先后时间上来看，出现过的日志工具/库先后有：java.util.logging -> commons-logging -> log4j -> logback -> log4j2

这就为引入了一个新的问题，如果一个项目不是由一个人（甚至不是由一个公司）开发，那么参与开发的各方可能根据自己的需要、喜好和习惯使用不同的日志库，从而导致了日志库的使用不统一。

SLF4j 的出现就是为了解决这个问题，SLF4J 并不是一个“新的”日志库，SLF4J 希望用户调用它的方法，而它再去调用某个具体的日志库。从而实现日志代码的统一。

如果你的 SLF4J“最终”使用的是 Log4j 那么你的项目中仍然需要加入 Log4j 的包和 log4j.properties 配置文件。

在 SLF4J 中获得 Logger 对象的方式是：

LoggerFactory.getLogger()

SLF4J 一个非常好的功能是，它提供了占位符（使用{}）的概念，以方便与在输出信息中“插入”数据。

logger.info("Hello {} World {}", 100, "Goodbye");

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name 一般取本类的名字，比如：

static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName());

slf4j 打印异常的堆栈信息：

logger.error("错误消息：{}", e.getMessage(), e);    // 注意，这里只需要有一个 {} 。

如何正确打印日志

一、使用 slf4j

使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
实现方式统一使用: Log4j2 或 Logback 框架

二、打日志的正确方式

1. 什么时候应该打日志

当你遇到问题的时候，只能通过 debug 功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定为的。
当你碰到 if…else... 或者 switch 这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支
经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程

2. 日志的基本格式

必须使用参数化信息的方式:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

对于 debug 日志，必须判断是否为 debug 级别后，才进行使用:

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
}

不要进行字符串拼接，那样会产生很多 String 对象，占用空间，影响性能。

反例 / 不要这么做：

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);

3. 使用 `[]` 进行参数变量隔离

如有参数变量，应该写成如下写法:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

这样的格式写法，可读性更好，对于排查问题更有帮助。

三、不同级别的日志的使用

1. ERROR 级别日志

使用 ERROR 的场景：影响到程序正常运行、当前请求正常运行的异常情况

打开配置文件失败
所有第三方对接的异常(包括第三方返回错误码)
所有影响功能使用的异常，包括：SQLException 和除了业务异常之外的所有异常（RuntimeException 和 Exception）

另外，如果有 Throwable 信息，需要记录完成的堆栈信息:

log.error("获取用户[{}]的用户信息时出错", userName, e);

但是，如果进行了抛出异常操作，请不要记录 error 日志，由最终处理方进行处理：

反例 / 不要这么做：

try {
    ....
} catch(Exception e) {
    logger.error(...);
    throw new UserServiceException(errorMessage,ex);
}

2. WARN 级别日志

使用在不应该出现但是不影响程序/当前请求正常运行的异常情况:

有容错机制的时候出现的错误情况
找不到配置文件，但是系统能自动创建配置文件
即将接近临界值的时候
业务异常的记录

3. INFO 级别日志

场景一：用于记录系统运行信息：

Service 方法中对于系统/业务状态的变更

主要逻辑中的分步骤

需要说明的是：并不是所有的 service 都进行出入口打点记录，单一、简单 service 是没有意义的（job 除外，job 需要记录开始和结束）。

反例 / 不要这么做：

public List listByBaseType(Integer baseTypeId) {

    log.info("开始查询xxx");

    ...
    ...
    ...
    ...

    log.info("查询xxx结束");

    return ...;
}

场景二：用于外部接口部分：

客户端请求参数（REST/WS）

调用第三方时的调用参数和调用结果

需要说明的是：

对于整个系统的提供出的接口（REST/WS），使用 info 记录入参；

调用其他第三方服务时，所有的出参和入参是必须要记录的（因为你很难追溯第三方模块发生的问题）

3. DEBUG 级别日志

可以填写所有的想知道的相关信息（但不代表可以随便写，debug 信息要有意义,最好有相关参数）
生产环境需要关闭 DEBUG 信息
如果在生产情况下需要开启 DEBUG，需要使用开关进行管理，不能一直开启。

4. TRACE 级别日志

特别详细的系统运行完成信息，业务代码中，不要使用。（除非有特殊用意，否则请使用 DEBUG 级别替代）

规范示例说明

@Override
@Transactional
public void createUserAndBindMobile(String mobile, User user) throws CreateConflictException {

    boolean debug = log.isDebugEnabled();

    if (debug) {
        log.debug("开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
    }

    try {
        user.setCreateTime(new Date());
        user.setUpdateTime(new Date());
        userRepository.insertSelective(user);
        if (debug) {
            log.debug("创建用户信息成功. insertedUser=[{}]",LogObjects.toString(user));
        }

        UserMobileRelationship relationship = new UserMobileRelationship();
        relationship.setMobile(mobile);
        relationship.setOpenId(user.getOpenId());
        relationship.setCreateTime(new Date());
        relationship.setUpdateTime(new Date());
        userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
        if (debug) {
            log.debug("绑定手机成功. relationship=[{}]",LogObjects.toString(relationship));
        }

        log.info("创建用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile); // 如果考虑安全，手机号记得脱敏
    } catch(DuplicateKeyException e) {
        log.info("创建用户并绑定手机号失败,已存在相同的用户. openId=[{}],mobile=[{}]",user.getOpenId(),mobile);
        throw new CreateConflictException("创建用户发生冲突, openid=[%s]",user.getOpenId());
    }
}

log4j2

Log4j 和 Log4j2

一、Log4j2 的基本使用

二、定义配置文件

输出目的地 Appender

日志输出格式 PatternLayout

启用及其相关配置

三、简单示例

一个更复杂的样例

SLF4j

如何正确打印日志

一、使用 slf4j

二、打日志的正确方式

1. 什么时候应该打日志

2. 日志的基本格式

3. 使用 [] 进行参数变量隔离

三、不同级别的日志的使用

1. ERROR 级别日志

2. WARN 级别日志

3. INFO 级别日志

3. DEBUG 级别日志

4. TRACE 级别日志

规范示例说明

你可能感兴趣的:(log4j2)

3. 使用 `[]` 进行参数变量隔离