1.1常见日志框架
在项目开发过程中,我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此对于一个项目而言,日志记录是一个非常重要的问题。因此,如何选择一个合适的日志记录框架也非常重要。
在Java开发中,目前常用的日志框架包括Log4j 1,Log4j 2,Commons Logging,Slf4j,Logback,Jul。这些日志记录框架各有各的特点,各有各的应用场景。了解这些框架的特点及应用场景,有利于我们做技术选型的时候做出正确的判断。
框架 | 说明 |
---|---|
Log4j | Apache Log4j是一个基于Java的日志记录工具。它是由Ceki首创的,现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。 |
Log4j 2 | Apache Log4j 2是apache开发的一款Log4j的升级产品。 |
Commons Logging | Apache基金会所属的项目,是一套Java日志接口,之前叫Jakarta Commons Logging,后更名为Commons Logging。 |
Slf4j | 类似于Commons Logging,是一套简易Java日志门面,本身并无日志的实现。(Simple Logging Facade for Java,缩写Slf4j)。 |
Logback | 一套日志组件的实现(Slf4j阵营) |
Jul | (Java Util Logging),自Java1.4以来的官方日志实现。 |
Java日志框架历史:
1996年早期,欧洲安全电子市场项目组决定编写它自己的程序跟踪API(Tracing API)。经过不断的完善,这个API终于成为一个十分受欢迎的Java日志软件包,即Log4j(由Ceki创建)。后来Log4j成为Apache基金会项目中的一员,Ceki也加入Apache组织。
后来Log4j近乎成了Java社区的日志标准。据说Apache基金会还曾经建议Sun引入Log4j到Java的标准库中,但Sun拒绝了。
2002年Java1.4发布,Sun推出了自己的日志库JUL(Java Util Logging),其实现基本模仿了Log4j的实现。在JUL出来以前,Log4j就已经成为一项成熟的技术,使得Log4j在选择上占据了一定的优势。
接着,Apache推出了Jakarta Commons Logging,JCL只是定义了一套日志接口(其内部也提供一个Simple Log的简单实现),支持运行时动态加载日志组件的实现,也就是说,在你应用代码里,只需调用Commons Logging的接口,底层实现可以是Log4j,也可以是Java Util Logging。
后来(2006年),Ceki不适应Apache的工作方式,离开了Apache。然后先后创建了Slf4j(日志门面接口,类似于Commons Logging)和Logback(Slf4j的实现)两个项目,并回瑞典创建了QOS公司,QOS官网上是这样描述Logback的:The Generic,Reliable Fast&Flexible Logging Framework(一个通用,可靠,快速且灵活的日志框架)。
现今,Java日志领域被划分为两大阵营:Commons Logging阵营和Slf4j阵营。
Commons Logging在Apache大树的笼罩下,有很大的用户基数。但有证据表明,形式正在发生变化。2013年底有人分析了GitHub上30000个项目,统计出了最流行的100个Libraries,可以看出Slf4j的发展趋势更好。
Apache眼看有被Logback反超的势头,于2012-07重写了Log4j 1.x,成立了新的项目Log4j 2, Log4j 2具有Logback的所有特性。
1 Log4j 2与Log4j 1发生了很大的变化,Log4j 2不兼容Log4j 1。
2 Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式,也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口,使得子系统更容易使用)。Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现,调用者只需要关注接口而无需关注具体的实现,做到解耦。
3 比较常用的组合使用方式是Slf4j与Logback组合使用,Commons Logging与Log4j组合使用。
4 Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者,其兼容性不言而喻。
共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF。
log4j 1.2.x版本的使用
依赖信息
commons-logging
commons-logging
1.2
log4j
log4j
1.2.17
第一步:配置文件:log4j.properties
### set log levels - for more verbose logging change 'info' to 'debug' , 'off' ###
log4j.rootLogger=info, stdout,file
###1 direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.err
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
###2 direct messages to file mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=d:\\mylog.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
###3每天生成一个文件
log4j.appender.daily=org.apache.log4j.DailyRollingFileAppender
log4j.appender.daily.File=d:\\logs\\soso.log
log4j.appender.daily.Append=true
log4j.appender.daily.Threshold=INFO
log4j.appender.daily.ImmediateFlush=true
#生成一个配置文件 命名 soso.8888-88-88-88 时间
log4j.appender.daily.DatePattern='_'yyyy-MM-dd'.txt'
log4j.appender.daily.layout=org.apache.log4j.PatternLayout
log4j.appender.daily.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
###4控制每个滚动日志文件大小和个数
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.Threshold=DEBUG
log4j.appender.R.File=d:\\logs\\test.log
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%5p] - %c -%F(%L) -%m%n
log4j.appender.R.MaxFileSize=1kb
log4j.appender.R.MaxBackupIndex=5
第二步 编写java类测试:
import org.apache.log4j.Logger;
public class Demo1 {
public static void main(String[] args) {
//不用日志框架
System.out.println("xxxx");
Logger logger = LogManager.getLogger(LogDemo2.class.getName());
//门面使用
//Log logger = LogFactory.getLog(Demo2.class.getName());
//使用日志
logger.trace("跟踪信息");
logger.debug("调试信息");
logger.info("信息");
logger.warn("警告信息");
logger.error("错误信息");
logger.fatal("致命错误");
}
}
依赖信息
commons-logging
commons-logging
1.2
org.apache.logging.log4j
log4j-core
2.11.1
如果和commons-logging配合使用需要添加log4j-jcl依赖
org.apache.logging.log4j
log4j-jcl
2.11.1
第一步:配置文件:log4j2.xml
第二步 编写java类测试:
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
*
* @version 1.0
*/
public class LogDemo2 {
public static void main(String[] args){
Logger logger = LogManager.getLogger(LogDemo2.class.getName());
//门面使用
//Log logger = LogFactory.getLog(Demo2.class.getName());
logger.trace("entry"); //等同于logger.entry();但此方法在新版本好像已经废弃
logger.error("Did it again!");
logger.info("这是info级信息");
logger.debug("这是debug级信息");
logger.warn("这是warn级信息");
logger.fatal("严重错误");
logger.trace("exit");
}
}
1.5 logback的使用
logback是java的日志开源组件,是log4j创始人写的,性能比log4j要好,目前主要分为3个模块
slf4j
的接口,这样你如果之后要切换其他日志组件也是一件很容易的事依赖如下
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-coreartifactId>
<version>1.2.3version>
dependency>
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-classicartifactId>
<version>1.2.3version>
dependency>
<dependency>
<groupId>org.slf4jgroupId>
<artifactId>slf4j-apiartifactId>
<version>1.7.26version>
dependency>
logback.xml
<configuration >
<property name="LOG_HOME" value="D:/" />
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss" />
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%npattern>
encoder>
appender>
<appender name="fileAppender" class="ch.qos.logback.core.FileAppender">
<immediateFlush>trueimmediateFlush>
<file>${LOG_HOME}${bySecond}.logfile>
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%npattern>
encoder>
<append>trueappend>
<prudent>falseprudent>
appender>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
root>
configuration>
代码如下
Logger logger = LoggerFactory.getLogger(Demo3.class.getName());
logger.trace("跟踪信息_logback");
logger.debug("调试信息_logback");
logger.info("基本信息_logback");
logger.warn("警告信息_logback");
logger.error("错误信息_logback");