log4j 一

什么是Log4J?
Log4J是Apache的一个开放源代码项目(http://logging.apache.org/log4j/docs/)，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。log4j已经被移植到C, C++, C#, Perl, Python, Ruby, Eiffel 几种语言。

---

LOG4J组成
LOG4J主要由三大组件组成：
    1、记录器(Logger):决定什么日志信息应该被输出、什么日志信息应该被忽略；
    2、存放器(Appender): 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备；
    3、布局管理器(Layout): 指定日志信息的输出格式
组件之间的关系：
    一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应一种Layout

---

LOG4J组件
Logger组件是LOG4J的核心组件，它代表了Log4J的日志记录器，它能够对日志信息进行分类筛选。它由o
rg.apache.log4j.Logger类实现

Logger组件提供的方法

package org.apache.log4j;
 public class Logger {
  // Creation & retrieval methods:
  public static Logger getRootLogger();
  public static Logger getLogger(String name);

  // printing methods:
  public void debug(Object message);
  public void info(Object message);
  public void warn(Object message);
  public void error(Object message);
  public void fatal(Object message);

  // generic printing method:
  public void log(Priority p, Object message);
 }

在配置文件中配置Logger组件
    可在Log4J配置文件中配置自己的Logger组件，示例：
                log4j.logger.myLogger=WARN
    以上代码定义了一个Logger组件，名称为myLogger，日志级别为WARN。

---

日志级别
     记录器还有一个重要的属性，就是级别。（就象一个家庭中，成员间存在辈份关系，但不同的成员的身高可能不一样，且身高与辈份无关）程序员可以给不同的记录器赋以不同的级别，如果某个成员没有被明确值，就自动继承最近的一个有级别长辈的级别值。根记录器总有级别值。

日志级别种类一共有五种，级别由高到低依次是：fatal、error、warn、info、debug。获得Logger实例后，我们可调用以下方法之一输出日志信息：

public void debug(Object message);    //输出debug级别的日志信息；
public void info(Object message);    //输出info级别的日志信息；
public void warn(Object message);    //输出warn级别的日志信息；
public void error(Object message);    //输出error级别的日志信息；
public void fatal(Object message);    //输出fatal级别的日志信息；
public void log(Priority p, Object message);  //输出参数Priority指定级别的日志信息；

    注意：以上方法只有当它的级别大于或等于Logger组件配置的日志级别时才调用。以前面我们配置的myLogger为例，它的日志级别为WARN, 那么在程序中，它的warn()、error()、fatal()方法会被执行。对于log()方法，只有当它的参数Priority指定的日志级别大于或等于WARN时，它才会被执行。

为什么需要对日志进行分级？
    在写程序的时候，为了调试程序，我们会在很多出错的地方输出大量的日志信息。当程序调试完，不需要这些信息时，将程序中这些输出日志信息代码删除吗？这样费时费力，对于大型程序几乎不可行。通过对日志分级，假如不想输出WARN级别的日志信息，则Logger组件的级别调高即可，省时省心。

---

Log4J组件的超类
Log4J提供了一个root Logger，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用，通过Logger.getRootLogger()方法取得它。配置root Logger代码：
        log4j.rootLogger=INFO,console

LOG4J组件的继承性
可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如：
    log4j.apache.myLogger=WARN
    log4j.apache.myLogger.mySonLogger=,file

    以上代码中, mySonLogger是myLogger的子类Logger组件。
    Logger组件的继承关系：
    1、如果子类Logger组件没有定义日志级别，则将继承父类的日志级别;
    2、如果子类Logger组件定义了日志级别，就不会继承父类的日志级别;
    3、黙认情况下，子类Logger组件会继承父类所有的Appender，把它们           加入到自己的Appener;
    4、如果把子类Logger组件的additivity标志设为false，那么它就不会继    承父类Appender。additivity标志默认值为true；

Logger继承关系示例图
    root Logger: 日志级别=INFO appender清单=console
                                ↑
    myLogger: 日志级别=WARN appender清单=null
                                ↑
     mySonLogger: 日志级别=null appender清单=file

    这三个Logger组件实际日志级别和Appender如下表：
           Logger组件          日志级别          Appender清单
           root Logger            INFO                 console
           myLogger               WARN              console(继承)
           mySonLogger         WARN(继承)    file，console(继承)

---

Appender组件

＊Appender组件决定将日志信息输出到什么地方。支持以下目的地：
    1、控制台(Console);
    2、文件(File);
    3、GUI组件(GUI component);
    4、套接口服务器(Remote socket server);
    5、NT的事件记录器(NT Event Logger);
    6、UNIX Syslog守护进程
        (Remote UNIX Syslog daemon);

＊一个Logger同时对应多个Appender：
示例：myLogger配置二个Appender: 一个file, 一个        是console：

log4j.logger.myAppender=WARN,file,console
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=log.txt
log4j.apender.console=org.apache.log4j.ConsoleAppender

 

---

Layout组件
＊Layout组件决定日志输出格式，有以下几种类型：
    1、org.apache.log4j.HTMLLayout
        (以HTML表格形式布局);
    2、org.apache.log4j.PatternLayout
        (可以灵活地指定布局模式);
    3、org.apache.log4j.SimpleLayout
        (包含日志信息的级别和信息字符串);
    4、 org.apache.log4j.TTCCLayout
        (包含日志产生的时间、线程和类别等信息);

＊为Appender配置Layout示例：
1、为名称为console的Appender配置SimpleLayout，代码如下：
    log4j.appender.console.layout=org.apache.log4j.SimpleLayout
    输出日志格式如下：
    WARN - This is a log message from the myLogger

2、为名称为file的Appender配置PatternLayout，代码如下：
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    log4j.appender.file.layout.ConversionPattern=%t %p - %m%n
    输出日志格式如下：
    THREAD-1 WARN - This is a log message from the myLogger

---

预定义符号
PatternLayout让开发者依照ConversionPattern定义输出格式。ConversionPattern中一些指定日志
    内容和格式的预定义符号说明如下：

    符号             描述
    %d           当前时间
    %r           自程序开始后消耗的毫秒数
    %t            表示日志记录请求生成的线程
    %p           表示日志语句的优先级
    %r            与日志请求相关的类别名称
    %c           日志信息所在的类名
    %m%n    表示日志信息的内容

---

LOG4J基本用法
＊Log4j的基本用法分为两步：
    第一步：定义配置文件
    第二步：程序中使用Log4j

＊定义配置文件：
定义配置文件分为三步：

    1、配置Logger组件
    2、配置Appender组件
    3、配置Layout组件

    注意：Log4J支持二种配置文件格式：XML和Java属性文件(采用“键=值”形式)。在这里我们以Java属性文件格式配置文件为例：

---

配置Logger组件
配置root Logger语法为：log4j.rootLogger=[priority],appenderName,appenderName,...

配置自定义Logger组件语法为：log4j.logger.loggerName=[priority],appenderName,appenderName,...

其中：priority为日志级别，可选值包括FATAL、ERROR、WARN、INFO、DEBUG、ALL；appenderName指定Appender组件，可指定多个;

---

配置Appender组件
配置日志信息输出目的地Appender, 语法为：

log4j.appender.appenderName=fully.ualified.name.of.appender.class
log4j.appender.appenderName.option1=value1
...
log4j.appender.appenderName.optionN=valueN

 

---

Log4J提供的Appender有以下几种：
        a. org.apache.log4j.ConsoleAppender(控制台);
        b. org.apache.log4j.FileAppender(文件);
        c. org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件);
        d. org.apache.log4j.RollingFileAppender
            (文件大小到指定尺寸产生一个新的文件);
        e. org.apache.log4j.WriteAppender
            (将日志信息以流格式发送到任意指定地方);

---

配置Layout组件
配置Layout组件语法为：

log4j.appender.appenderName.layout=fully.ualified.name.of.appender.class
log4j.appender.appenderName.layout.option1=value1
...
log4j.appender.appenderName.layout.optionN=valueN

 

---

配置文件示例(log4j.properties)

## LOGGERS ##
#configure root logger
log4j.rootLogger=INFO,console
#define a logger named myLogger
log4j.logger.myLogger=WARN
#define a second logger that is a child to myLogger
log4j.logger.myLogger.mySonLogger=,file
## APPENDERS ##
#define an appender named console, which is set to be a ConsoleAppender
log4j.appender.console=org.apache.log4j.ConsoleAppender
# define an appender named file, which is set to be a RollingFileAppender
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=log.txt
## LAYOUTS ##
# assian a SimpleLayout to console appender
log4j.appender.console.layout=org.apache.log4j.SimpleLayout
# assian a PatternLayout to file appender
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%t%p-%m%n

程序中使用LOG4J
1、获得日志记录器：
获得rootLogger：

Logger rootLogger=Logger.getRootLogger();

获得自定义Logger：

Logger myLogger = Logger.getLogger("log4j.logger.myLogger");

2、读取日志记录器，配置Log4J环境;
     a. BasicConfigurator.configure(): 自动快速地使用默认Log4J环境;
     b. PropertyConfigurator.configure(String configFilename): 读取使用    Java属性格式的配置文件并配置Log4J环境；
     c. DOMConfigurator.configure(String filename): 读取XML形式的配置文    件并配置LOG4J环境;
3、输出日志信息;
     在程序代码中需要生成日志的地方，调用Logger的各种输出日志方法输出不同级别的日志，例如：

myLogger.debug("Thie is a log message from the " + myLogger.getName());