Java Lof4J日志

从两段代码开始

第一段代码
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.log4j.BasicConfigurator;

public class HelloLog4J {
    private static Log logger = LogFactory.getLog(HelloLog4J.class);

    /**
     * @param args
     */
    public static void main(String[] args) {
        BasicConfigurator.configure(); //可以不用，common-loggging会自动寻找log4j属性文件，找不到则使用java.util.logging日志
        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.");
    }

}

第二段代码
import org.apache.log4j.Logger;

/**
 * Created by XieLe on 2015/7/25.
 */
public class Log4JMain {

    private Logger logger = Logger.getLogger(Log4JMain.class);
    main 方法同上
}

何时用Log4J，何时用Commons-Logging?

Apache的Common Logging只是一个高层的日志框架，本身并没有实现真正的写日志能力，而是依赖其它的日志系统如Log4j或者java本身的java.util.logging。可以通过配置文件来设定最终使用log4j还是java.util.logging.没有配置log4j的时候，就会调用java.util.logging包。

Log4J 使用
1. 获取log4j
http://logging.apache.org/log4j/2.x/index.html
可单独下载Jar包，也可以用Maven引入（较方便）。

pom.xml 依赖
<dependencies>
  <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.3</version>
  </dependency>
  <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.3</version>
  </dependency>
</dependencies>
或者，其内部已包含api和core
 <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>2.3</version>
 </dependency>

还是从代码开始
log4j.properties，一份简单的属性配置文件，直接放在src路径下即可（IntelliJ IDEA工程文件放在src/main/resources下）

#可以设置级别：debug>info>error  
#debug：显示debug、info、error  
#info：显示info、error  
#error：只error  
log4j.rootLogger=debug,appender1  
#log4j.rootLogger=info,appender1  
#log4j.rootLogger=error,appender1  

#输出到控制台  
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
#样式为TTCCLayout  
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout

Java 代码我上述第一段代码，运行后，直接输出

This is println message.
[main] DEBUG com.xiele.notes.log4j.HelloLog4J - This is debug message.
0 [main] DEBUG com.xiele.notes.log4j.HelloLog4J  - This is debug message.
[main] INFO com.xiele.notes.log4j.HelloLog4J - This is info message.
1 [main] INFO com.xiele.notes.log4j.HelloLog4J  - This is info message.
[main] ERROR com.xiele.notes.log4j.HelloLog4J - This is error message.
1 [main] ERROR com.xiele.notes.log4j.HelloLog4J  - This is error message.

通过配置文件可知，我们需要配置3个方面的内容：
1、根目录（级别和目的地）；
2、目的地（控制台、文件等等）；
3、输出样式。

Log4J类图 (1.2.17）

核心类说明
Logger - 日志写出器，供程序员输出日志信息
Appender - 日志目的地，把格式化好的日志信息输出到指定的地方去
ConsoleAppender - 目的地为控制台的Appender
FileAppender - 目的地为文件的Appender
RollingFileAppender - 目的地为大小受限的文件的Appender
Layout - 日志格式化器，用来把程序员的logging request格式化成字符串
PatternLayout - 用指定的pattern格式化logging request的Layout

Log4J2基本使用（注1）
Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显 示内容。
一、定义配置文件
配置文件使程序很灵活，log4j提供两种格式，一种是xml格式，一种是Properties属性文件，如下分别介绍。

1.配置根Logger，其语法为：

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

2.配置日志信息输出目的地Appender，其语法为

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
　…
log4j.appender.appenderName.option = valueN

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

　　3.配置日志信息的格式（布局），其语法为：

　　log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
　　log4j.appender.appenderName.layout.option1 = value1
　　…
　　log4j.appender.appenderName.layout.option = valueN

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

　　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 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
　　
二、在代码中使用Log4j

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：
　　public static Logger getLogger( String name)
　　通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

　　static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

　　2.读取配置文件

　　当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：

　　BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
　　PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
　　DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

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

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

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

【示例2】 输出为文本文件或HTML文件
Properties代码

#设置级别：  
log4j.rootLogger=debug,appender1  

#输出到文件(这里默认为追加方式)  
log4j.appender.appender1=org.apache.log4j.FileAppender  
#设置文件输出路径  
#【1】文本文件  
#log4j.appender.appender1.File=c:/Log4JDemo02.log  
#【2】HTML文件  
log4j.appender.appender1.File=c:/Log4JDemo02.html  
#设置文件输出样式  
#log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout  

【示例3】输出为文本文件或HTML文件

#设置级别和多个目的地  
log4j.rootLogger=debug,appender1,appender2  

#输出到控制台  
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
#设置输出样式  
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  

#输出到文件(这里默认为追加方式)  
log4j.appender.appender2=org.apache.log4j.FileAppender  
#设置文件输出路径  
#【1】文本文件  
#log4j.appender.appender2.File=c:/Log4JDemo02.log  
#【2】HTML文件  
log4j.appender.appender2.File=c:/Log4JDemo02.html  
#设置文件输出样式  
#log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout  
log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout

【示例3】 多目的地、自定义样式

#设置级别和目的地  
log4j.rootLogger=debug,appender1,appender2  

#输出到控制台  
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
#设置输出样式  
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
#自定义样式  
# %r 时间 0  
# %t 方法名 main  
# %p 优先级 DEBUG/INFO/ERROR  
# %c 所属类的全名(包括包名)  
# %l 发生的位置，在某个类的某行  
# %m 输出代码中指定的讯息，如log(message)中的message  
# %n 输出一个换行符号  
log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  

#输出到文件(这里默认为追加方式)  
log4j.appender.appender2=org.apache.log4j.FileAppender  
#设置文件输出路径  
#【1】文本文件  
log4j.appender.appender2.File=c:/Log4JDemo06.log  
#设置文件输出样式  
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n 

注1：上段内容摘要自http://www.iteye.com/topic/378077，该大牛写的太好了，忍不住抄过来，谢谢他。

企业级xml配置
在企业中，对日志非常关注，常常会记录很多，但是通常都是根据业务或者模块来实现独立记录，因此常常会定义一个枚举日志记录器，然后对日志的记录做增强加工，例如打印业务信息，线程详细信息等。
同时，采用xml方式的可读性更好，定义不同的Appender,和Category。
Appender处理日志输出，而Category通过暴露Name给Logger，然后定义可多个Logger。

【xml示例】 定义多个Appender

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="CONSO" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d %p - %C[%L] - %m \n"/>
        </layout>
    </appender>

    <!--默认日志-->
    <appender name="DEFAULT" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="encoding" value="UTF-8" />
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <!-- 通过Maven的Profile定制不同环境中的路径 -->
        <param name="file" value="${dev.logs.path}/def.log" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d [%7r] %6p - %30.30c - %m \n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
         <!-- 通过Maven的Profile定制不同环境中的输出级别 -->
            <param name="LevelMin" value="${dev.logs.level}" />
            <!--<param name="LevelMax" value="FATAL "/> -->
        </filter>
    </appender>
    <category name="DEFAULTLog" additivity="false">
        <priority value="${deploy.instance.logs.level}" />
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEFAULT" />
    </category>

    <!--模块1-->
    <appender name="MODULE1" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="encoding" value="UTF-8" />
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <param name="file" value="${dev.logs.path}/module1.log" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d [%7r] %6p - %30.30c - %m \n" />
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="LevelMin" value="${dev.logs.level}" />
            <!--<param name="LevelMax" value="FATAL "/> -->
        </filter>
    </appender>
    <category name="MODULE1Log" additivity="false">
        <priority value="${dev.logs.level}" />
        <appender-ref ref="CONSOLE" /> <!--该Logger可以使用的Appender-->
        <appender-ref ref="MODULE1" /> <!--此处可使用控制台，可以使用MODULE1输出-->
    </category>
    <!--Root Logger-->
    <root>
        <priority value="${dev.logs.level}" />
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEFAULT" />
    </root>

</log4j:configuration>

Java代码

public enum LogMoudule {

    DEFAULT("DEFAULTLog", "默认模块"), MODULE1("MODULE1Log", "模块1");

    private String key;
    private String value;

    private static final Log logger = LogFactory.getLog(LogMoudule.class);

    LogMoudule() {
    }

    LogMoudule(String key, String value) {
        this.key = key;
        this.value = value;
    }

    public static String getValue(String key) {
        for (LogMoudule m : LogMoudule.values()) {
            if (m.getKey().equals(key)) {
                return m.getValue();
            }
        }
        return null;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    public Log getLog() {
        return null; //自己定制
    }

    //为了提高效率，我们可以在写日志前增加判断：
    public void debug(String str, Object... args) {
        // 记录debug级别的信息
        if (logger.isDebugEnabled()) {
            logger.debug("This is debug message.");
        }

    }

    public void info(String str, Object... args) {
        // 记录info级别的信息
        if (logger.isInfoEnabled()) {
            logger.info("This is info message.");
        }
    }

    //其他方法省略

}

补充资料
Log4j 2 介绍：http://www.importnew.com/3046.html
Java日志终极指南： http://www.importnew.com/16331.html
Java日志性能那些事（Infoq上的好文）：http://www.infoq.com/cn/articles/things-of-java-log-performance