log4j使用简介

前段时间开始用log4j作为应用程序logging的开发，发现确实太方便了，故向各位推荐之。log4j完全文档有189页呢，只能简单再简单得介绍一下。

使用log4j的理由：
1，System.out.println(message) 太长，每次输入太麻烦，用log4j可以log.debug(message)，相对比较短

2，信息输出来源不确定，由于有太多的System.out.println()来自不同的class和方法，有时候都不知道这些"OKOK"是哪里来的，只好用"aaaaa", "bbbbb"来区分，用了log4j，每个消息会自动附上发生的时间和来源，便于区分，比如，在你的class里面用log.info("here i am") 便产生如下log
[2006-02-15 14:34:42,828] INFO  testpkg.pkg1.TestLog run() - here i am

3，自动添加/删除调试信息：开发的时候需要调试信息，安装到运行环境中又要删除部分调试信息（这可是体力活），一旦出错进行后期维护又需要调试信息了，可是这些调试信息已经从源代码中删掉了，又要再加，再删除，如此往复。有了log4j，所有信息分为不同级别，DEBUG<INFO< WARN<ERROR<FATAL 开发/调试时候需要DEBUG以上的信息，正式运行环境中需要INFO以上的信息，通过更改配置文件即可随时调整，无须再删除/添加了。

4，多日志目标，有条信息，即想要输出到屏幕，又想要写文件，还要发送邮件（比如严重的系统错误），在程序中，仍然是一句log.error(msg)搞定，至于log发送到什么地方，全由配置文件来决定，开发者不要关心文件如何写，邮件如何发的问题，留给log4j去解决把。

5，超强的免维护rolling file的log功能，如果开发个服务器应用，有什么问题往log里面写，万一几个月忘了清理log文件，弄不好log把硬盘撑满了。log4j提供超强的rolling file，可以指定log文件为 xxx.log ，大小500k，循环5个，如果超过了这个大小，则自动变成xxx.log.1 xxx.log.2 ... xxx.log.5 最老的log文件就自动删除，永远也不要担心log文件把硬盘撑爆了。

（以上理由同样适用与java se 1.4以上自带的logging）
6，用户众多，性能超群，数量众多的应用服务器比如jboss, springframework等等都使用了log4j，再次证明了它的价值。

7，apache logging还提供了log4net， log4cxx等，大部分功能都与log4j兼容如果你使用多种语言开发，可以因此受益。省去每种语言都学习一套类库
使用方法：
在你的代码中，class里面加入
private static final Logger logger = org.apache.log4j.Logger.getLogger(本类名字.class);

然后就可以在其他地方用
String msg = debugmessage
logger.debug(msg);

msg = errormessage
logger.error(msg);

在你的classpath里面放置一个配置文件，由配置文件来决定log的去向。
log4j支持propertie形式的log4j.properties或者xml形式的log4j.xml，xml格式的文件功能比property形式更强，配置粒度更细，因此推荐用xml格式，如果两个文件都存在，xml格式的优先。
给个例子如下：

CODE:

[Copy to clipboard]

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration>
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
              value="[%d{ISO8601}] %-5p %c %m %n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="DEBUG"/>
            <param name="LevelMax" value="INFO"/>
        </filter>
    </appender>
    <appender name="STDERR"  class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.err" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
              value="[%d{ISO8601}] %-5p %c %m %n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="WARN"/>
            <param name="LevelMax" value="FATAL"/>
        </filter>
    </appender>
        <appender name="SYSLOG"  class="org.apache.log4j.net.SyslogAppender">
        <param name="syslogHost" value="localhost" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
              value="appname %-5p %c %m %n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="INFO"/>
            <param name="LevelMax" value="FATAL"/>
        </filter>
    </appender>

    <!--                          -->
    <!-- Declare the SMTPAppender -->
    <!--                          -->
    <appender name="EMAIL"  class="org.apache.log4j.net.SMTPAppender">
                <param name="Threshold" value="INFO"/>
        <param name="BufferSize" value="128" />
        <param name="SMTPHost" value="localhost" />
        <param name="From" value="log4j@server5" />
        <param name="To" value="[e-mail], [e-mail]" />
        <param name="Subject" value="[SMTPAppender] Application message4" />
        <layout class="org.apache.log4j.PatternLayout">
            <!--<param name="ConversionPattern"
              value="[%d{ISO8601}]%n%n%-5p%n%n%c%n%n%m%n%n" />-->
                        <param name="ConversionPattern" value="[%d{ISO8601}] %-5p %c %m%n"/>
        </layout>

    </appender>

    <appender name="CSF_FILE" class="org.apache.log4j.RollingFileAppender">
                <param name="Threshold" value="INFO"/>
                <param name="File" value="csf.log"/>
                <param name="Append" value="true"/>
                <param name="MaxFileSize" value="500KB"/>
                <param name="MaxBackupIndex" value="5"/>
                <layout class="org.apache.log4j.PatternLayout">
                        <param name="ConversionPattern" value="%d %-5p [%c] %m%n"/>
                </layout>
        </appender>

    <!--                           -->
    <!-- setup log4j's root logger -->
    <!--                           -->
    <root>
        <level value="all" />
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="STDERR"/>
        <appender-ref ref="SYSLOG" />
        <appender-ref ref="EMAIL" />
        <appender-ref ref="CSF_FILE" />
    </root>
</log4j:configuration>

特别补充，给每个不同的log目标提供不同的格式，比如送到文件的消息，可以加上日期时间，但是送到syslog的消息，由于syslog自己已经有日期时间了，就无须再送一次，可以去除，调整PatternLayout就可以了。

注意事项：

不要贪图方便，就到处log.debug(msg)，要加上判断
if (logger.isDebugEnabled()) {
        logger.debug( msg);
}
原因是基于性能的考虑，如果你调整配置文件里面<level value="all" />为<level value="INFO" />，尽管logger.debug(msg)不会被显示，但是仍然占用资源。

如果每次都这样，那么就和第一个理由冲突了，因为这样会多写代码，不过，如果你用eclipse，有个免费的插件叫做log4e，可以自动帮你生成if (logger.isDebugEnabled()) {}这些代码，自动生成
private static final Logger logger = org.apache.log4j.Logger.getLogger(本类名字.class);的定义，而且可以自动帮你把文件里的 System.out.println()都替换成logger.debug()，减少你自己手写的部分，还是很方便的。

剩下的，就靠各位自己去实践了。