Log4j,logback,slf4j日志框架比较

时间  2019-11-06 标签 log4j log logback slf4j slf 日志 框架 比较

Log4j

Log4j是Apache的一个开放源代码项目，经过使用Log4j，咱们能够控制日志信息输送的目的地是控制台、文件、数据库等；咱们也能够控制每一条日志的输出格式；经过定义每一条日志信息的级别，咱们可以更加细致地控制日志的生成过程。 
Log4j有7种不一样的log级别，按照等级从低到高依次为：TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF。若是配置为OFF级别，表示关闭log。 
Log4j支持两种格式的配置文件：properties和xml。包含三个主要的组件：Logger、appender、Layout。java

控制台输出 
经过以下配置，设定root日志的输出级别为INFO，appender为控制台输出stdoutmysql

# LOG4J配置
log4j.rootLogger=INFO,stdout
# 控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

输出到文件 
在开发环境，咱们只是输出到控制台没有问题，可是到了生产或测试环境，或许持久化日志内容，方便追溯问题缘由。能够经过添加以下的appender内容，按天输出到不一样的文件中去，同时还须要为log4j.rootLogger添加名为file的appender，这样root日志就能够输出到logs/springboot.log文件中了。输出到文件和输出到控制台是能够并行存在的。web

# LOG4J配置
log4j.rootLogger=INFO,stdout,file
# 日志输出到文件
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.file=logs/springboot.log
log4j.appender.file.DatePattern='.'yyyy-MM-dd
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n
1

分类输出 
当咱们日志量较多的时候，查找问题会很是困难，经常使用的手段就是对日志进行分类，好比： 
能够按不一样package进行输出。经过定义输出到logs/my.log的appender，并对com.test包下的日志级别设定为DEBUG级别、appender设置为输出到logs/my.log的名为testlog的appender。spring

# com.test包下的日志配置
log4j.logger.com.test=DEBUG, testlog
# com.test下的日志输出
log4j.appender.testlog=org.apache.log4j.DailyRollingFileAppender
log4j.appender.testlog.file=logs/my.log
log4j.appender.testlog.DatePattern='.'yyyy-MM-dd
log4j.appender.testlog.layout=org.apache.log4j.PatternLayout
log4j.appender.testlog.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n
 

能够对不一样级别进行分类，好比对ERROR级别输出到特定的日志文件中，具体配置能够以下：​​​​​sql

# LOG4J配置
log4j.rootCategory=INFO, stdout,errorfile
log4j.logger.error=errorfile

# error日志输出
log4j.appender.errorfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorfile.file=logs/error.log
log4j.appender.errorfile.DatePattern='.'yyyy-MM-dd
log4j.appender.errorfile.Threshold = ERROR
log4j.appender.errorfile.layout=org.apache.log4j.PatternLayout
log4j.appender.errorfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n %5p %c{1}:%L - %m%n

输出到数据库 
将日志文件输出到数据库配置：数据库

\# LOG4J配置
log4j.rootCategory=INFO,stdout,jdbc

\# 数据库输出
log4j.appender.jdbc=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.jdbc.driver=com.mysql.jdbc.Driver
log4j.appender.jdbc.URL=jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8&useSSL=true
log4j.appender.jdbc.user=root
log4j.appender.jdbc.password=root
log4j.appender.jdbc.sql=insert into log_icecoldmonitor(level,category,thread,time,location,note) values('%p','%c','%t','%d{yyyy-MM-dd HH:mm:ss:SSS}','%l','%m')

引入数据库驱动：apache

<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>

建立表：​​​​​​​springboot

CREATE TABLE `log_icecoldmonitor` (
`Id` int(11) NOT NULL AUTO_INCREMENT,
`level` varchar(255) NOT NULL DEFAULT '' COMMENT '优先级',
`category` varchar(255) NOT NULL DEFAULT '' COMMENT '类目',
`thread` varchar(255) NOT NULL DEFAULT '' COMMENT '进程',
`time` varchar(30) NOT NULL DEFAULT '' COMMENT '时间',
`location` varchar(255) NOT NULL DEFAULT '' COMMENT '位置',
`note` text COMMENT '日志信息',
PRIMARY KEY (`Id`)
)

这样就能够保存到日志到数据库了，可能会出现以下异常信息： 
Java链接Mysql数据库警告：Establishing SSL connection 
缘由是MySQL在高版本须要指明是否进行SSL链接。解决方案以下： 
在mysql链接字符串url中加入ssl=true或者false便可，以下所示。 
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8&useSSL=trueapp

应用

  1. 引入log4j依赖 
    在建立Spring Boot工程时，咱们引入了spring-boot-starter，其中包含了spring-boot-starter-logging，该依赖内容就是Spring Boot默认的日志框架Logback，因此咱们在引入log4j以前，须要先排除该包的依赖，再引入log4j的依赖。​​​​​​​ 
    <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j</artifactId>
</dependency>

     

值得注意的是，spring boot 1.3版本支持log4j，在spring boot 1.4的版本中，就须要使用log4j2，不然会出现以下错误：Project build error: 'dependencies.dependency.version' for org.springframework.boot:spring-boot-starter-log4j:jar is missing.框架

  1. 配置log4j-spring.properties 
    在引入了log4j依赖以后，只须要在src/main/resources目录下加入log4j.properties（或log4j-spring.properties）配置文件，就能够开始对应用的日志进行配置使用。测试配置内容以下： 
    # DEBUG INFO WARN ERROR FATAL
log4j.rootLogger = info,stdout,errorlogfile

log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Threshold = info
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] - %m%n
log4j.appender.stdout.ImmediateFlush = true

log4j.appender.errorlogfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorlogfile.Threshold = INFO
log4j.appender.errorlogfile.layout = org.apache.log4j.PatternLayout
log4j.appender.errorlogfile.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%c]-[%p] - %m%n
log4j.appender.errorlogfile.File = ../logs/testlog4j.log
log4j.appender.errorlogfile.Append = true
log4j.appender.errorlogfile.ImmediateFlush = true

    ​​​​​​​

  2. 配置application.properties 
    指定log配置文件

 

logging.config= classpath:log4j.properties

 

  • 在启动类中进行测试 
    private static Logger logger = Logger.getLogger(TestLog4jApplication.class);

public static void main(String[] args) {
logger.info("log4j----------------\n");
SpringApplication.run(TestLog4jApplication.class, args);
}

    ​​​​​​​

运行项目，便可看到控制台打印出的日志信息，同时在项目同级目录下的logs/testlog4j.log中也会打印出比较详尽的日志信息。

SLF4J

SLF4J，即简单日志门面（Simple Logging Facade for Java），不是具体的日志解决方案，而是经过Facade Pattern提供一些Java logging API，它只服务于各类各样的日志系统。按照官方的说法，SLF4J是一个用于日志系统的简单Facade，容许最终用户在部署其应用时使用其所但愿的日志系统。做者建立SLF4J的目的是为了替代Jakarta Commons-Logging。 
实际上，SLF4J所提供的核心API是一些接口以及一个LoggerFactory的工厂类。在使用SLF4J的时候，不须要在代码中或配置文件中指定你打算使用那个具体的日志系统。相似于Apache Common-Logging，SLF4J是对不一样日志框架提供的一个门面封装，能够在部署的时候不修改任何配置便可接入一种日志实现方案。可是，他在编译时静态绑定真正的Log库。使用SLF4J时，若是你须要使用某一种日志实现，那么你必须选择正确的SLF4J的jar包的集合（各类桥接包）。SLF4J提供了统一的记录日志的接口，只要按照其提供的方法记录便可，最终日志的格式、记录级别、输出方式等经过具体日志系统的配置来实现，所以能够在应用中灵活切换日志系统。

slf4j

那么何时使用SLF4J比较合适呢？ 
若是你开发的是类库或者嵌入式组件，那么就应该考虑采用SLF4J，由于不可能影响最终用户选择哪一种日志系统。在另外一方面，若是是一个简单或者独立的应用，肯定只有一种日志系统，那么就没有使用SLF4J的必要。假设你打算将你使用log4j的产品卖给要求使用JDK 1.8 Logging的用户时，面对成千上万的log4j调用的修改，相信这绝对不是一件轻松的事情。可是若是开始便使用SLF4J，那么这种转换将是很是轻松的事情。

应用

例如上述内容中，log4j测试，使用

import org.apache.log4j.Logger;
  •  
private static Logger logger = Logger.getLogger(TestLog4jApplication.class);
  •  

而在log4j2测试使用​​​​​​​

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

 

private static Logger logger = LogManager.getLogger(TestLog4j2Application.class);
  •  

假如后期改变log实现系统，全部调用log4j的代码都须要进行修改，假如一开始都使用slf4j.Logger，后期将无需修改代码。​​​​​​​

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

 

private static Logger logger = LoggerFactory.getLogger(TestLog4jApplication.class);
  •  
private static Logger logger = LoggerFactory.getLogger(TestLog4j2Application.class);
  •  

假如遇到SLF4J: Class path contains multiple SLF4J bindings相关的错误提示，则是由于引入了多个日志系统，须要排除多余的依赖。

slf4j-simple是slf4j的一种日志系统实现。​​​​​​​

<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.7.7</version>
</dependency>

Logback

Logback，一个“可靠、通用、快速而又灵活的Java日志框架”。logback当前分红三个模块：logback-core，logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个改良版本。此外logback-classic完整实现SLF4J API使你能够很方便地更换成其它日志系统如log4j或JDK Logging。logback-access访问模块与Servlet容器集成提供经过Http来访问日志的功能。 
1. logback-core: Joran, Status, context, pattern parsing 
2. logback-classic: developer logging 
3. logback-access: The log generated when a user accesses a web-page on a web server. Integrates seamlessly with Jetty and Tomcat.

选择logback的理由： 
1. logback比log4j要快大约10倍，并且消耗更少的内存。 
2. logback-classic模块直接实现了SLF4J的接口，因此咱们迁移到logback几乎是零开销的。 
3. logback不只支持xml格式的配置文件，还支持groovy格式的配置文件。相比之下，Groovy风格的配置文件更加直观，简洁。 
4. logback-classic可以检测到配置文件的更新，而且自动从新加载配置文件。 
5. logback可以优雅的从I/O异常中恢复，从而咱们不用从新启动应用程序来恢复logger。 
6. logback可以根据配置文件中设置的上限值，自动删除旧的日志文件。 
7. logback可以自动压缩日志文件。 
8. logback可以在配置文件中加入条件判断（if-then-else)。能够避免不一样的开发环境（dev、test、uat…）的配置文件的重复。 
9. logback带来更多的filter。 
10. logback的stack trace中会包含详细的包信息。 
11. logback-access和Jetty、Tomcat集成提供了功能强大的HTTP-access日志。 
配置文件：须要在项目的src目录下创建一个logback.xml。 
注：（1）logback首先会试着查找logback.groovy文件； 
（2）当没有找到时，继续试着查找logback-test.xml文件； 
（3）当没有找到时，继续试着查找logback.xml文件； 
（4）若是仍然没有找到，则使用默认配置（打印到控制台）。

logback的一些配置介绍： 
* 控制台输出 
在Spring Boot中默认配置了ERROR、WARN和INFO级别的日志输出到控制台。咱们能够经过两种方式切换至DEBUG级别： 
在运行命令后加入–debug标志，如：$ java -jar test.jar --debug 
在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，可是你本身应用的日志并不会输出为DEBUG级别。

  • 多彩输出 
    若是你的终端支持ANSI，设置彩色输出会让日志更具可读性。经过在application.properties中设置spring.output.ansi.enabled参数来支持。 
    NEVER：禁用ANSI-colored输出（默认项） 
    DETECT：会检查终端是否支持ANSI，是的话就采用彩色输出（推荐项） 
    ALWAYS：老是使用ANSI-colored格式输出，若终端不支持的时候，会有不少干扰信息，不推荐使用

  • 文件输出 
    Spring Boot默认配置只会输出到控制台，并不会记录到文件中，可是咱们一般生产环境使用时都须要以文件方式记录。 
    若要增长文件输出，须要在application.properties中配置logging.file或logging.path属性。 
    logging.file，设置文件，能够是绝对路径，也能够是相对路径。如：logging.file=my.log 
    logging.path，设置目录，会在该目录下建立spring.log文件，并写入日志内容，如：logging.path=../logs 
    日志文件会在10Mb大小的时候被截断，产生新的日志文件，默认级别为：ERROR、WARN、INFO

  • 级别控制 
    在Spring Boot中只须要在application.properties中进行配置完成日志记录的级别控制。 
    配置格式：logging.level.*=LEVEL 
    logging.level：日志级别控制前缀，*为包名或Logger名 
    LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF 
    举例： 
    logging.level.com.test=DEBUG：com.test包下全部class以DEBUG级别输出 
    logging.level.root=WARN：root日志以WARN级别输出

  • 自定义输出格式 
    在Spring Boot中能够经过在application.properties配置以下参数控制输出格式： 
    logging.pattern.console：定义输出到控制台的样式（不支持JDK Logger） 
    logging.pattern.file：定义输出到文件的样式（不支持JDK Logger）

应用

logback是Spring Boot默认的日志系统，假如对日志没有特殊要求，能够彻底零配置使用 SLF4J（Simple Logging Facade For Java）的logback来输出日志。​​​​​​​

package com.jianeye.test;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

SpringBootApplication
public class TestApplication {

private static Logger logger = LoggerFactory.getLogger(TestApplication.class);

public static void main(String[] args) {
logger.warn("logback --------------------------------\n");
SpringApplication.run(TestApplication.class, args);
logger.info("default log system *************************\n");
}
}

Spring Boot也支持自定义日志配置，有如下两种方式。 
1. 在 src/main/resources 下面建立logback.xml （根据不一样环境来定义不一样的日志输出，那么取名为logback-spring.xml 便可）文件，并按需求进行配置。

logback-spring.xml 文件：​​​​​​​

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml" />
<logger name="org.springframework.web" level="INFO"/>
<logger name="org.springboot.sample" level="TRACE" />

<springProfile name="dev">
<logger name="org.springboot.sample" level="DEBUG" />
</springProfile>

<springProfile name="staging">
<logger name="org.springboot.sample" level="INFO" />
</springProfile>
</configuration>
  1. 使用最简单的方法，在 application 配置文件中配置。​​​​​​​ 
    logging:
config: classpath:logback-spring.xml
file: cuckoo3
path: /cuckoo3-log/logs
level:
com.jianeye.cuckoo3.webside: DEBUG

     

须要注意几点： 
1. 这里若不配置具体的包的日志级别，日志文件信息将为空 
2. 若只配置logging.path，那么将会在E:\logs文件夹生成一个日志文件为spring.log 
3. 若只配置logging.file，那将会在项目的当前路径下生成一个demo.log日志文件 
4. logging.path和logging.file同时配置，不会有在这个路径有E:\logs\demo.log日志生成，logging.path和logging.file不会进行叠加 
5. logging.path和logging.file的value均可以是相对路径或者绝对路径

Apache Commons Logging

Apache Commons Logging ，以前叫 Jakarta Commons Logging（JCL）提供的是一个日志(Log)接口(interface)，同时兼顾轻量级和不依赖于具体的日志实现工具。它提供给中间件/日志工具开发者一个简单的日志操做抽象，容许程序开发人员使用不一样的具体日志实现工具。用户被假定已熟悉某种日志实现工具的更高级别的细节。JCL提供的接口，对其它一些日志工具，包括Log4J, Avalon LogKit, and JDK 1.4+等，进行了简单的包装，此接口更接近于Log4J和LogKit的实现。 
common-logging是apache提供的一个通用的日志接口。用户能够自由选择第三方的日志组件做为具体实现，像log4j，或者jdk自带的logging， common-logging会经过动态查找的机制，在程序运行时自动找出真正使用的日志库。固然，common-logging内部有一个Simple logger的简单实现，可是功能很弱。因此使用common-logging，一般都是配合着log4j来使用。使用它的好处就是，代码依赖是common-logging而非log4j， 避免了和具体的日志方案直接耦合，在有必要时，能够更改日志实现的第三方库。 
使用common-logging的常见代码：​​​​​​​

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class A {
private static Log logger = LogFactory.getLog(this.getClass());
}

slf4j 与 common-logging 比较 
common-logging经过动态查找的机制，在程序运行时自动找出真正使用的日志库； 
slf4j在编译时静态绑定真正的Log库。

java.util.logging.Logger

java.util.logging.Logger（JUL），JDK自带的日志系统，从JDK1.4就有了。关键元素包括： 
Logger：应用程序进行logging调用的主要实体。Logger 对象用来记录特定系统或应用程序组件的日志消息。 
LogRecord：用于在 logging 框架和单独的日志处理程序之间传递 logging 请求。 
Handler：将 LogRecord 对象导出到各类目的地，包括内存、输出流、控制台、文件和套接字。为此有各类的 Handler 子类。其余 Handler 可能由第三方开发并在核心平台的顶层实现。 
Level：定义一组能够用来控制 logging 输出的标准 logging 级别。能够配置程序为某些级别输出 logging，而同时忽略其余输出。 
Filter：为所记录的日志提供日志级别控制之外的细粒度控制。Logging API 支持通用的过滤器机制，该机制容许应用程序代码附加任意的过滤器以控制 logging 输出。 
Formatter：为格式化 LogRecord 对象提供支持。此包包括的两个格式化程序 SimpleFormatter 和 XMLFormatter 分别用于格式化纯文本或 XML 中的日志记录。与 Handler 同样，其余 Formatter 可能由第三方开发。

整个JVM内部全部logger的管理，logger的生成、获取等操做都依赖于LogManager，也包括配置文件的读取，LogManager与logger是1对多关系，整个JVM运行时只有一个LogManager，且全部的logger均在LogManager中。 
logger与handler是多对多关系，logger在进行日志输出的时候会调用全部的hanlder进行日志的处理。 
handler与formatter是一对一关系，一个handler有一个formatter进行日志的格式化处理。 
logger与level是一对一关系，hanlder与level也是一对一关系 。 
JDK默认的logging配置文件为：$JAVA_HOME/jre/lib/logging.properties，可使用系统属性java.util.logging.config.file指定相应的配置文件对默认的配置文件进行覆盖。

小结

从下图中，咱们能够看到4部分。

logs

接口：将全部日志实现适配到了一块儿，用统一的接口调用。 
实现：目前主流的日志实现 
旧日志到slf4j的适配器：若是使用了slf4j，可是只想用一种实现，想把log4j的日志体系也从logback输出，这个是颇有用的。 
slf4j到实现的适配器：若是想制定slf4j的具体实现，须要这些包。

slf4j跟commons-logging相似，是各类日志实现的通用入口，log4j、log4j二、logback、slf4j-simple和java.util.logging是比较常见的日志实现系统，目前应用比较普遍的是Log4j和logback，而logback做为后起之秀，以替代log4j为目的，总体性能比log4j较佳，log4j的升级版log4j2也是有诸多亮点，用户能够根据项目需求和我的习惯，选择合适的日志实现。

联系我们 沪ICP备13005482号-10