3.5 使用日志系统 - 《JSP高级程序设计》 - 免费试读

System.out.println 提供了输出信息的一个基本功能，但println往往不是输出信息的最佳选择。要使用 println，必须创建所有要记录的信息，包括时间戳、文件名和你希望所有消息都提供的其他信息；而且也没有办法轻松地做到想要消息的时候就启用，不想要消息的时候就禁用。一般来说，代码投入生产环境时，你可能不希望其中还留有println语句。出于这些原因，println语句非常适用于临时性的实验，在这种环境下可以很快有所收获；但是不能把它作为一种用于长期观察的手段，要想长期地观察代码中发生了什么，就要另做选择。日志系统（logging system）可以解决这些问题。

日志（log）就是规范地记录下来的信息。数百年来，船长都会对船上发生的事件记录航海日志，包括船的位置、温度、天气以及特殊的事件。对于计算机来说，日志也有类似的功用，用于记录程序的状态，以及程序执行时出现的事件。日志记录（logging）是指创建日志和写入日志的过程。

3.5.1 通过servlet容器记录日志

System.out.println只提供了非常原始的日志记录功能，servlet容器还需要提供标准的日志服务以便记录消息。只需对servlet调用log() 方法，就可以得到这个日志服务。

实验：调用 log方法

JSP要编译为一个servlet，所以可以向容器提供的日志服务发送消息，如以下JSP所示：

<%@page pageEncoding="UTF-8"%>

<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

<html>

<body>

<c:forEach var="loopCount" begin="1" end="10" step="1" >

<c:set var="myCount" value="${loopCount-5}" />

<c:out value="${myCount}"/></br>

<% String message = “loopCount="

+ pageContext.findAttribute("loopCount")

+ " myCount="

+ pageContext.findAttribute("myCount");

this.log( message );

</c:forEach>

</body>

</html>

录入以上代码，并命名为Example5.jsp。这与前面使用System.out.println的代码基本上是一样的，不过，这里不是把消息发送给标准输出，而是用下面的语句交给了容器日志文件。

this.log(message);

Tomcat 5 日志文件的输出如下：

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=1 myCount=-4

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=2 myCount=-3

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=3 myCount=-2

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=4 myCount=-1

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=5 myCount=0

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=6 myCount=1

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=7 myCount=2

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=8 myCount=3

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=9 myCount=4

2004-07-12 21:51:17 StandardContext[/BegJsp]jsp: loopCount=10 myCount=5

可以在Tomcat 安装目录的logs目录下找到这个日志文件，文件名通常是localhost _log.<<date_string>>.txt。在其中可以得到日期和时间戳信息，还有Tomcat日志系统为每个日志项预先规定的上下文信息。

实验解析

之所以能在JSP中调用log方法，是因为基于Web的JSP会编译为一个servlet，这个servlet实现（或扩展）了HttpServlet的合约。HttpServlet 又扩展了GenericServlet，通过GenericServlet类可以访问容器提供的一组日志函数。另外，还可以使用ServletContext访问日志函数。

可以使用容器提供的两个log方法：

q void ServletContext.log( String msg )。

q void ServletContext log( String msg, Throwable throwable )。

前面已经介绍了第一个log方法的使用。第二个方法可以用来记录出现的异常。一般来说，只有当异常得到了处理而且不会再次抛出时才应该记入日志。

相对于使用println语句，使用容器提供的日志系统有很多改进。不过，基于容器的日志系统也存在局限性。例如，我们无法控制把消息记入日志的时间。要想有所控制，就需要日志框架。

3.5.2 利用 JDK 日志记录器记录日志

J2SE 1.4 中引入了日志框架作为Java语言的一个标准部分。日志框架为JVM中运行的所有类提供日志服务。因此，servlet和JSP都可以使用这些日志服务。

实验：使用JDK日志记录器

先来看一个使用日志框架的代码示例：

<%@page pageEncoding="UTF-8"%>

<%@page import="java.util.logging.Logger" %>

<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

<html>

<body>

<% Logger logger = Logger.getLogger(this.getClass().getName()); %>

<c:forEach var="loopCount" begin="1" end="10" step="1" >

<c:set var="myCount" value="${loopCount-5}" />

<c:out value="${myCount}"/></br>

<% String message = "loopCount="

+ pageContext.findAttribute("loopCount")

+ " myCount="

+ pageContext.findAttribute("myCount");

logger.info( message );

</c:forEach>

</body>

</html>

这个示例JSP命名为Example6.jsp。

实验解析

这个例子与前面的例子很类似，只是突出显示的代码行有所区别。import 语句导入了使用JDK日志系统所需的类：

<%@page import="java.util.logging.Logger" %>

接下来的一行得到Logger类的一个实例，以便后面使用：

<% Logger logger = Logger.getLogger(this.getClass().getName()); %>

要得到日志记录器，还要调用this.getClass().getname()传入一个类名（由这个类生成日志消息），这个类名将作为日志记录器的名字。以这个类名创建了日志记录器之后，如果以后基于同一个类名调用getLogger() ，会返回同一个日志记录器实例。

1. 使用LogManager类

不一定非得用类名来命名日志记录器，不过这通常是一个很好的想法。日志记录器由一个名为LogManager的类管理，这个类会控制日志记录器组成的一个层次结构。以上代码中没有显示出LogManager类，不过它会在后台工作。LogManager 利用点分隔的记录器名来控制和建立层次结构。换句话说，这个层次结构建立在点分隔名的基础上。日志记录器会从层次结构中其父记录器继承属性，如图3-3所示。名为examples.webapps.HelloJsp的日志记录器会先从exam- ples.webapps继承属性，然后从examples继承，最后从根日志记录器继承，如图中加粗的路径所示。

图3-3　日志记录器层次结构和继承的例子

2. 日志记录器和日志级别

每个日志记录器都有一个相关的日志级别用于控制了日志记录器要记录哪些消息。日志记录器只会记录不低于相关日志级别的日志消息。如果一个日志记录器没有设置日志级别，就会在日志记录器层次结构中从其父记录器继承日志级别。日志级别通过调用logger.setLevel()方法来设置。

JDK日志记录器支持的日志级别如表3-1所示。

表3-1　JDK日志记录器支持的日志级别

日志级别	说　　明
SEVERE	最高级别，用于记录最重要的消息，如致命的程序错误
WARNING	用于发送警告消息
INFO	默认级别，除非级别属性有修改。这个级别用于记录信息性消息
CONFIG	在设置新的配置或配置设置有变时报告配置设置
FINE	用于提供更详细的信息。通常在诊断或调试问题时使用
FINER	比FINE提供的信息更详细
FINEST	最低级别，用于记录最详细的消息

还有另外两个级别：ALL和OFF，ALL启用所有日志级别，OFF禁用所有日志级别。这两个级别用作为工具来控制日志输出，而不能用于发送消息。

如果发送的消息级别低于日志记录器所设置的日志级别，这个消息就不会发送给处理程序（稍后将谈到），也不会写到控制台、文件或其他任何输出设备。

可以使用一些便利函数在任何级别发送消息，如severe()、warning()、info()、config()、fine()、finer()和finest()，或者使用方法log(Level, message)来达到目的。此外还有一些函数可以记录异常和使用资源包。

下面是示例中发送日志消息的那行代码：

logger.info( message );

这行代码在INFO 级记录一个消息。如果使用以下代码：

logger.fine( message );

就会在FINE 级记录消息。

在这个示例JSP中，消息在INFO级发送。因为在JVM作为SDK的一部分安装时，根日志记录器配置的默认日志级别是INFO。这里之所以在INFO 级发送消息，目的是让例子更简单，不用修改日志记录器的属性，也不用改变任何配置就能运行。如果没有设置任何属性，日志记录器会继承其父日志记录器的属性。如果父日志记录器也没有设置属性，则会进一步从层次结构中的上一层继承，直到继承根日志记录器的属性值。

如前所述，日志记录器配置为会接受不低于某个级别的消息。默认地，日志记录器会配置为接受INFO或以上级别的消息。如果没有修改这个默认配置却使用logger.fine() 来记录消息，所记录的消息就不会出现在日志中。因此，可以使用这个特性来控制日志系统的输出级别，而无需修改代码。

一般地，调试消息会在FINE、FINER或FINEST 级别输出。在测试和调试期间执行代码时，日志记录器要配置为接收在FINE或更高级别上记录的消息。等代码投入生产环境时，再把日志记录器重新配置为忽略INFO级以下的消息。FINE、FINER和FINEST 提供了3种不同的详细程度用来完成调试。通常，我们只需要其中的一种级别就行了。

3. 日志处理器

要掌握JDK日志系统是如何工作的，需要了解3个主要的类，前面我们已经介绍了其中的两个。首先回顾一下这3个类：

q java.util.logging.Logger。

q java.util.logging.LogManager。

q java.util.logging.Handler。

日志记录器提供了按不同详细程度记录消息的方法。日志管理器基于记录器名的层次结构来管理日志记录器。创建日志记录器时会给定一个名字，这样才能放在LogManager管理的层次结构中。由于组成了一个层次结构，日志记录器就能从其父记录器继承属性，还可以从层次结构中其他的祖先记录器继承属性。

第3个类前面提到过，不过还需要更详细地讨论。日志处理器（handler）用于确定日志消息如何发送到输出设备。日志记录器得到一个消息时，它会调用一个或多个日志处理器。每个日志处理器分别向一个输出设备发送消息。输出设备可以是控制台、文件，甚至可以是数据库，不过输出设备要由日志处理器确定。每个日志记录器可能有多个日志处理器，这样只需对日志记录器做一次调用，就能把每个消息记录到多个位置上。日志记录器可以从其父记录器继承处理器，就像由父记录器继承日志级别设置一样。类似于日志记录器，每个日志处理器可以配置为接受或忽略某个指定级别或更低级别上记录的消息。日志处理器的设置与日志记录器的设置是独立的。

由于有这些特点，因此如果把日志记录器的级别设置为FINE，而不是INFO，然后使用logger.fine()来记录消息，消息仍然不会记录到输出设备上，除非把日志处理器也配置为能接受不低于FINE级别的消息。要记录一个消息，日志记录器以及这个日志记录器所用的处理器都必须适当地设置级别，它们的级别都要等于或低于所记录消息的级别。

日志记录器和日志处理器的日志级别必须设置为等于或低于所需消息的级别，只有这样这些消息才会出现在日志输出中。

这说明，可以有一个日志处理器将所有不低于WARNING 级别的消息发送到文件，同时这个日志记录器还连接有另一个日志处理器将FINE级别或更高级别上记录的所有消息发送到控制台。

常用的日志处理器类有3个：

q ConsoleHandler: 将输出发送到 System.err。

q FileHandler: 将输出发送到文件。

q SocketHandler: 将输出发送到网络流连接。

安装SDK时，ConsoleHandler会配置为默认日志处理器。

4. 配置SDK日志框架

默认地，SDK日志框架读取一个属性文件来完成配置。默认文件位于<JAVA_HOME> /jre/lib 目录，文件名是logging.properties。修改这个文件会影响到使用该JVM运行的所有程序；因此，建议在修改这个文件之前先做一个备份。修改配置日志记录器的属性文件只需在启动JVM时增加一个命令行参数，如下：

java -Djava.util.logging.config.file=mylog.properties MyClass

下面是一个简单的示例配置：

############################################################

# Global properties

############################################################

handlers= java.util.logging.ConsoleHandler

.level= INFO

# Sends all log messages to the console

java.util.logging.ConsoleHandler.level = ALL

java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

############################################################

# Logger Specific properties

############################################################

org.apache.jsp.level = FINE

这正是常规Java属性文件的格式。以#打头的代码行是注释。

handlers= java.util.logging.ConsoleHandler

以上代码指定了使用的一组日志处理器类，如果有多个处理器类，则用逗号分隔。在这里，只使用了一个日志处理器类，即Consolehandler 。

.level= INFO 将日志记录器（日志管理器LogManager所管理的层次结构中的根记录器）的默认日志级别设置为INFO。不要忘了前面的点号。

下面这一行将ConsoleHandler 配置为接受所有日志级别（ALL）的消息：

java.util.logging.ConsoleHandler.level = ALL

这里没有讨论格式器（Formatter），这不是本章要讨论的内容。默认地，ConsoleHandler会关联SimpleFormatter 。下面这行代码显式地把格式器设置为SimpleFormatter（没有这一行也完全可以，因为它是默认的格式器，这里主要是为了强调这一点）：

java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

还有其他一些格式器，如XMLFormater ，它采用XML格式来格式化日志消息。

紧接着是最后一行，这是一个特殊化设置，它将示例JSP配置为在FINE级别记录日志，而且使用org.apache.jsp层次结构中日志记录器的所有其他JSP也都在FINE级别记录日志（org.apache.jsp是Tomcat中JSP文件的默认层次结构）：

org.apache.jsp.level = FINE

这个设置会覆盖根日志记录器的默认设置（默认设置为INFO 日志级别）。

在下一个实验中，需要对现在的文件做一些修改。

实验1：利用 SDK日志框架记录日志

首先，建立logging.properties 文件的一个副本，再将原文件替换为前面所列的属性文件。必须先把Tomcat停下来，再重启，这样才会读新的logging.properties 文件。接下来，对前面使用的example6.jsp文件做一点修改，将

logger.info( message );

改为

logger.fine( message );

再保存这个JSP文件。

这一次运行这个JSP文件时，会看到控制台输出或Tomcat stderr.log 文件中有以下记录：