Log4j自定义Appender

1.    概述

    在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。

    Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

2.    Log4J扩展

2.1.  主要组件

1.       logger（日志记录器）：控制要启用或禁用哪些日志记录语句。可以对日志记录器指定如下级别： ALL 、 DEBUG 、 INFO 、 WARN 、 ERROR , FATA或 OFF 。

2.       layout（布局）：根据用户的愿望格式化日志记录请求。

3.       appender：向目的地发送格式化的输出。

2.2.  内置Appender

l ConsoleAppender （控制台）

l FileAppender （文件）

l DailyRollingFileAppender （每天产生一个日志文件）

l RollingFileAppender （文件大小到达指定尺寸的时候产生一个新的文件）

l WriterAppender （将日志信息以流格式发送到任意指定的地方）

2.3.  扩展步骤

1.       扩展 AppenderSkeleton 抽象类。

2.       指定您的 appender 是否需要 layout。

3.       如果某些属性必须同时激活，则应该在 activateOptions() 方法内完成。

4.       实现 close() 方法。它必须把 closed 字段的值设置为 true 。记得释放所有资源。

5.       可选地指定要使用的默认 ErrorHandler 对象。系统默认为OnlyOnceErrorHandler,它发送出第一个错误的消息并忽略其余的所有错误,错误消息将输出到 System.err。

6.       编写 append() 方法的代码。这个方法负责附加日志记录事件，并在错误发生时负责调用错误处理程序。

3.    一个简单的例子

3.1.  下载资源

1.       下载地址：http://www.apache.org/dyn/closer.cgi/logging/log4j

2.       将jar包加载到Class Path下:

3.2.  Java代码

package com.aeai.appender;

 

import org.apache.log4j.AppenderSkeleton;

import org.apache.log4j.spi.LoggingEvent;

 

public class logUI extends AppenderSkeleton{

  

   privateint maxSize;

 

   @Override

   protectedvoid append(LoggingEvent event) {

       System.out.println("%%"+ event.getMessage() +" %%  maxSize:" + maxSize);

   }

  

   @Override

   publicvoid close() {}

 

   @Override

   publicboolean requiresLayout() {

       returnfalse;

   }

 

   publicint getMaxSize() {

       returnmaxSize;

   }

 

   publicvoid setMaxSize(int maxSize) {

       this.maxSize = maxSize;

   }

}

3.3.  Log4j配置文件

# Set root logger level to error

log4j.rootLogger=INFO, Customer,File

 

###### Customer appender definition #######

log4j.appender.Customer=com.aeai.appender.logUI

log4j.appender.Customer.maxSize=100

 

###### File appender definition #######

log4j.appender.File=org.apache.log4j.RollingFileAppender

log4j.appender.File.File=logs/log.log

log4j.appender.File.Append=true

log4j.appender.File.MaxFileSize=500KB

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

log4j.appender.File.layout.ConversionPattern=%d{yyyy-MM-ddHH:mm:ss,SSS}%-5p%m%n  

3.4.  测试