Log4j 详解

1.1 背景

在应用程序中添加日志记录总的来说基于三个目的：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息。

最普通的做法就是在代码中嵌入许多的打印语句，这些打印语句可以输出到控制台或文件中，比较好的做法就是构造一个日志操作类来封装此类操作，而不是让一系列的打印语句充斥了代码的主体。

1.2 Log4j简介

在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。

    通常，我们都提供一个名为 log4j.properties的文件，在第一次调用到Log4J时，Log4J会在类路径（../web-inf/class/当然也可以放到其它任何目录，只要该目录被包含到类路径中即可）中定位这个文件，并读入这个文件完成的配置。这个配置文件告诉Log4J以什么样的格式、把什么样的信息、输出到什么地方。

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

1、 Loggers

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

假设你定义的级别是info，那么error和warn的日志可以显示而比他低的debug信息就不显示了。

 　

Java程序举例来说：

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

    Logger　logger = Logger.getLogger("com.foo"); //"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.");

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

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

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

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

2、Appenders

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

    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.optionN = 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.optionN = valueN

    实际应用：

log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender

3、配置日志信息的格式，其语法为：

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

      "fully.qualified.name.of.layout.class" 可以指定下面4个格式中的一个：

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

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

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

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

            1.HTMLLayout 选项

              LocationInfo=true:默认值是false,输出java文件名称和行号

              Title=my app file: 默认值是 Log4J Log Messages.

            2.PatternLayout 选项

              ConversionPattern=%m%n :指定怎样格式化指定的消息。

            3.XMLLayout  选项

              LocationInfo=true:默认值是false,输出java文件和行号

   实际应用：

   　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout

       B. log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

           这里需要说明的就是日志信息格式中几个符号所代表的含义：

         －X号: X信息输出时左对齐；

                   %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

                   %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

                   %r: 输出自应用启动到输出该log信息耗费的毫秒数

                   %c: 输出日志信息所属的类目，通常就是所在类的全名

                   %t: 输出产生该日志事件的线程名

                   %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

                   %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

                   %%: 输出一个"%"字符

                   %F: 输出日志消息产生时所在的文件名称

                   %L: 输出代码中的行号

                   %m: 输出代码中指定的消息,产生的日志具体信息

                   %n: 输出一个回车换行符，Windows平台为"\r\n"，Unix平台为"\n"输出日志信息换行

            可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

                     1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。

                     2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。

                     3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

                     4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边多出的字符截掉。

　　

    这里上面三个步骤是对前面Log4j组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：

log4j.rootLogger=INFO,A1，B2

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

    根据上面的日志格式，某一个程序的输出结果如下：

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