Log4j 1.2 学习笔记

引用 Apache log4j 1.2 中对 log 其作用的说明与引入log后出现的问题 :

Inserting log statements into your code is a low-tech method for debugging it. It may also be the only way because debuggers are not always available or applicable. This is often the case for distributed applications.
将调试日志语句插入到你的代码中是一种低级的调试代码的方法。但这种方法可能是唯一的方法，因为调试器并不总是奏效的或可适用的。这在分布式应用程式中经常发生。

On the other hand, some people argue that log statements pollute source code and decrease legibility. (We believe that the contrary is true). In the Java language where a preprocessor is not available, log statements increase the size of the code and reduce its speed, even when logging is turned off. Given that a reasonably sized application may contain thousands of log statements, speed is of particular importance.
另一方面，一些人认为日志语句污染源代码减少易读性。(我们相信,其对反命题也为真。)在Java语言中,预处理程序不可用,日志语句增加代码的大小,降低它的速度,即使日志是关闭的时候也是如此。考虑到一个合理的大小的应用程序可能包含成千上万的日志语句,速度是特别重要的。

好，看来日志是很重要的！那么我得把近期学习的知识记录一下，以免忘记。

---

获取Log4j

通过Maven获取Log4j

<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>

通过Apache官方获取Log4j

log4j官方网站

---

使用Log4j

首先将Log4j的jar文件放置到lib中。
如果是用Eclipse 建立的Maven项目，在下载依赖后会自动将jar文件放置到正确的位置。

Log4j需要通过相应的配置，以达到记录日志的目的。

Log4j的配置方式

• XML配置方式
• .properties配置方式

将下面的“log4j.xml”或“log4j.properties”放置到根目录下。
如果是maven项目，将其放置到src/main/resources目录下。

如果“log4j.xml” 与“log4j.properties”两个文件同时存在，只读取XML文件的内容，忽略.properties文件的内容。

XML配置方式较.properties配置方式功能多，具体多出的功能在下载的“log4j-1.2.17\site\apidocs\index.html”中的“org.apache.log4j.xml.DOMConfigurator”类中查看，“org.apache.log4j.PropertyConfigurator”类中也有部分说明。

XML配置方式

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <!-- Appenders 输出源(白话:将日志输出到哪) -->
    <appender name="console1" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out"/>
        <!-- Layout 布局(每条日志的展现形式) -->
        <layout class="org.apache.log4j.SimpleLayout"></layout>
    </appender>

    <!-- root logger 根日志记录器 -->
    <root>
        <!-- 优先级别 -->
        <priority value="info" />
        <appender-ref ref="console1" />
    </root>
</log4j:configuration>

.properties配置方式

# root logger (set Level : warn, set Appender_Name : console1)
log4j.rootLogger=warn,console1
# Appender (set class ConsoleAppender)
log4j.appender.console1=org.apache.log4j.ConsoleAppender
# Layout
log4j.appender.console1.layout=org.apache.log4j.SimpleLayout

入门级例子

HelloWorld.java

import org.apache.log4j.Logger;

public class HelloWorld {

    private static Logger logger = Logger.getLogger(HelloWorld.class);

    public static void main(String[] args) {

        logger.debug("This is debug message.");/* 级别为debug */

        logger.info("This is info message.");/* 级别为info */

        logger.warn("This is warn message.");/* 级别为warn  */

        logger.error("This is error message.");/* 级别为error */

    }
}

运行HelloWorld.java
输出结果为：

INFO - This is info message.
WARN - This is warn message.
ERROR - This is error message.

官方建议使用的优先级别为 debug < info < warn < error 。

由于指定了优先级别为“info”，所以控制台不会输出被标记为“debug”的信息。

---

配置文件的语法

通过以上两种配置文件可以看到几个相同的英文单词：

• logger(日志记录器)
• appender(输出源)
• layout(布局)

Log4j的三个主要组件

没错，就是他们几个。

以下例子均以.properties配置方式举例。

logger(日志记录器)

记录器是命名实体，也就是说，可以给记录器起名字。记录器名称是区分大小写的,他们遵循分层的命名规则:

日志名称层次规则

如果一个后跟着一个点的名字是另一个名字的前缀，那么这个名字就是祖先，后面的那个名字就是其后裔。

例如,名为“com.foo”的日志记录器是一个名为“com.foo.Bar”的父母的记录器。
同样,“java”是“java.util”和“java.util.Vector”的祖先。
大多数开发人员应该熟悉这种命名方案。

但 root 例外。
更具体的规则查看所下载文件夹中的../log4j-1.2.17/site/manual.html

配置root记录器，语法为：

log4j.rootLogger = [ level ],appenderName1,appenderName2,...

没有特殊要求的包均遵循root指定的输出源与方式。

配置自定义名称的记录器(logger)，语法为：

log4j.logger.xxx.xxx=[ level ],appenderName1,appenderName2,...

例如,你有个项目，里面有名为“com.foo”的包，
你对输出这个包中所包含的类中的日志有特殊要求，

log4j.logger.com.foo=info,appender1,appender2

这样com.foo包下所有的类中的日志都会遵循appender1和appender2所指定的布局方式进行输出。

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，你可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指日志信息输出到哪个地方。你可以同时指定多个输出目的地(输出源)。

appender(输出源)

配置输出源，语法为：

log4j.appender.appenderName1 = fully.qualified.name.of.appender.class
log4j.appender.appenderName1.option1 = value1
…
log4j.appender.appenderName1.optionN = valueN

ps: option1~N包括 **layout** (布局)，到layout的时候就知道了。

其中，Log4j提供的appender(输出源)有以下几种：

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

例如：
log4j.appender.appenderName1=org.apache.log4j.ConsoleAppender

layout(布局)

配置布局，语法：

 log4j.appender.appenderName1.layout = fully.qualified.name.of.layout.class
 log4j.appender.appenderName1.layout.option1 = value1
 …
 log4j.appender.appenderName1.layout.optionN = valueN

其中，Log4j提供的layout有以下几种：

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

其中的 org.apache.log4j.PatternLayout ，在Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

• %m 输出代码中指定的消息
• %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
• %r 输出自应用启动到输出该log信息耗费的毫秒数
• %c 输出所属的类目，通常就是所在类的全名
• %t 输出产生该日志事件的线程名
• %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
• %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
• %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

例如：

log4j.appender.pojo1.layout=org.apache.log4j.PatternLayout
log4j.appender.pojo1.layout.ConversionPattern=[%-5p] %d{YYYY-MM-dd HH:mm:ss,SSS} %r  %c.%t [%l] %m%n

---

可参考的XML配置方式的文件：

<?xml version="1.0" encoding="UTF-8"?>
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <!-- Appenders -->
    <appender class="org.apache.log4j.ConsoleAppender" name="stdout">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%d{YYY-MM-dd HH:mm:ss,SSS}] [%-5p]: %c - %m%n" />
        </layout>
    </appender>
    <appender class="org.apache.log4j.RollingFileAppender" name="appout">
        <param name="File" value="apps.html" />
        <param name="MaxFileSize" value="2048"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%d{YYY-MM-dd HH:mm:ss,SSS}] [%-5p]: %c - %m%n" />
        </layout>
    </appender>

    <!-- Application Loggers -->
<!--    <logger name="com.foo"> -->
<!--        <level value="info" /> -->
<!--        <appender-ref ref="appout"/> -->
<!--    </logger> -->

    <!-- Root Logger -->
    <root>
        <priority value="debug" />
        <appender-ref ref="stdout" />
    </root>
</log4j:configuration>

本文参考以下文章

1. log4j详解与实战
2. log4j xml配置详解