Log4j学习总结

两个jar包

log4j_1.2.8.jar、commons-logging-1.0.4.jar

配置文件

log4j.properties

log4j.rootLogger=debug, stdout, Rlog4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m %nlog4j.appender.R.File=G:/common.loglog4j.appender.R.MaxFileSize=5000KBlog4j.appender.R.layout=org.apache.log4j.PatternLayoutlog4j.appender.R.MaxBackupIndex=20log4j.appender.R.layout.ConversionPattern=%p %t %c - %m %nlog4j.appender.R=org.apache.log4j.RollingFileAppender

测试代码

HelloWorld.java

package com.lixing.log4j;import org.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory;public class HelloWorld {    public static void main(String args[]) {        Log logger = LogFactory.getLog(HelloWorld.class);        logger.debug("-----------Debug----------------");        logger.info("-----------Info----------------");        logger.warn("-----------Warn----------------");        logger.error("-----------Error-----------");    }}

运行结果

对jar包的说明

Commons-loggin的目的是为“所有的Java日志实现”提供一个统一的接口，简单了操作，同时避免项目与某个日志实现系统紧密耦合，而它自身的日志功能平常（只有一个简单的SimpleLog?），所以一般不会单独使用它。Log4j的功能非常全面强大，是目前的首选。

Commons-loggin很贴心的帮我们自动选择适当的日志实现系统，它甚至不需要配置。这里看一下它怎么“很贴心”的帮我们自动选择适当的日志实现系统：

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）。

可以看到，commons-logging对编程者和Log4j都非常友好。

为了简化配置commons-logging，一般不使用commons-logging的配置文件，也不设置与commons-logging相关的系统环境变量，而只需将Log4j的Jar包放置到classpash中就可以了。这样就很简单地完成了commons-logging与Log4j的融合。如果不想用Log4j了怎么办？只需将classpath中的Log4j的Jar包删除即可。就这么简单！

对配置文件的说明

log4j.rootLogger=debug, stdout, R
说明：此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码中，可以任意起名。
语法：log4j.rootLogger = [ level ] , appenderName, appenderName, …
语法说明：
level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，只有等于及高于这个级别的才进行处理，则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL：打印所有的日志，OFF：关闭所有的日志输出。
appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
说明：此语句配置日志信息输出的目的地为控制台。
语法：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
语法说明：
这里的appenderName为在rootLogger里定义的，可任意起名。
其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender输出到控制台；
org.apache.log4j.FileAppender输出到文件；
org.apache.log4j.DailyRollingFileAppender每天产生一个日志文件；
org.apache.log4j.RollingFileAppender文件大小到达指定尺寸的时候产生一个新的文件，可通过 log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过 log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件；
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）。
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
说明：此语句配置日志信息的输出格式为匹配模式字符串输出。
语法：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
语法说明：
Layout 负责格式化Appender的输出，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout以HTML表格形式布局；
org.apache.log4j.PatternLayout可以灵活地指定布局模式；
org.apache.log4j.SimpleLayout包含日志信息的级别和信息字符串；
org.apache.log4j.TTCCLayout包含日志产生的时间、线程、类别等等信息。
log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m %n
说明：
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
%m 输出代码中指定的消息
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。

单独使用Log4j

package com.lixing.log4j;//import org.apache.log4j.BasicConfigurator;import org.apache.log4j.Logger;import org.apache.log4j.PropertyConfigurator;public class TestLog4j {    static Logger logger = Logger.getLogger(TestLog4j.class);    public static void main(String args[])  {//        BasicConfigurator.configure();        PropertyConfigurator.configure(".\\src\\log4j.properties");        logger.debug("-------------DEBUG--------------");        logger.info("-------------INFO-----------------");        logger.warn("-------------WARN-------------------");        logger.error("-------------ERROR--------------");        logger.fatal("-------------FATAL-------------");    }}

程序说明

static Logger logger = Logger.getLogger(TestLog4j.class)
获取日志记录器，这个记录器将负责控制日志信息，创建时要告知Logger你当前的Class是什么。
// BasicConfigurator.configure()
自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure(".\\src\\log4j.properties")
读取使用Java的特性文件编写的配置文件。使用当前工程目录下的src文件夹中的log4j.properties文件作为配置文件。若将log4j.properties放在工程根目录下也可不写此句，程序会自动找到配置文件。

总结

commons-logging仅仅对Log4j(当然还包括其它LOG实现)作了一层包装，具体的日志输出还是在内部转交给身后的Log4j来处理；而Log4j虽然做了所有的事情，却甘作绿叶，从不以真身示人。
log4j.rootLogger是Log4j最最重要的一个属性了，它定义日志信息的“输出级别”和“输出目的地”。
 “输出目的地”就是我们自己定义的了，就在log4j.properties的后面部分，此文件定义的“输出目的地”有CONSOLE、FILE、ROLLING_FILE、SOCKET、LF5_APPENDER、MAIL、DATABASE、A1、im。该文件之所以可作主模板，就是因为它比较全面地定义了各种常见的输出目的地（控制台、文件、电子邮件、数据库等）。
如，我们根据需要，将这一行修改为：log4j.rootLogger= ERROR, CONSOLE,FILE,MAIL，则将“错误（ERROR）”及“致命错误（FATAL）”级别的日志信息同时输出到控制台、文件，并且发电子邮件向系统管理员报告。

附：log4j.properties文件模板

##Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。
log4j.rootLogger = DEBUG, CONSOLE,A1
log4j.addivity.org.apache = true 
# 应用于控制台

log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppenderlog4j.appender.Threshold = DEBUGlog4j.appender.CONSOLE.Target = System.outlog4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayoutlog4j.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 % n

#应用于文件

log4j.appender.FILE = org.apache.log4j.FileAppenderlog4j.appender.FILE.File = file.loglog4j.appender.FILE.Append = false  log4j.appender.FILE.layout = org.apache.log4j.PatternLayoutlog4j.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.RollingFileAppenderlog4j.appender.ROLLING_FILE.Threshold = ERRORlog4j.appender.ROLLING_FILE.File = rolling.loglog4j.appender.ROLLING_FILE.Append = true  log4j.appender.ROLLING_FILE.MaxFileSize = 10KBlog4j.appender.ROLLING_FILE.MaxBackupIndex = 1  log4j.appender.ROLLING_FILE.layout = org.apache.log4j.PatternLayoutlog4j.appender.ROLLING_FILE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n

#应用于socket

log4j.appender.SOCKET = org.apache.log4j.RollingFileAppenderlog4j.appender.SOCKET.RemoteHost = localhostlog4j.appender.SOCKET.Port = 5001  log4j.appender.SOCKET.LocationInfo = true  # Set up  for  Log Facter  5  log4j.appender.SOCKET.layout = org.apache.log4j.PatternLayoutlog4j.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  Appenderlog4j.appender.LF5_APPENDER = org.apache.log4j.lf5.LF5Appenderlog4j.appender.LF5_APPENDER.MaxNumberOfRecords = 2000  

# 发送日志给邮件

log4j.appender.MAIL = org.apache.log4j.net.SMTPAppenderlog4j.appender.MAIL.Threshold = FATAlog4j.appender.MAIL.BufferSize = 10  log4j.appender.MAIL.From = [e-mail] = www.wusetu.comlog4j.appender.MAIL.Subject = Log4J Messagelog4j.appender.MAIL.To = [e-mail] = org.apache.log4j.PatternLayoutlog4j.appender.MAIL.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n

# 用于数据库

log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppenderlog4j.appender.DATABASE.URL = jdbc:mysql: // localhost:3306/testlog4j.appender.DATABASE.driver = com.mysql.jdbc.Driverlog4j.appender.DATABASE.user = rootlog4j.appender.DATABASE.password =  log4j.appender.DATABASE.sql = INSERT INTO LOG4J (Message) VALUES ( ' [framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n ' )log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayoutlog4j.appender.DATABASE.layout.ConversionPattern = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % nlog4j.appender.A1 = org.apache.log4j.DailyRollingFileAppenderlog4j.appender.A1.File = SampleMessages.log4jlog4j.appender.A1.DatePattern = yyyyMMdd - HH ' .log4j '  log4j.appender.A1.layout = org.apache.log4j.xml.XMLLayout 

#自定义Appender

log4j.appender.im  =  net.cybercorlin.util.logger.appender.IMAppenderlog4j.appender.im.host  =  mail.cybercorlin.netlog4j.appender.im.username  =  usernamelog4j.appender.im.password  =  passwordlog4j.appender.im.recipient  =  [e-mail] = org.apache.log4j.PatternLayoutlog4j.appender.im.layout.ConversionPattern  = [framework]  % d  -   % c  -%- 4r [ % t]  %- 5p  % c  % x  -   % m % n

遇到的问题

Log4J发日志邮件给多个接收者及标题、正文乱码问题
以前开发的系统没有单独的日志管理，所有的日志统一输出到tomcat后台一个文件里，不几天就是好几G，现在要整体增加一个Log4J管理日志的功能，其实这方面的资料网上多的是。发邮件的配置说明也有，但是具体怎么发，乱码问题怎么解决那就比较少了。
利用javamail发送邮件，你需要导入包mail.jar和activation.jar这两个包 ，否则是没法发邮件的 ，下边配置文件里绿色行显示的就是发给两个接收者ac和ae。
这里会出现中文乱码问题，主要有两方面的乱码，一是标题乱码；二是正文乱码。下边具体说明这两种乱码的解决方案。
标题乱码
Log4J日志邮件的标题在配置文件log4j.properties里设定，如下

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppenderlog4j.appender.MAIL.Threshold=FATALlog4j.appender.MAIL.BufferSize=10log4j.appender.MAIL.From=[e-mail]=[e-mail]= Log4J提醒您：系统发生了严重错误log4j.appender.MAIL.To=[e-mail],[e-mail]=com.sun.DefineLayOutlog4j.appender.MAIL.layout.LocationInfo=true

灰色的行就是标题，log4J配置文件默认的读取方式是ISO-88591，遇到中文会出现乱码，我们可以把这个配置文件log4j.properties用jdk的工具native2asii转换一下编码方式。
命令：native2asii log4j.properties log4jxx.properties
把这个log4jxx.properties改名为log4j.properties取代原来的log4j.properties就ok了。
灰色行重新编码后是：
log4j.appender.MAIL.Subject=Log4J\u63d0\u9192\u60a8\uff1a\u7cfb\u7edf\u53d1\u751f\u4e86\u4e25\u91cd\u9519\u8bef
正文乱码
正文乱码，解决也比较简单。阅读Log4J的源码类SMTPAppender，我们可以发现sendBuffer()方法中有这样一句：
part.setContent(sbuf.toString(), layout.getContentType());
我们继续追踪发现layout就是配置文件里的layout属性对应的布局模式。但是这些布局模式都是继承自Layout，而contentType是只可通过getContentType方法取得，不能修改。所有的布局模式getContentType方法返回的都是”text/plain”；
为处理中文乱码，我们可以写一个布局模式。如果你要使用HTMLLayout，我们就写一个HTMLLayout的子类，覆盖HTMLLayout的getContentType方法即可。假如我要用org.apache.log4j.HTMLLayout。我们就可以写一个DefineLayOut类，代码如下：

package com.sun;import org.apache.log4j.HTMLLayout;public class DefineLayOut extends HTMLLayout{        public String getContentType() {                return "text/html;charset=GBK";        }}

对应的配置文件设置如黄色行所示。