Java日志系统简介

log历史简介

 

日志，源于log，有航海日志的意思。指记录海员记录每天的行程，生活及发生的事件。在软件开发领域，用来监控代码中变量变化，跟踪代码运行的轨迹，在开发环境中担当调试器作用，向控制台或文件输出信息。

 

几乎所有的软件开发语言（平台）都有自己的日志系统，java，.net，ruby，php等。在java领域，存在大量的日志组件，open-open收录了21个日志组件。

 

从功能上讲，这些可以分为三类：

一是日志工具类，它实现了日志的记录，格式化和级别的划分，代表为logback，simplelog。

二是日志系统，提供了完整的框架功能并实现了日志记录。代表为jul（jdk提供的日志框架），log4j（apache开源项目）。

三是抽象整合类，它提供了一组接口，完成日志功能，通过包装其他日志工具或系统来工作jcl（apache开源组件），slf4j。

 

从历史上讲，log4j出现最早，Ceki Gülcü是其创造者。自java1.4开始，jdk提供了java.util.logging类库，提供了一个完整的日志框架，在设计上要比log4j要更清晰。这个时候，除此之外，还有一些其他日志组件，java领域从来不缺少轮子，总是有人在发明轮子，轮子多了，就会产生混乱，就会有人站出来，要一统江湖，于是，jcl，apache一个开源的日志组件诞生了，它提供了一组日志系统的接口，通过对log4j，jul和simplelog进行包装，提供日志功能。这样，开发的时候，只需要使用jcl，通过配置，灵活选择底层实现。这样，对于开发人员来说，开发更简单了些。看起来一切太平了，可Ceki Gülcü认为，应该有一个更好的日志框架。log4j经过这么久的发展，已经成为了一个巨人，亦伤痕累累，从外面看，经典，庄重，强壮，从内部看，却有着一根根的飞线（ThinkPad），充满了代码的坏味道。或许他没有勇气来改造这个巨人，离开也许是最好的选择，于是，出来，创建了slf4j，来取代jcl，创建了logback，来取代log4j。

 

目前，log4j和jul应用最为广泛，slf4j作为新兴的抽象层，整合logback，以其简洁，快速，正被越来越多的顶级项目使用。

 

代表日志组件简要介绍。

Log4j，历史悠久，应用广泛，被移植到多种语言及平台，功能强大，在众多的日志框架中，仍占据着主导地位。

Jul，jdk提供的日志框架，设计精良，和jdk紧密结合，控制灵活，使用简单。

Jcl，提供了日志的抽象层，可以整合多种实现。但有classloader问题。

Slf4j，提供了jcl的超集，避免了classloader问题。

Logback，可靠，通用，快速，灵活的java日志工具（官方描述）。

 

项目选择思考。

如果是单一的项目，如桌面应用，采用jul，免配置，控制灵活。如果是web开发，宜采用log4j，因为系统已经有了很多的配置文件，不在乎多一个，而且log4j可以脱离任何组件，不像jul，和jvm紧密结合在一起。如果是多项目整合开发，宜采用slf4j，一是它可以整合其他遗留日志组件，二是其提供的抽象层，为将来的开发提供了灵活性。

 

 

log4j相关概念及使用简介

 

Log4j有三个主要的组件：Loggers，Appenders和Layouts，这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。下面对三个组件分别进行说明：

 

1、 Loggers

Loggers组件在此系统中被分为五个级别：DEBUG、INFO、WARN、ERROR和FATAL。这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL，明白这一点很重要，这里Log4j有一个规则：假设Loggers级别为P，如果在Loggers中发生了一个级别Q比P高，则可以启动，否则屏蔽掉。

 

Java程序举例来说：

//建立Logger的一个实例，命名为“com.foo”

Logger  logger = Logger.getLogger("com.foo");

 

//设置logger的级别。通常不在程序中设置logger的级别。一般在配置文件中设置。

logger.setLevel(Level.INFO);

Logger barlogger = Logger.getLogger("com.foo.Bar");

 

//下面这个请求可用，因为WARN >= INFO

logger.warn("Low fuel level.");

 

//下面这个请求不可用，因为DEBUG < INFO

logger.debug("Starting search for nearest gas station.");

 

//命名为“com.foo.bar”的实例barlogger会继承实例“com.foo”的级别。因此，下面这个请求可用，因为INFO >= INFO

barlogger.info("Located nearest gas station.");

 

//下面这个请求不可用，因为DEBUG < INFO

barlogger.debug("Exiting gas station search");

 

这里“是否可用”的意思是能否输出Logger信息。

在对Logger实例进行命名时，没有限制，可以取任意自己感兴趣的名字。一般情况下建议以类的所在位置来命名Logger实例，这是目前来讲比较有效的Logger命名方式。这样可以使得每个类建立自己的日志信息，便于管理。比如：

static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());

 

2、 Appenders

禁用与使用日志请求只是Log4j其中的一个小小的地方，Log4j日志系统允许把日志输出到不同的地方，如控制台（Console）、文件（Files）、根据天数或者文件大小产生新的文件、以流的形式发送到其它地方等等。

 

其语法表示为：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

 

 

配置时使用方式为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class

log4j.appender.appenderName.option1 = value1

…

log4j.appender.appenderName.option = valueN

 

这样就为日志的输出提供了相当大的便利。

 

3、 Layouts

有时用户希望根据自己的喜好格式化自己的日志输出。Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供了四种日志输出样式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式等等。

 

其语法表示为：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

 

 

配置时使用方式为：

log4j.appender.appenderName.layout =       fully.qualified.name.of.layout.class

log4j.appender.appenderName.layout.option1 = value1
     …
log4j.appender.appenderName.layout.option = value

 

以上是从原理方面说明Log4j的使用方法，在具体Java编程使用Log4j可以参照以下示例：

1、 建立Logger实例：
    语法表示：public static Logger getLogger( String name)
    实际使用：static Logger logger = Logger.getLogger   (ServerWithLog4j.class.getName ()) ;

2、 读取配置文件：
    获得了Logger的实例之后，接下来将配置Log4j使用环境：
    语法表示：
    BasicConfigurator.configure()：自动快速地使用缺省Log4j环境。
    PropertyConfigurator.configure(String configFilename)：读取使用Java的特性文件编写的配置文件。
    DOMConfigurator.configure(String filename)：读取XML形式的配置文件。
    实际使用：PropertyConfigurator.configure("ServerWithLog4j.properties");

3、 插入日志信息
    完成了以上连个步骤以后，下面就可以按日志的不同级别插入到你要记录日志的任何地方了。

    语法表示：
    Logger.debug(Object message);
    Logger.info(Object message);
    Logger.warn(Object message);
    Logger.error(Object message);

    实际使用：logger.info("ServerSocket before accept: " + server);
 
在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用，具体如下：

1、 配置根Logger，其语法为：
    log4j.rootLogger = [ level ] , appenderName, appenderName, …
这里level指Logger的优先级，appenderName是日志信息的输出地，可以同时指定多个输出地。如：log4j.rootLogger= INFO,A1,A2

2、 配置日志信息输出目的地，其语法为：
    log4j.appender.appenderName = fully.qualified.name.of.appender.class
    可以指定上面所述五个目的地中的一个。

3、 配置日志信息的格式，其语法为：
    log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
    这里上面三个步骤是对前面Log4j组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：
    log4j.rootLogger=INFO,A1
    log4j.appender.A1=org.apache.log4j.ConsoleAppender
    log4j.appender.A1.layout=org.apache.log4j.PatternLayout
    log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

    这里需要说明的就是日志信息格式中几个符号所代表的含义：
    －X号: X信息输出时左对齐；
    %p: 日志信息级别
    %d{}: 日志信息产生时间
    %c: 日志信息所在地（类名）
    %m: 产生的日志具体信息
    %n: 输出日志信息换行
 
根据上面的日志格式，某一个程序的输出结果如下：
0    INFO  2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'
16   DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT

 

 

参考资料：

1．IBM developerworks对log4j的介绍。 链接

2．Java开源日志组件列表。链接

3．Slf4j官方网站。链接

4．Logback官方网站。链接

5．Log4j官方网站。链接

6．Jcl官方网站。链接

7．Sun官方网站。链接

8．一个jcl的中文说明。链接