Java那些事之Log4j

上次跟大家分享了java使用berkeley db。这一次，再跟大家分享一个开源组件，大名鼎鼎的log4j。这里需要首先声明一点，我在这里和大家分享的，都是我的个人实际经验，只是把我知道的东西尽可能多的分享。但是对于技术本身，可能还有很多更深入更有意思的东西，是我没有接触到或者没有研究的，如果各位对此有更深的研究，欢迎大家一起切磋补充。在这里先拜谢了~

下面进入正题，前一阵用了一下log4j，感觉还是挺不错的，可以支持配置文件和程序代码对log进行配置，灵活方便，也具有一定的扩展性，简单介绍一下。

首先还是说一下获取方式，去http://logging.apache.org/log4j/1.2/这个地址下载log4j的最新版本，然后添加到java项目中就可以了。

在介绍方法之前，首先对log4j的参数做一个总体的概述：

输出级别的种类
ERROR、WARN、INFO、DEBUG
ERROR 为严重错误 主要是程序的错误
WARN 为一般警告，比如session丢失
INFO 为一般要显示的信息，比如登录登出
DEBUG 为程序的调试信息
配置日志信息输出目的地
log4j.appender.appenderName = fully.qualified.name.of.appender.class
1.org.apache.log4j.ConsoleAppender（控制台）
2.org.apache.log4j.FileAppender（文件）
3.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
4.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
5.org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
配置日志信息的格式
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
控制台选项
Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台
FileAppender 选项
Threshold=DEBUF:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
RollingFileAppender 选项
Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
日志信息格式中几个符号所代表的含义：
-X号: X信息输出时左对齐；
%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%: 输出一个"%"字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。
注 以上参数说明来自：http://blog.csdn.net/azheng270/archive/2008/03/12/2173430.aspx 有兴趣的朋友可以直接去那里学习，还有更详细的解释。

使用方法如下，首先需要有一个log4j的配置文件，我们就取名为log4j.properties

log4j.logger.URL_Expand=DEBUG, url_expand
log4j.appender.url_expand=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.url_expand.File=url_expand.log
log4j.appender.url_expand.layout=org.apache.log4j.PatternLayout
log4j.appender.url_expand.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.url_expand.DatePattern=yyyy-MM-dd

log4j.logger.Downloader=DEBUG, downloader
log4j.appender.downloader=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.downloader.File=downloader.log
log4j.appender.downloader.layout=org.apache.log4j.PatternLayout
log4j.appender.downloader.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.downloader.DatePattern=yyyy-MM-dd

上面指定了log的各种信息，但是请注意，这里我把文件名注释掉了。这是因为我需要动态指定文件名，因为有些程序可能并不是单机运行，而是很多机器一起运行，而最后又要把log放在一起，如果文件名都相同，就会出现新文件覆盖旧文件的情况。而且文件之间还有混淆，因此我在文件名前打算加上机器的主机名，这样既避免了刚才的问题，还可以一目了然日志的所有者是哪台机器，一举两得啊。

要动态指定日志名称，我目前的办法是在程序中，修改配置文件

View Code

1 public static void ConfigByProperties()
2 {
3 PropertyConfigurator.configure(CommonValues.Log_Setting_Path);
4 String hostName = "";
5 try {
6 hostName = InetAddress.getLocalHost().getHostName();
7 } catch (UnknownHostException e1) {
8 // TODO Auto-generated catch block
9 e1.printStackTrace();
}
Appender appender = logger_URL.getAppender("yourapperdername");
if(appender instanceof FileAppender){
FileAppender fappender = (FileAppender)appender;
fappender.setFile(CommonValues.Log_URL_Path+hostName+"_"+CommonValues.Log_URL_Name);
fappender.activateOptions();
}
}

这样就可以实现效果了。大家快去试试吧~

另外，log4j还可以和邮件相结合，你可以指定当发生了什么级别的事件时，系统会自动向你发送邮件，这样你可以及时知道错误的发生，第一时间去处理，提高工作效率。下面我们来看看怎么发邮件吧。

首先要下载两个jar：activation.jar和mail.jar 具体地址我不记得了，大家去搜一下吧。应该有很多地方都可以下载的到。

之后也是要把jar加到java工程中来，然后就可以进行配置了。不用写代码哦~

配置如下，只需要再之前的配置文件的log4j.logger.URL_Expand=DEBUG, url_expand这一行，添加MAIL，然后再后面加上MAIL的配置就行了

log4j.logger.URL_Expand=DEBUG, url_expand,MAIL
log4j.appender.url_expand=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.url_expand.File=url_expand.log
log4j.appender.url_expand.layout=org.apache.log4j.PatternLayout
log4j.appender.url_expand.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.url_expand.DatePattern=yyyy-MM-dd

log4j.logger.Downloader=DEBUG, downloader,MAIL
log4j.appender.downloader=org.apache.log4j.DailyRollingFileAppender
#log4j.appender.downloader.File=downloader.log
log4j.appender.downloader.layout=org.apache.log4j.PatternLayout
log4j.appender.downloader.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.downloader.DatePattern=yyyy-MM-dd

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold=FATAL
log4j.appender.MAIL.BufferSize=1
log4j.appender.MAIL.SMTPHost=smtp.163.com
log4j.appender.MAIL.SMTPDebug=false
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.SMTPUsername=username
log4j.appender.MAIL.SMTPPassword=password
log4j.appender.MAIL.From=email address
log4j.appender.MAIL.To=your email address
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

其中，需要指定Threshold也就是发邮件的级别，如果是info，则info以及error还有fatal都会发邮件。

还需要指定邮件服务器（163测试通过），发件地址，密码，收件地址和信件格式等。这个大家自己去试试吧。

只要正常写日志，如果级别超过或等于Threshold中指定的级别，就会发送邮件，不用额外进行编码。