Log4j 与 common-logging

转载：http://www.open-open.com/solution/view/1318596826374

一．Log4j 

1.简介  
Log4j是Apache的一个开放源代码项目 
使用Log4j,我们可以很方便的来记录日志. 
从 http://www.apache.org/dist/logging/log4j/1.2.14/ 下载最新的稳定版本 

2.用法  
把log4j-1.2.14.jar丢到lib目录下，使用log4j前需要定义配置文件,也可以不使用,而是在代码中配置log4j环境.但是使用配置文件使应用程序更加灵活。 

log4j配置文件有三个主要的组件:Logger,Appender和Layout,分别为日志类型,日志输出目的地,日志输出格式. 

跟proxool类似,log4j支持两种类型的配置文件，xml和properties 
log4j.properties配置文件如下:(需要把log4j的配置文件放在classpath下) 

log4j.rootLogger = [level], appenderName, appenderName, ...    (level是错误级别,appenderName是输出目的地,可以定义多个) 

level优先级分别为FATAL、ERROR、WARN、INFO、DEBUG 5个级别.通过定义的级别,你可以控制程序中的日志输出.比如在这里定义了ERROR级别,程序中只有FARAL、ERROR 级别的LOG会被输出. 

log4j.appender.appenderName = 输出目的地(这里的appenderName是在前面定义的,可任意起名)  
Log4j提供的输出目的地有以下几种: 
org.apache.log4j.ConsoleAppender(控制台) 
org.apache.log4j.FileAppender(文件) 
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件) 
org.apache.log4j.RollingFileAppender(文件到达指定大小时产生一个新文件) 
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任何地方) 

log4j.appender.mylog.File = dir 
log4j.appender.mylog.MaxFileSize=fileSize 
log4j.appender.mylog.MaxBackupIndex=num设置保存备份文件数量

log4j.appender.appenderName.layout = 布局类型 (设置布局类型)

Log4j提供的layout有以下4种：
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)

如果使用PatternLayout布局就要指定的打印信息的具体格式ConversionPattern, 
打印参数如下:

%m 输出代码中指定的消息
%p 输出优先级,即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目,通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符,Windows为"rn"，Unix为"n"
%d 输出日志时间,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出:2007年5月17日 19:30:00,000
%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数
[QC]是log信息的开头,可以为任意字符,一般为项目简称

最简单通用的配置文件(从控制台打印): 

log4j.rootLogger=info,mylog
log4j.appender.mylog=org.apache.log4j.ConsoleAppender
log4j.appender.mylog.layout=org.apache.log4j.PatternLayout
log4j.appender.mylog.layout.ConversionPattern=[-] %p %d{yyyy-MM-dd HH:mm:ss} %m %n
或者
log4j.rootLogger=info,mylog
log4j.appender.mylog=org.apache.log4j.ConsoleAppender
log4j.appender.mylog.layout=org.apache.log4j.SimpleLayout

在代码中log4j的使用: 
首先需要导入日志类

import org.arache.log4j.Logger;
static Logger logger = Logger.getLogger(your-className.class);
#需要插入日志的地方只需
logger.debug(your-message);
logger.info(your-message);
logger.warn(your-message);
logger.error(your-message);
logger.fatal(your-message);

写程序的时候,为了调试,会加入大量的logger信息,当然程序调试完毕不需要这些输出信息时,只需把输出的级别调高,如调到error级别,这样error以下级别的logger就不会出输出.非常简单,方便. 

二．commons-logging介绍 
log4j与commons-logging两个包,都是记日志的,为什么要两个一起用呢? 
commons-logging是为"所有的Java日志实现"提供一个统一的接口,它自身的日志功能非常弱,而log4j功能非常强大全面,所以拿两者配合使用. 
commons-logging工作原理: 
1. 首先在classpath下寻找自己的配置文件commons-logging.properties,如果找到,则使用其中定义的Log实现类 
2. 如果找不到commons-logging.properties文件,则在查找是否已定义系统环境变量org.apache.commons.logging.Log,找到则使用其定义的Log实现类 
3. 查看classpath中是否有Log4j的包,如果发现,则自动使用Log4j作为日志实现类 
4. 使用JDK自身的日志实现类(JDK1.4以后才有日志实现类) 
5. 使用commons-logging自己提供的一个简单的日志实现类SimpleLog 
(以上顺序不保证完全准确,请参考官方文档) 
commons-logging总是能找到一个日志实现类,并且尽可能找到一个"最合适"的日志实现类. 
1、可以不需要配置文件 
2、自动判断有没有Log4j包,有则自动使用之 
3、最悲观的情况下也总能保证提供一个日志实现(SimpleLog) 
另外一直觉得log4j的使用方式有点问题 
static Logger logger = Logger.getLogger(message); 
每个需要写日志的java类都得创建一个static logger实例,如果java类很多的话,那创建这些static对象的开销将非常大,所以最后自己写一个log类,有一个静态方法可以得到logger实例 

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

public class Logs {
    private static Log log;
    static{
        log=LogFactory.getLog(Logs.class);
    }
    public static Log getLogger(){
        return log;
    }
}

三.关于Log4j比较全面的配置 
LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、 回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了 

log4j.rootLogger=DEBUG,CONSOLE,A1,im 
log4j.addivity.org.apache=true  

# 应用于控制台

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
log4j.appender.Threshold=DEBUG 
log4j.appender.CONSOLE.Target=System.out 
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%

#应用于文件

log4j.appender.FILE=org.apache.log4j.FileAppender 
log4j.appender.FILE.File=file.log 
log4j.appender.FILE.Append=false 
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout 
log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 
# Use this layout for LogFactor 5 analysis 

# 应用于文件回滚

log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender 
log4j.appender.ROLLING_FILE.Threshold=ERROR 
log4j.appender.ROLLING_FILE.File=rolling.log 
log4j.appender.ROLLING_FILE.Append=true 
log4j.appender.ROLLING_FILE.MaxFileSize=10KB 
log4j.appender.ROLLING_FILE.MaxBackupIndex=1 
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout 
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

#应用于socket

log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender 
log4j.appender.SOCKET.RemoteHost=localhost 
log4j.appender.SOCKET.Port=5001 
log4j.appender.SOCKET.LocationInfo=true 
# Set up for Log Facter 5 
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout 
log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n 


# Log Factor 5 Appender 
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000 

# 发送日志给邮件

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
log4j.appender.MAIL.Threshold=FATAL 
log4j.appender.MAIL.BufferSize=10 
log4j.appender.MAIL.From=web@www.wuset.com 
log4j.appender.MAIL.SMTPHost=www.wusetu.com 
log4j.appender.MAIL.Subject=Log4J Message 
log4j.appender.MAIL.To=web@www.wusetu.com 
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout 
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n 

# 用于数据库

log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender 
log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test 
log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver 
log4j.appender.DATABASE.user=root 
log4j.appender.DATABASE.password= 
log4j.appender.db.sql=INSERT INTO SS_LOG4J_LOG (PRIORITY,LOGDATE,CLASS,METHOD,MSG) VALUES('%p','%d{yyyy-MM-dd HH:mm:ss}','%C','%M','%m')
log4j.appender.db.layout=org.apache.log4j.PatternLayout log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout 
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n <PRE class=java name="code">

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.A1.File=SampleMessages.log4j 
log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j' 
log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout </PRE>
<BR>
<BR><SPAN style="COLOR: green">#自定义Appender </SPAN>
<BR><PRE class=java name="code">log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender 

log4j.appender.im.host = mail.cybercorlin.net 
log4j.appender.im.username = username 
log4j.appender.im.password = password 
log4j.appender.im.recipient = corlin@cybercorlin.net 

log4j.appender.im.layout=org.apache.log4j.PatternLayout 
log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n</PRE>
<BR>
<BR>