三种Java日志工具的简单使用

Java日志系统

1. Logger之简单入门

Java 中自带的日志系统，

Java中关于日志系统的API，在 java.util.logging 包中，在这个包中，Logger类很重要。

Logger类是用来记录 某个级别的日志消息：

级别共分为以下几类，从上倒下，级别依次下降：

　　　　SEVERE(严重)------级别最高

　　　　WARNING(警告)

　　　　INFO

　　　　CONFIG

　　　　FINE

　　　　FINER

　　　　FINEST------最低值

　　另外，还有一个级别 OFF，可以用来关闭日志；使用级别 ALL，启用所有消息的日志记录。（日志消息级别，可以查看 java.util.logging.Level类）

　　具体记录日志的方法，查看此类的API文档，在此就不详述了。

　　Logger记录的日志消息会被转发到已注册的Handler对象，handler对象可以将消息发送到：控制台，文件，网络等等。

• Handler类(抽象类)：主要用于转发日志消息

　　　　Hanlder类下有2个子类：MemoryHandler、StreamHandler。

　　　　StreamHandler下有3个子类：ConsoleHandler(将日志消息打印到控制台)、FileHandler(将日志消息输出到文件)、SocketHandler(将日志发送到网络中的某个主机)。具体详情，查看API文档。

• Formatter类(抽象类)：主要用于格式化日志记录消息。
• 有2个子类：SimpleFormatter(纯文本形式), XmlFormatter(XML形式)

　　　　

　　

下面一起来写一个测试程序吧：

import java.io.IOException;
import java.util.logging.FileHandler;
import java.util.logging.Logger;

/**
* @author SGY
* 将日志记录写入到文件中
*
*/
public class TestLoggingToFile {

public static void main(String[] args) throws SecurityException, IOException {
//日志记录器
Logger logger = Logger.getLogger("chapter07");
//日志处理器
FileHandler fileHandler = new FileHandler("d:\test.txt");

//需要记录的日志消息

LogRecord lr = new LogRecord(Level.INFO, "This is a text log.");

//为处理器设置日志格式：Formatter

SimpleFormatter sf = new SimpleFormatter();

fileHandler.setFormatter(sf);
//注册处理器
logger.addHandler(fileHandler);
//记录日志消息
logger.log(lr);

}

}

如果把 SimpleFormatter 改成 XmlFormatter，记录的消息是xml形式

 

2. log4j– 最受欢迎的Java日志组件

Log4j是一款基于Java的开源日志组件，Log4j功能非常强大，我们可以将日志信息输出到控制台、文件、用户界面，也可以输出到操作系统的事件记录器和一些系统常驻进程。更值得一提的是，Log4j可以允许你非常便捷地自定义日志格式和日志等级，可以帮助开发人员全方位地掌控日志信息。

官方网站：http://logging.apache.org/log4j/2.x/

Log4j支持两种配置文件格式，一种是XML（标准通用标记语言下的一个应用）格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:

Log4j基本使用方法

• 导入Log4j包
• 配置文件
• 设置日志内容

代码：

/**
 * Log4j.java
 */
package log4j;

import org.apache.log4j.Logger;

/**
 * @author SGY
 * 
 */
public class Log4j {
    private static Logger logger = Logger.getLogger(Log4j.class);
    /**
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub

         // System.out.println("This is println message."); 
         // 记录debug级别的信息 
         logger.debug("This is debug message."); 
         // 记录info级别的信息 
         logger.info("This is info message."); 
         // 记录error级别的信息 
         logger.error("This is error message."); 
    }

}

简单配置信息：

### 设置###
log4j.rootLogger = debug,stdout,D,E
### 输出信息到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
#定义名为R的输出端的类型为每天产生一个日志文件
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
### 输出ERROR 级别以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =E://logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

1.1  日志级别

每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：

A：off 最高等级，用于关闭所有日志记录。
B：fatal 指出每个严重的错误事件将会导致应用程序的退出。
C：error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
D：warm 表明会出现潜在的错误情形。
E：info 一般和在粗粒度级别上，强调应用程序的运行全程。
F：debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
G：all 最低等级，用于打开所有日志记录。

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

1.2  定义配置文件

log4j.rootCategory=INFO, stdout ,D, R

此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码，可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO、WARN、ERROR的log信息，而DEBUG信息不会被显示。

1. log4j.appender.stdout=org.apache.log4j.ConsoleAppender

此句为定义名为stdout的输出端是哪种类型，可以是

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

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

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

1. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

此句为定义名为stdout的输出端的layout是哪种类型，可以是

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

1.3  插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;  
Logger.info ( Object message ) ;  
Logger.warn ( Object message ) ;  
Logger.error ( Object message ) ;

3.     Commons Logging

Commons Logging的实现不依赖于具体的日志实现工具，仅仅提供一些日志操作的抽象接口，它对其他的日志工具做了封装，比如Log4J, Avalon LogKit, 和JDK 1.4等。

common-logging是apache提供的一个通用的日志接口。用户可以自由选择第三方的日志组件作为具体实现，像log4j，或者jdk自带的logging， common-logging会通过动态查找的机制，在程序运行时自动找出真正使用的日志库。当然，common-logging内部有一个Simple logger的简单实现，但是功能很弱。所以使用common-logging，通常都是配合着log4j来使用。使用它的好处就是，代码依赖是common-logging而非log4j， 避免了和具体的日志方案直接耦合，在有必要时，可以更改日志实现的第三方库。

使用common-logging的常见代码：

import org.apache.commons.logging.Log;  

import org.apache.commons.logging.LogFactory;  

  

public class A {  

    private static Log logger = LogFactory.getLog(this.getClass());  

}  

动态查找原理：Log 是一个接口声明。LogFactory 的内部会去装载具体的日志系统，并获得实现该Log 接口的实现类。LogFactory 内部装载日志系统的流程如下：

首先，寻找org.apache.commons.logging.LogFactory 属性配置。

否则，利用JDK1.3 开始提供的service 发现机制，会扫描classpah 下的META-INF/services/org.apache.commons.logging.LogFactory文件，若找到则装载里面的配置，使用里面的配置。

否则，从Classpath 里寻找commons-logging.properties ，找到则根据里面的配置加载。

否则，使用默认的配置：如果能找到Log4j 则默认使用log4j 实现，如果没有则使用JDK14Logger 实现，再没有则使用commons-logging 内部提供的SimpleLog 实现。

从上述加载流程来看，只要引入了log4j 并在classpath 配置了log4j.xml ，则commons-logging 就会使log4j 使用正常，而代码里不需要依赖任何log4j 的代码。

官方网站：http://commons.apache.org/proper/commons-logging/