日志解决方案
1、org.apache.commons.logging.Log方案
如果对于commons-loging、log4j、slf4j、LogBack等都已经非常清楚了,可以忽略本文。几次解决日志冲突问题时对这几个概念的简单总结,希望对这块基础没有理解透的同学能有所帮助,当然如果对这块有更深刻理解的同学,也贡献出自己的知识和见解。
一、 概念
Commons-logging:apache最早提供的日志的门面接口。避免和具体的日志方案直接耦合。类似于JDBC的api接口,具体的的JDBC driver实现由各数据库提供商实现。通过统一接口解耦,不过其内部也实现了一些简单日志方案。
Log4j:经典的一种日志解决方案。内部把日志系统抽象封装成Logger、appender、pattern等实现。我们可以通过配置文件轻松的实现日志系统的管理和多样化配置。
Slf4j: 全称为Simple Logging Facade for JAVA:java简单日志门面。是对不同日志框架提供的一个门面封装。可以在部署的时候不修改任何配置即可接入一种日志实现方案。和commons-loging应该有一样的初衷。个人感觉设从计上更好一些,没有commons那么多潜规则。同时有两个额外特点:
1. 能支持多个参数,并通过{}占位符进行替换,避免老写logger.isXXXEnabled这种无奈的判断,带来性能提升见:http://www.slf4j.org/faq.html#logging_performance。
2.OSGI机制更好兼容支持
一图胜千言,官网上的一个图:
从上图可以发现,选择还是很多的。
Logback: LOGBack作为一个通用可靠、快速灵活的日志框架,将作为Log4j的替代和SLF4J组成新的日志系统的完整实现。官网上称具有极佳的性能,在关键路径上执行速度是log4j的10倍,且内存消耗更少。具体优势见:
http://logback.qos.ch/reasonsToSwitch.html
二、 常见日志方案和注意事项
1.Commons-logging+log4j:经典的一个日志实现方案。出现在各种框架里。如spring、webx、ibatis等等。直接使用log4j即可满足我们的日志方案。但是一般为了避免直接依赖具体的日志实现,一般都是结合commons-logging来实现。常见代码如下:
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
private static Log logger = LogFactory.getLog(CommonsLoggingTest.class);
代码上,没有依赖任何的log4j内部的类。那么log4j是如何被装载的?
Log是一个接口声明。LogFactory的内部会去装载具体的日志系统,并获得实现该Log接口的实现类。而内部有一个Log4JLogger实现类对Log接口同时内部提供了对log4j logger的代理。LogFactory内部装载日志系统流程:
1. 首先,寻找org.apache.commons.logging.LogFactory属性配置
2. 否则,利用JDK1.3开始提供的service发现机制,会扫描classpah下的META-INF/services/org.apache.commons.logging.LogFactory文件,若找到则装载里面的配置,使用里面的配置。
3. 否则,从Classpath里寻找commons-logging.properties,找到则根据里面的配置加载。
4. 否则,使用默认的配置:如果能找到Log4j则默认使用log4j实现,如果没有则使用JDK14Logger实现,再没有则使用commons-logging内部提供的SimpleLog实现。
从上述加载流程来看,如果没有做任何配置,只要引入了log4j并在classpath配置了log4j.xml,则commons-logging就会使log4j使用正常,而代码里不需要依赖任何log4j的代码。
2.Commons-logging+log4j+slf4j
如果在原有commons-logging系统里,如果要迁移到slf4j,使用slf4j替换commons-logging,也是可以做到的。原理使用到了上述commons-logging加载的第二点。需要引入Org.slf4j.jcl-over-slf4j-1.5.6.jar。这个jar包提供了一个桥接,让底层实现是基于slf4j。原理是在该jar包里存放了配置META-INF/services/org.apache.commons.logging.LogFactory =org.apache.commons.logging.impl.SLF4JLogFactory,而commons-logging在初始化的时候会找到这个serviceId,并把它作为LogFactory。
完成桥接后,那么那么简单日志门面SLF4J内部又是如何来装载合适的log呢?
原理是SLF4J会在编译时会绑定import org.slf4j.impl.StaticLoggerBinder;该类里面实现对具体日志方案的绑定接入。任何一种基于slf4j的实现都要有一个这个类。如:
org.slf4j.slf4j-log4j12-1.5.6:提供对log4j的一种适配实现。
Org.slf4j.slf4j-simple-1.5.6:是一种simple实现,会将log直接打到控制台。
……
那么这个地方就要注意了:如果有任意两个实现slf4j的包同时出现,那就有可能酿就悲剧,你可能会发现日志不见了、或都打到控制台了。原因是这两个jar包里都有各自的org.slf4j.impl.StaticLoggerBinder,编译时候绑定的是哪个是不确定的。这个地方要特别注意!!出现过几次因为这个导致日志错乱的问题。
3.Slf4j+logback
Slf4j和log4j作者都是同一个人。
Logback号称在性能各方面有很多优势,也很诱人。
直接使用SLf4j也很简单:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}
代码里也看不到任何具体日志实现方案的痕迹。
Logback没用过,看到过一些诱人介绍。具体大家可以去研究。logback。
注意事项
使用日志配置的时候一定要明白需求,同时避免冲突。
如使用SLF4j的时候为了避免冲突,一定要保障只有一种实现类jar包在里面。
当遇到日志错乱等问题时,可以从这几个方面来排查
二、slf4j方案一. Log4j+commons-logging
JAR包
commons-logging-1.1.jar
log4j-1.2.15.jar
配置文件
commons-logging.properties
log4j.xml
commons-logging.jar包读取commons-logging.properties中指定的log,自动加载日志配置
在commons-logging+log4j组合中commons-logging.properties指定的日志为:
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
log4j指定具体日志输出配置
如果未选用commons-logging,可以在启动项目中,主动加载log4j的配置文件
二. Logback+slf4j
JAR包
slf4j-api-1.5.2.jar
logback-classic-0.9.9.jar
logback-core-0.9.9.jar
配置文件
Logback.xml
logback的加载采用编码加载
- String logbackCfg = "/config/logback.xml";
- URL logURL = new ClassPathResource(logbackCfg).getURL();
- ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
- LoggerContext loggerContext = (LoggerContext) loggerFactory;
- loggerContext.shutdownAndReset();
- JoranConfigurator configurator = new JoranConfigurator();
- configurator.setContext(loggerContext);
- configurator.doConfigure(logURL);
三. Slf4j+log4j
JAR包
slf4j-api-1.5.2.jar
slf4j-log4j12-1.5.2.jar
log4j-1.2.15.jar
配置文件
Logback.xml
四. Slf4j+logback+logback
注:这种情况下是项目中有log4j输出的日志以及logback数据的日志.老项目改造,log4j和logback共存的情况下.(当选用spring+slf4j+logback的时候,spring的日志输出是log4j的,这个时候采用这种配置.)
JARbao
log4j-over-slf4j-1.5.2.jar
logback-classic-0.9.9.jar
logback-core-0.9.9.jar
slf4j-api-1.5.2.jar
配置文件
Logback.xml
配置加载
- String logbackCfg = "/config/logback.xml";
- URL logURL = new ClassPathResource(logbackCfg).getURL();
- ILoggerFactory loggerFactory = LoggerFactory.getILoggerFactory();
- LoggerContext loggerContext = (LoggerContext) loggerFactory;
- loggerContext.shutdownAndReset();
- JoranConfigurator configurator = new JoranConfigurator();
- configurator.setContext(loggerContext);
- configurator.doConfigure(logURL);
五. Log4j配置文件示例
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
- <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
- <!-- 控制台输出-->
- <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
- <param name="Target" value="System.out" />
- <param name="Threshold" value="INFO" />
- <layout class="org.apache.log4j.PatternLayout">
- <param name="ConversionPattern"
- value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n %m%n" />
- </layout>
- <!— 以下是过滤一些不需要输出的log信息 -->
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="new a seq no spend" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="new hi[type=" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="FileTransfer.execCommand()" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- </appender>
- <!--文件输出 按照文件大小滚动文件-->
- <appender name="xxxx_file" class="org.apache.log4j.RollingFileAppender">
- <param name="Append" value="true" />
- <param name="Threshold" value="INFO" />
- <param name="File" value="xxxx.log" />
- <param name="MaxFileSize" value="100MB" />
- <param name="MaxBackupIndex" value="15" />
- <layout class="org.apache.log4j.PatternLayout">
- <param name="ConversionPattern"
- value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n %m%n" />
- </layout>
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="new a seq no spend" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="new hi[type=" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- <filter class="org.apache.log4j.varia.StringMatchFilter">
- <param name="StringToMatch" value="FileTransfer.execCommand()" />
- <param name="AcceptOnMatch" value="false" />
- </filter>
- </appender>
- <!-- 错误输出 过滤出错误日志信息-->
- <appender name="xxxx_error" class="org.apache.log4j.RollingFileAppender">
- <param name="Append" value="true" />
- <param name="Threshold" value="ERROR" />
- <param name="File" value="xxxx-error.log" />
- <param name="MaxFileSize" value="100MB" />
- <param name="MaxBackupIndex" value="4" />
- <layout class="org.apache.log4j.PatternLayout">
- <param name="ConversionPattern"
- value="%d{yyyy-MM-dd HH:mm:ss sss}[%-p][%-c][line:%-L] \r\n %m%n" />
- </layout>
- </appender>
- <!-- 根loggr -->
- <root>
- <appender-ref ref="CONSOLE" />
- <appender-ref ref="xxxx_file" />
- <appender-ref ref="xxxx_file_error" />
- </root>
- </log4j:configuration>
六. Logback配置文件示例
- <?xml version="1.0" encoding="UTF-8" ?>
- <!DOCTYPE configuration>
- <configuration>
- <jmxConfigurator />
- <!-- 控制台输出日志 -->
- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <layout class="ch.qos.logback.classic.PatternLayout">
- <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
- </layout>
- </appender>
- <!-- 文件输出日志 (文件大小策略进行文件输出,超过指定大小对文件备份)-->
- <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
- <File>xxxx.log</File>
- <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
- <FileNamePattern>xxxx.log.%i.bak</FileNamePattern>
- <MinIndex>1</MinIndex>
- <MaxIndex>12</MaxIndex>
- </rollingPolicy>
- <triggeringPolicy
- class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
- <MaxFileSize>100MB</MaxFileSize>
- </triggeringPolicy>
- <layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
- </layout>
- </appender>
- <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
- <filter class="ch.qos.logback.classic.filter.LevelFilter">
- <level>ERROR</level>
- <OnMismatch>DENY</OnMismatch>
- <OnMatch>ACCEPT</OnMatch>
- </filter>
- <File>xxxx-err.log</File>
- <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
- <FileNamePattern>xxxx-err.log.%i.bak</FileNamePattern>
- <MinIndex>1</MinIndex>
- <MaxIndex>3</MaxIndex>
- </rollingPolicy>
- <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
- <MaxFileSize>100MB</MaxFileSize>
- </triggeringPolicy>
- <layout class="ch.qos.logback.classic.PatternLayout">
- <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
- </layout>
- </appender>
- <!--这里指定logger name 是为jmx设置日志级别做铺垫 -->
- <logger name="com.xxx.xxx">
- <level value="INFO" />
- <appender-ref ref="STDOUT" />
- <appender-ref ref="FILE" />
- <appender-ref ref="FILE-ERROR" />
- </logger>
- </configuration>
七. 相关简单说明
Log4j
Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIX Syslog守护进程等;用户也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,用户能够更加细致地控制日志的生成过程。这些可以通过一个 配置文件来灵活地进行配置,而不需要修改程序代码
Slf4j
简单日记门面(Facade)SLF4J是为各种loging APIs提供一个简单统一的接口,从而使得最终用户能够在部署的时候配置自己希望的loging APIs实现。 Logging API实现既可以选择直接实现SLF4J接的loging APIs如: NLOG4J、SimpleLogger。也可以通过SLF4J提供的API实现来开发相应的适配器如Log4jLoggerAdapter、JDK14LoggerAdapter。
Logback
Logback是由log4j创始人设计的又一个开源日记组件。logback当前分成三个模块:logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日记系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日记的功能。