使用log4j的邮件功能

文章转载http://www.blogjava.net/libin2722

Log4j的邮件功能能够为我们做这样的事情----当程序运行完的时候，或者正在运行也是可以的，它将程序的日志通过邮件的方式发到你的邮箱上。

这样，对于程序运行的控制就不用每次都跑到机器上去看日志文件这么麻烦了，我们需要的只是，开开Foxmail，用用鼠标，就可以知道，程序到底运行的怎么样了。

 

• 使用log4j-1.2.15

之前用的是 log4j-1.2.8 ，照理说，它们之间的版本号的区别够小，应该没有什么区别，但是事实却让我丈二摸不着头脑。

发送邮件的一个重要的类是SMTPAppender。

在1.2.8的版本中，SMTPAppender没有smtpPassword 和smtpUsername 属性。这两个属性分别是登录smtp服务器用的用户名和密码。笔者到现在也没有想明白，在通常的情况下怎样才可以不登录smtp服务器就可以发送邮件了。有知道的朋友，就留个言吧，先谢过啦。

由于不能解决上面的那个问题，我就只好使用1.2.15这个版本啦。

• log4j.properties文件

 

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender

log4j.appender.MAIL.BufferSize=10

log4j.appender.MAIL.From=[e-mail]

log4j.appender.MAIL.SMTPHost=mail.domain.com

log4j.appender.MAIL.Subject=Log4JMessage

log4j.appender.MAIL.To=[e-mail]

log4j.appender.MAIL.SMTPUsername=username

log4j.appender.MAIL.SMTPPassword=password

log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

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.MAIL=org.apache.log4j.net.SMTPAppender

log4j.appender.MAIL.BufferSize=10

log4j.appender.MAIL.From=yourname@ domain.com

log4j.appender.MAIL.SMTPHost=mail.domain.com

log4j.appender.MAIL.Subject=Log4J Message

log4j.appender.MAIL.To=[e-mail]

log4j.appender.MAIL.SMTPUsername=username

log4j.appender.MAIL.SMTPPassword=password

log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

这个文件配好以后，恭喜你，现在log4j的邮件功能，你就可以体会了。

• SMTP的级别默认是ERROR级别的，怎么办

默认的级别是ERROR级别的，那就是说，只有程序出错了，你才可以收到邮件，很显然，这还不能满足我们日常管理的要求。我们需要自定义的级别。

为此，笔者继承了TriggeringEventEvaluator类，覆盖里面的一个方面，如下所示

@Override
publicbooleanisTriggeringEvent(LoggingEventarg0){
returnarg0.getLevel().isGreaterOrEqual(Level.INFO);
}

@Override
	public boolean isTriggeringEvent(LoggingEvent arg0) {
		return arg0.getLevel().isGreaterOrEqual(Level.INFO);
	}

 

• 每遇到一个触发事件就发一封邮件！

SMTPAppender 实现是，每当isTriggeringEvent（）这个方法返回true的时候，它都会发送邮件。这样的话，一个程序执行下来，每个有能力触发的事件都会形成一封邮件。这显然不是我们希望看到的场面。

笔者继承了SMTPAppender类，重装了append方法。

@Override
publicvoidappend(LoggingEventevent){

if(!checkEntryConditions()){
return;
}

event.getThreadName();
event.getNDC();
event.getMDCCopy();
if(this.getLocationInfo()){
event.getLocationInformation();
}
cb.add(event);
if(evaluator.isTriggeringEvent(event)){
if(cb.length()>this.getBufferSize()/2){
sendBuffer();
}

}
}

@Override
	public void append(LoggingEvent event) {

		if (!checkEntryConditions()) {
			return;
		}

		event.getThreadName();
		event.getNDC();
		event.getMDCCopy();
		if (this.getLocationInfo()) {
			event.getLocationInformation();
		}
		cb.add(event);
		if (evaluator.isTriggeringEvent(event)) {
			if (cb.length() > this.getBufferSize() / 2) {
				sendBuffer();
			}

		}
	}

这样的话，当事件的个数达到bufferSize的一半的时候就会发一封邮件了。

但是另外一个问题也随之产生了，当程序结束时，还在缓冲里面的事件是不会被发送出来的。因为事件数往往没有bufferSize的一半。

 

public*****SMTPAppender(){
Runtime.getRuntime().addShutdownHook(newThread(){

@Override
publicvoidrun(){
if(cb.length()>0){
sendBuffer();
}

}

});
}

public   *****SMTPAppender() {
		Runtime.getRuntime().addShutdownHook(new Thread() {

			@Override
			public void run() {
				if (cb.length() > 0) {
					sendBuffer();
				}

			}

		});
	}

 

笔者在构造函数中，添加了一个程序结束时运行的线程，来处理这个问题。

• 设置Html格式的输出

按照刚刚笔者给出的配置文件，所产生的邮件的格式是纯文本的。其实log4j有网页格式的输出的。

 

log4j.appender.MAIL.layout=org.apache.log4j.HTMLLayout

log4j.appender.MAIL.layout=org.apache.log4j.HTMLLayout

 

这样的话，邮件就好看很多啦。

• 解决邮件中的中文乱码问题

最后，你会发现中文是乱码的，而且HTMLLayout没有提供编码方式的属性设置，哎，又是一阵无语中。

得，笔者也就只好再写一个类，继承HTMLLayout,覆盖getContentType方法

 

@Override
publicStringgetContentType(){
return"text/html;charset=GBK";

}

@Override
	public String getContentType() {
		return "text/html;charset=GBK";

	}

添加上述功能之后的配置文件如下所示：

log4j.appender.MAIL.To=[e-mail]

log4j.appender.MAIL.From=[e-mail]

log4j.appender.MAIL.SMTPHost=smtp.domain.com

log4j.appender.MAIL.Subject=Information

log4j.appender.MAIL.SMTPUsername=username

log4j.appender.MAIL.SMTPPassword=password

log4j.appender.MAIL.EvaluatorClass=com.wole.***.MailEvaluator

log4j.appender.MAIL.layout=com.wole.log4j.net.DefaultLayOut