log4j - HTMLLayout

• 

  简述

  如果要在 HTML 格式的文件中生成日志信息，则可以使用 org.apache.log4j.HTMLLayout 来格式化日志信息。

  HTMLLayout 类扩展了抽象的 org.apache.log4j.Layout 类并覆盖了其基类中的 format() 方法以提供 HTML 样式的格式。

  它提供以下要显示的信息：

  • 从应用程序启动到生成特定日志记录事件所经过的时间。
  • 调用日志记录请求的线程的名称。
  • 与此日志记录请求关联的级别。
  • 记录器和记录消息的名称。
  • 程序文件的可选位置信息和调用此日志记录的行号。

  HTMLLayout 是一个非常简单的 Layout 对象，它提供了以下方法：

  序号	方法和说明
  1	setContentType(String) 设置 text/html HTML 内容的内容类型。默认为文本/html。
  2	setLocationInfo(String) 设置日志事件的位置信息。默认为假。
  3	setTitle(String) 设置 HTML 文件的标题。默认为 log4j 日志消息。

• 

  HTML布局示例

  以下是 HTMLLayout 的简单配置文件：

  
  # Define the root logger with appender file
  log = /usr/home/log4j
  log4j.rootLogger = DEBUG, FILE
  # Define the file appender
  log4j.appender.FILE=org.apache.log4j.FileAppender
  log4j.appender.FILE.File=${log}/htmlLayout.html
  # Define the layout for file appender
  log4j.appender.FILE.layout=org.apache.log4j.HTMLLayout
  log4j.appender.FILE.layout.Title=HTML Layout Example
  log4j.appender.FILE.layout.LocationInfo=true
  

  现在考虑以下将生成日志信息的 Java 示例：

  
  import org.apache.log4j.Logger;
  import java.io.*;
  import java.sql.SQLException;
  import java.util.*;
  public class log4jExample{
     /* Get actual class name to be printed on */
     static Logger log = Logger.getLogger(log4jExample.class.getName());
     
     public static void main(String[] args)throws IOException,SQLException{
        log.debug("Hello this is an debug message");
        log.info("Hello this is an info message");
     }
  }
  

  编译并运行上述程序。它将在 /usr/home/log4j 目录中创建一个 htmlLayout.html 文件，该文件将包含以下日志信息：

  日志会话开始时间 Mon Mar 22 13:30:24 AST 2010

  Time	Thread	Level	Category	File:Line	Message
  0	main	DEBUG	log4jExample	log4jExample.java:15	Hello this is an debug message
  6	main	INFO	log4jExample	log4jExample.java:16	Hello this is an info message

  您将使用 Web 浏览器打开 htmlLayout.html 文件。同样重要的是要注意 </html> 和 </body> 标签的页脚完全丢失。

  使用 HTML 格式的日志文件的一大优势是它可以作为网页发布以供远程查看。