Sun公司推出的JDK1.4版本在java.util.日志Logging软件包中新增加了处理应用程序日志工作的核心API函数。这个Java日志软件包提供了一种为Java应用程序嵌入多级日志的简单而又灵活的方法。
日志Logging软件包
为了利用日志软件包,你只需获得一个Logger对象并调用Logger中多个记录方法中的某一个,例如info(String message)。日志记录器Logger创建一个LogRecord(包含应用程序具体的日志信息)对象并把它传递到一个或者多个Handler,Handler对象再把它输出到目标,这样就实现了日志记录的输出。在日志的输出过程中,Logger和Handler对象可以根据日志等级和过滤器(Filter)来判断那些日志需要记录下来。同时,Handler与Formatter协同工作,Formatter对日志信息进行格式化,决定日志记录如何输出到日志。应用程序记录日志的时序图如下图所示。
下面看一个非常简单的应用程序记录日志的示例,如下所示:
Logger log = Logger.getLogger(this.getClass().getName());
log.info(“log message”);
日志等级
Java 日志软件包对每一个日志消息都赋以一个等级,以控制日志记录的输出。等级是一个整型数据,记录的等级越高,那么这个整型数据也就越大。下面的等级是在Level类中定义的(按照从低到高的顺序排列):
日志等级表
级别
重要性
日志记录器相应的日志方法
级别数值
SEVERE
非常重要
severe(String message);
1000
WARNING
针对警告
warning(String message);
900
INFO
信息化的运行时间消息
info(String message);
800
CONFIG
静态设置的消息
config(String message);
700
FINE
提供追踪信息
fine(String message);
500
FINER
显示详细的追踪信息
finer(String message);
400
FINEST
更详细的追踪信息
finest(String message);
300
ALL
显示所有应该日志记录的信息
没有可应用的
Integer.MIN_VALUE
OFF
关闭日志
没有可应用的
Integer.MAX_VALUE
你可以给Logger和Handler指定一个最小日志等级,那么只有其等级等于或者高于这个最小记录等级的日志消息才会被记录下来。除了日志等级之外,Level类还定义了OFF等级和ALL等级,OFF等级用来关闭日志记录功能,所有日志都不被记录下来。而ALL等级的日志无论Logger和Handler的最小记录等级是什么都会被记录下来。
Handler对象
Handler对象从Logger那里获得日志信息并且将它输出。可能会输出到控制台,或者输出到文件,或者把这些日志信息发送到网络中的日志服务,或者把它们转发给操作系统日志,或者其他什么。JDK1.4日志API提供了两大类Handler对象。MemoryHandler简单的把日志消息保存在循环内存缓冲(circular memory buffer),当特定的触发事件发生时,再把它们发布到目标handler。典型的触发事件是接收到等级符合发布等级的日志消息。如果需要其它发布标准,MemoryHandler类可以扩展,重写日志方法来按照用户定义的日志记录条件来发布内存缓冲。
StreamHandler向指定的输出流发布日志记录。Java日志API指定了三种StreamHandler对象。ConsoleHandler向标准错误流发布日志记录。FileHandler向指定的文件发布日志记录,它也可以配置成向循环文件集写入日志记录。SocketHandler向网络流发布日志记录(与其它应用通信)。
编写自己的JDBCHandler对象
我们在记录应用程序日志时,经常遇到这样的需求,用户希望把日志存储到数据库表中。通常的做法就是自己编写一个日志记录类,该日志类负责把应用程序的日志通过JDBC写入数据库中。而现在我们可以扩展JDK1.4日志Logging软件包中的Handler来满足应用程序的特殊需求。
我们知道Handler对象负责从Logger那里获取日志信息然后把它输出到目的地。而用户希望把日志存储到数据库中,其实这只是把日志信息的输出目标替换为数据库而已。所以编写扩展Handler的JDBCHandler类,由它来实现把日志信息写入到数据库中。要想扩展Handler类,必须实现Handler定义的三个抽象函数(abstract):
public abstract void flush() ;
public abstract void publish(LogRecord record) ;
public abstract void close() throws java.lang.SecurityException;
其中,publish(LogRecord record)方法最为重要,它最终实现把日志信息输出到目标。close()方法负责释放所有handler所拥有的资源。这次我们只在publish(LogRecord record)方法中实现把日志信息(封装在LogRecord对象中)通过合适的JDBC驱动程序插入到数据库中就可以了。下面我就以向Oracle数据库输出日志记录为例,publish方法实现如下:
public void publish(LogRecord record) {
Connection conn = null;
PreparedStatement pstmt = null;
try{
//get database connection
conn = getConnection();
if(conn != null){
Object[] content = record.getParameters();
String sql = "insert into MyLog(logTime,EventType) values(?,?)";
pstmt = conn.prepareStatement(sql);
pstmt.setLong(1,record.getMillis());
pstmt.setString(2,(String)content[0]);
//save loginfo in databse
pstmt.execute();
}
}catch(Exception e){
e.printStackTrace();
}
finally{
//release connection
destroy(conn,pstmt,null);
}
}
现在我们就用刚刚编写的JDBCHandler来向数据库写入日志,请看如下代码片断:
Logger log = Logger.getLogger("");
JDBCHandler jdbc = new JDBCHandler();
log.addHandler(jdbc);
String[] content = {"insert"};
LogRecord lr = new LogRecord(Level.INFO,"second test message");
lr.setParameters(content);
// first insert log
log.log(Level.INFO,"first test message",content);
//second insert log
log.log(lr);
从以上代码可以看出,写入日志的程序没有太大的变化。唯一需要指出的就是,日志记录器Logger是利用刚才编写的JDBCHandler对象来输出日志。通过Logger对象的addHandler(Handler handler)方法指定JDBCHandler对象。
结束语
还可以利用Format对象对日志信息进行格式化,例如,可以用来生成JDBCHandler所需要的sql语句,对其中与应用相关的日志信息数据进行格式转化等。还可以扩展LogRecord类来满足现实世界中的具体需求,增加日志输出的具体内容。
参考
Sun公司的JDK1.4版本java.util.日志Logging软件包的源程序。