java logger slf4j_Java Logger Java 日志功能概述

在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会相应的在项目中实现和构建我们所需要的日志框架。

而市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？

日志接口与日志实现

通常情况下，日志是由一个抽象层+实现层的组合来搭建的。

日志接口

日志实现

JCL、SLF4J、jboss-logging

jul、log4j、log4j2、logback

image.png

Java标准库内置日志包 java.util.logging

public class Hello {

public static void main(String[] args) {

Logger logger = Logger.getGlobal();

logger.info("start process...");

logger.warning("memory is running out...");

logger.fine("ignored.");

logger.severe("process will be terminated...");

}

}

JDK的Logging定义了7个日志级别，默认级别是INFO,从严重到普通：

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

优点：

使用简单；

内置；

缺点：

Logging系统在JVM启动时读取配置文件并完成初始化，一旦开始运行main()方法，就无法修改配置；

配置不太方便，需要在JVM启动时传递参数-Djava.util.logging.config.file=

Apache 日志接口 Commons Logging

Commons Logging可以作为“日志接口”,默认情况下，Commons Loggin自动搜索并使用Log4j，如果没有找到Log4j，再使用JDK Logging.

//在静态方法中引用Log:

public class Main {

public static void main(String[] args) {

Log log = LogFactory.getLog(Main.class);

log.info("start...");

log.warn("end.");

}

}

//在实例方法中引用Log:

public class Person {

protected final Log log = LogFactory.getLog(getClass());

void foo() {

log.info("foo");

}

}

注意到实例变量log的获取方式是LogFactory.getLog(getClass())，虽然也可以用LogFactory.getLog(Person.class)，但是前一种方式有个非常大的好处，就是子类可以直接使用该log实例.

Commons Logging的日志方法，例如info()，除了标准的info(String)外，还提供了一个非常有用的重载方法：info(String, Throwable)，这使得记录异常更加简单：

try {

...

} catch (Exception e) {

log.error("got exception!", e);

}

Commons Logging定义了6个日志级别,默认级别是INFO：

FATAL

ERROR

WARNING

INFO

DEBUG

TRACE

Log4j 和 Log4J2

Log4j是一个组件化设计的日志系统，它的架构大致如下：

image.png

当我们使用Log4j输出一条日志时，Log4j自动通过不同的Appender把同一条日志输出到不同的目的地。例如：

console：输出到屏幕；

file：输出到文件；

socket：通过网络输出到远程计算机；

jdbc：输出到数据库；

在输出日志的过程中，通过Filter来过滤哪些log需要被输出，哪些log不需要被输出。例如，仅输出ERROR级别的日志。

最后，通过Layout来格式化日志信息，例如，自动添加日期、时间、方法名称等信息。

以XML配置为例，使用Log4j的时候，我们把一个log4j2.xml的文件放到classpath下就可以让Log4j读取配置文件并按照我们的配置来输出日志。下面是一个配置文件的例子：

%d{MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36}%n%msg%n%n

log/err.log

log/err.%i.log.gz

log4j2是重新架构的一款日志组件，他抛弃了之前log4j的不足，以及吸取了优秀的logback的设计重新推出的一款新组件。log4j2的社区活跃很频繁而且更新的也很快。

SLF4J和Logback

SLF4J类似于Commons Logging，也是一个日志接口，而Logback类似于Log4j，是一个日志的实现;

对比一下Commons Logging和SLF4J的接口：

Commons Logging

SLF4J

org.apache.commons.logging.Log

org.slf4j.Logger

org.apache.commons.logging.LogFactory

org.slf4j.LoggerFactory

slf4j绑定各类日志系统原理图：

image.png

Logback的配置文件:

%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

utf-8

log/output.log

log/output.log.%i

1MB

Spring Framework 中的日志框架

SpringBoot：底层是Spring框架，而Spring框架默认选用的日志框架是用JCL(commons-logging)；而 SpringBoot框架默认选用的是SLF4j和logback；这样能够兼容是因为：springboot已经把spring框架的默认日志依赖移除掉了：

springboot的默认日志选择

日志接口使用：

Spring

Hibernate

Springboot

commons-logging

jboss-logging

slf4j

当我们在使用SpringBoot时，同样可能还会调用其他的框架，比如：Spring+Mybatis等等，这些框架中都有自己底层的日志框架在使用，所以，我们需要在引用的同时，将他们的日志框架排除掉即可，见上图springboot的默认日志选择。

总结：

厘清日志接口与日志实现；

由于 Spring Boot 的流行度，建议使用SLF4j和logback组合；

如果其他保重已有日志库，可以使用 exclusions 移除依赖；

参考：