JDK1.4的java.util.Logging包的使用说明与示例
Sun公司推出的JDK1.4版本在java.util.Logging软件包中新增加了处理应用程序日志工作的核心API函数。这个Java日志软件包提供了一种为Java应用程序嵌入多级日志的简单而又灵活的方法。<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
简要介绍
java.util.Logging包括1个接口: Filter;15个类: Logger, LogManager, ErrorManager, Level, LogRecord, LoggingPermission, Handler, MemoryHandler, StreamHandler, ConsoleHandler, FileHandler, SocketHandler, Formatter, SimpleFormatter, XMLFormatter,下面是这些类的简单关系是
处理器的继承关系
<?xml:namespace prefix = v ns = "urn:schemas-microsoft-com:vml" /><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt"><p></p></span></p> </div> </td></tr></tbody></table></textbox><shapetype id="_x0000_t176" path="m@0,0qx0@0l0@2qy@0,21600l@1,21600qx21600@2l21600@0qy@1,0xe" adj="2700" o:spt="176" coordsize="21600,21600"><stroke joinstyle="miter"></stroke><formulas><f eqn="val #0"></f><f eqn="sum width 0 #0"></f><f eqn="sum height 0 #0"></f><f eqn="prod @0 2929 10000"></f><f eqn="sum width 0 @3"></f><f eqn="sum height 0 @3"></f><f eqn="val width"></f><f eqn="val height"></f><f eqn="prod width 1 2"></f><f eqn="prod height 1 2"></f></formulas><path textboxrect="@3,@3,@4,@5" o:connectlocs="@8,0;0,@9;@8,@7;@6,@9" o:connecttype="custom" limo="10800,10800" gradientshapeok="t"></path></shapetype><shape id="_x0000_s1028" style="MARGIN-TOP: 23.05pt; Z-INDEX: 3; LEFT: 0px; MARGIN-LEFT: 153pt; WIDTH: 54pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" type="#_x0000_t176"><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN">Handler</span></p> </div> </td></tr></tbody></table></textbox></shape><roundrect id="_x0000_s1029" style="MARGIN-TOP: 72.25pt; Z-INDEX: 4; LEFT: 0px; MARGIN-LEFT: 54pt; WIDTH: 108pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox style="mso-next-textbox: #_x0000_s1029"><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">MemoryHandler</span></p> </div> </td></tr></tbody></table></textbox></roundrect><roundrect id="_x0000_s1030" style="MARGIN-TOP: 122.85pt; Z-INDEX: 5; LEFT: 0px; MARGIN-LEFT: 99pt; WIDTH: 99pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">ConsoleHandler</span></p> </div> </td></tr></tbody></table></textbox></roundrect><roundrect id="_x0000_s1031" style="MARGIN-TOP: 72.25pt; Z-INDEX: 6; LEFT: 0px; MARGIN-LEFT: 198pt; WIDTH: 99pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">StreamHandler</span></p> </div> </td></tr></tbody></table></textbox></roundrect><roundrect id="_x0000_s1032" style="MARGIN-TOP: 122.85pt; Z-INDEX: 7; LEFT: 0px; MARGIN-LEFT: 207pt; WIDTH: 81pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">FileHandler</span></p> </div> </td></tr></tbody></table></textbox></roundrect><roundrect id="_x0000_s1033" style="MARGIN-TOP: 122.85pt; Z-INDEX: 8; LEFT: 0px; MARGIN-LEFT: 297pt; WIDTH: 90pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">SocketHandler</span></p> </div> </td></tr></tbody></table></textbox></roundrect><stroke endarrow="block"></stroke><stroke endarrow="block"></stroke><stroke endarrow="block"></stroke><stroke endarrow="block"></stroke><stroke endarrow="block"></stroke>
格式化器的继承关系
<textbox><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt"><p></p></span></p> </div> </td></tr></tbody></table></textbox><roundrect id="_x0000_s1042" style="MARGIN-TOP: 37.35pt; Z-INDEX: 17; LEFT: 0px; MARGIN-LEFT: 180pt; WIDTH: 1in; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox style="mso-next-textbox: #_x0000_s1042"><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">Formatter</span></p> </div> </td></tr></tbody></table></textbox></roundrect><stroke endarrow="block"></stroke>
<stroke endarrow="block"></stroke><roundrect id="_x0000_s1043" style="MARGIN-TOP: 1.05pt; Z-INDEX: 18; LEFT: 0px; MARGIN-LEFT: 99pt; WIDTH: 99pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox style="mso-next-textbox: #_x0000_s1043"><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">SimpleFormatter</span></p> </div> </td></tr></tbody></table></textbox></roundrect><roundrect id="_x0000_s1044" style="MARGIN-TOP: 1.05pt; Z-INDEX: 19; LEFT: 0px; MARGIN-LEFT: 243pt; WIDTH: 99pt; POSITION: absolute; HEIGHT: 23.4pt; TEXT-ALIGN: left" arcsize="10923f"><textbox style="mso-next-textbox: #_x0000_s1044"><table cellspacing="0" cellpadding="0" width="100%"><tbody><tr><td style="BORDER-RIGHT: #d4d0c8; BORDER-TOP: #d4d0c8; BORDER-LEFT: #d4d0c8; BORDER-BOTTOM: #d4d0c8; BACKGROUND-COLOR: transparent"> <div> <p class="MsoNormal" style="MARGIN: 0cm 0cm 0pt"><span lang="EN" style="FONT-SIZE: 12pt">XMLFormatter</span></p> </div> </td></tr></tbody></table></textbox></roundrect>
类/接口功能概要
1. Filter(过滤器):控制日志记录的输出粒度, 粒度范围超过了Level类提供的功能,在每个handler的setFilter方法中设置该类型
2. Logger(日志记录器): 为了利用日志软件包，Logger对象并调用Logger中多个记录方法中的某一个，例如info(String message)。日志记录器Logger创建一个LogRecord（包含应用程序具体的日志信息）对象并把它传递到一个或者多个Handler，Handler对象再把它输出到目标，这样就实现了日志记录的输出。在日志的输出过程中，Logger和Handler对象可以根据日志等级和过滤器（Filter）来判断那些日志需要记录下来。同时，Handler与Formatter协同工作，Formatter对日志信息进行格式化，决定日志记录如何输出到日志
3. LogManager(日志管理器):管理一个日志记录器对象的名称空间,所有已命名的日志记录器都被保存在这个名称空间中;管理一套日志记录的控制属性,这些是简单的值对像,可以被Handler和logging对象使用来进行自我配置;
4. ErrorManager(错误管理器): ErrorManager对象依附在Handler对象上,用来处理在记录日志期间发生在Handler对象上的任何错误.但在处理输出日志时,假如Handler对象遇到问题时, Handler并没有抛出异常给日志记录的调用者,而是用依附在Handler上的ErrorManager来处理。
5. Level(等级): 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 |
6. LogRecord(记录信息): LogRecord对象用来在日志框架和单个日志记录Handler之间传递日志记录请求,当一个LogRecord被传递进框架时, 在逻辑上它是属于框架的,不应该被客户应用程序使用或更新
注意:假如客户应用程序没有指定一个显式的来源方法名称和来源类名称, 当他们(方法或类)第一次被访问时(由于对getSourceMethodName或者getSourceClassName方法的调用),LogRecord类将通过分析调用堆栈,自动推断他们.因此,假如一个日志处理器想停止传递一个LogRecord给另一个线程,或者通过RMI传播,并且假如它后来想得到方法和类名,它应该调用getSourceClassName或getSourceMethodName来确保有值被填入.
7. LoggingPermission(记录许可):当代码和一个调用日志记录控制方法的安全管理器(SecurityManager)一起运行的时候,安全管理器(SecurityManager)将检测这个许可.当前仅仅有一个LoggingPermission.这值控制,并且它有控制日志记录配置的能力,例如添加或删除Handler,添加或删除过滤器,或者改变日志等级.程序员不必直接创建LoggingPermission对象.而是由读取的安全策略文件(security policy file)来创建
8. Handler(处理器): Handler对象从Logger那里获得日志信息并且将它输出。可能会输出到控制台，或者输出到文件，或者把这些日志信息发送到网络中的日志服务，或者把它们转发给操作系统日志，或者其他什么。。JDK1.4日志API提供了两大类Handler对象。MemoryHandler简单的把日志消息保存在循环内存缓冲（circular memory buffer），当特定的触发事件发生时，再把它们发布到目标handler。典型的触发事件是接收到等级符合发布等级的日志消息。如果需要其它发布标准，MemoryHandler类可以扩展，重写日志方法来按照用户定义的日志记录条件来发布内存缓冲。StreamHandler向指定的输出流发布日志记录。Java日志API指定了三种StreamHandler对象。ConsoleHandler向标准错误流发布日志记录。FileHandler向指定的文件发布日志记录，它也可以配置成向循环文件集写入日志记录。SocketHandler向网络流发布日志记录（与其它应用通信）。可以通过调用setLevel(Level.OFF)使处理器无效,也可以通过调用setLevel方法的一个适当的等级使其有效.处理器类用LogManager属性来设置处理器的过滤器,格式化和等级的默认值.
9. MemoryHandler(存储处理器):把请求缓冲在内存的循环缓冲区内,通常这个处理器简单地把引入的LogRecord存贮在缓冲区,并丢弃以前的记录.这个缓冲很便宜并且避免了格式化.在某些特殊情况下, MemoryHandler将把当前缓冲区中内容挤出到目标缓冲区. 主要有三种引发挤压缓冲区的模型:
n 引入的LogRecord有一个大于以前定义等级的类型,也就是挤压等级
n 一个外部类显示地调用挤压方法
n 一个子类重载log方法,并且扫描每个引入的LogRecord,假如它匹配需求标准,将调用挤压方法
10. StreamHandler(流处理器):流基于日志记录处理器(logging Handler),这主要是作为一个基类或支持类来实现其他日志记录处理器. LogRecord被发送到一个给定的java.io.OutputStream.
11. ConsoleHandler(控制台处理器):这个处理器向标准错误流(System.err)发送日志记录,默认SimpleFormatter被用来产生简短的概要
12. FileHandler(文件处理器):简单文件日志处理器.FileHandler可以写到一个指定的文件,或者一套循环文件.对一套循环文件,当每个文件达到一个指定大小的时候,它将被关闭,循环出去,一个新的文件被打开.老的文件将按顺序加上"0", "1", "2". 默认用XMLFormatter来格式化
13. SocketHandler(网络处理器):发布LogRecord到一个网络流连接.默认用XMLFormatter来格式化
14. Formatter(格式化器):格式化器提供格式化LogRecord支持.每个日志处理器器都有一个格式化器格.式化器获得一个LogRecord,并把它转化为字符串.有一些格式化器(例如XMLFormatter)需要包装头和尾字符串围绕一套格式化记录. GetHeader和getTail方法可以用来获得这些字符串.
15. SimpleFormatter(简单格式化器): Print a brief summary of the LogRecord in a human readable format. The summary will typically be 1 or 2 lines用一种可以阅读的格式来打印LogRecord的简单概要.典型的概要是1或者2行.
16. XMLFormatter(XML格式化器):把LogRecord格式化尾标准的XML格式.DTD规范在Java Logging APIs规范的附录A中提供
示例剖析
1. 简单示例
这个示例说明logging的常用操作
public class JDK14LoggingTest {
/**
日志记录器
*/
Logger log = Logger.getLogger(getClass().getName());
/**
* 日志输出对象
*/
Handler fileHandler = null;
/**
* 构造方法
*/
public JDK14LoggingTest() {
//设置输出到文件
try {
fileHandler = new FileHandler("%h/java%u.log");
// fileHandler = new FileHandler("%h/java%u.log",10,5,true);
// 设置记录级别
fileHandler.setLevel(Level.WARNING);
// 设置过滤器,已达到更细粒度的记录
// fileHandler.setFilter();
// 设置输出格式,有两种类型:SimpleFormatter和XMLFormatter,
// 默认是XMLFormatter,当然自己也可以扩张,只要继承Formatter类就可以了
fileHandler.setFormatter(new SimpleFormatter());
// 指定日志编码格式
// fileHandler.setEncoding("");
// 设置错误处理
// fileHandler.setErrorManager(new ErrorManager());
}
catch (Exception ex) {
ex.printStackTrace();
}
log.addHandler(fileHandler);
}
public void testLog(){
log.info(getClass().getName());
log.log(Level.WARNING,getClass().getName(),"testLog");
}
public static void main(String[] args) {
JDK14LoggingTest test = new JDK14LoggingTest();
test.testLog();
}
}
2. 数据库Handler示例
从上面的描述可以看出,jdk1.4的logging没有提供输出到数据库的Handler,下面将介绍一个怎样把日志输出到数据库, 我们知道Handler对象负责从Logger那里获取日志信息然后把它输出到目的地。而用户希望把日志存储到数据库中，其实这只是把日志信息的输出目标替换为数据库而已。所以编