Common-logging 与 Log4j的结合使用

分类： Java

一、结合说明

在我们的日常开发中，经常需要通过输出一些信息进行程序的调试，如果到处都用system.out.println()则在项目发布之后要逐一删除，而log4j提供了一种新的调试输出机制以解决输出的问题。log4j的原理是使用一个配置文件log4j.properties进行管理，在调试的时候可以把输出级别调低，项目正式发布之后把级别调高，这样以前的一些输出就可以屏蔽了，不用到程序当中再进行逐一删除。关于log4j的介绍网上很多，随便google一下就可以顺利的使用log4j了。在这里介绍一下log4j和commons-logging的联合使用，因为在很多框架当中都是结合了common-logging和log4j的应用。像spring之类的框架里面存在很多debug输出，用commons-logging可以很容易的打印输出，以用于了解spring的运行机制！

使用介绍:
       1.下载jar包：
           log4j-1.2.9.jar和commons-logging.jar
       2.在web目录的classes下面添加两个文件：commons-logging.properties和log4j.properties     
          log4j.properties(例子):
             ##LOGGERS##
             #define a logger
             log4j.rootLogger=INFO,console,file
             #log4j.rootLogger=DEBUG,console,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.RollingFileAppender
             log4j.appender.file.File=log-wst.txt
             ##LAYOUTS##
             #assign a SimpleLayout to console appender
             log4j.appender.console.layout=org.apache.log4j.SimpleLayout
             #assign a PatternLayout to file appender
             log4j.appender.file.layout=org.apache.log4j.PatternLayout
             log4j.appender.file.layout.ConversionPattern=%p - %m%n     
         
             commons-logging.properties(例子)
              ##
              org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger
       3.应用实例：
         package com.wes.test;
         import org.apache.commons.logging.Log;
         import org.apache.commons.logging.LogFactory;
        public abstract class BaseClass{
              /** 用于日志输出 */
              protected Log log = LogFactory.getLog(this.getClass());
         }
        
         这样在子类中可以直接调用log输出即可:
        public class DerivedClass extends BaseClass {
              pulbic void test() {
                  //如果log4j.properties文件配置的级别<=info则可以正常输出(info/debug)
                 log.info("这是info级别的输出");  
                  //如果log4j.properties文件的级别为debug则可以正常输出(debug)
                 log.debug("这是debug级别的输出");
              }
        }

二、Apache通用日志接口(commons-logging.jar)介绍

Apache Commons包中的一个，包含了日志功能，必须使用的jar包。这个包本身包含了一个Simple Logger，但是功能很弱。在运行的时候它会先在CLASSPATH找log4j，如果有，就使用log4j，如果没有，就找JDK1.4带的java.util.logging，如果也找不到就用Simple Logger。commons-logging.jar的出现是一个历史的的遗留的遗憾，当初Apache极力游说Sun把log4j加入JDK1.4，然而JDK1.4项目小组已经接近发布JDK1.4产品的时间了，因此拒绝了Apache的要求，使用自己的java.util.logging，这个包的功能比log4j差的很远，性能也一般。后来Apache就开发出来了commons-logging.jar用来兼容两个logger。因此用commons-logging.jar写的log程序，底层的Logger是可以切换的，你可以选择log4j，java.util.logging或者它自带的Simple Logger。不过我仍然强烈建议使用log4j，因为log4j性能很高，log输出信息时间几乎等于System.out，而处理一条log平均只需要5us。你可以在Hibernate的src目录下找到Hibernate已经为你准备好了的log4j的配置文件，你只需要到Apache 网站去下载log4j就可以了。commons-logging.jar也是必须的jar包。
Apache通用日志包提供一组通用的日志接口,用户可以自由选择实现日志接口的第三方软件
通用日志目前支持以下日志实现
Log4j日志器
JDK1.4Logging
SimpleLog日志器
NoOpLog日志器

#比较常用的有SimpleLog（commons logging自带的一个简单实现）、Jdk14Logger（JDK 1.4所带的logger）、Log4JLogger（就是我们这次用Log4J了）。另外在有些贴子里有人使用Log4JCategoryLog或Log4jFactory，这两个都是已经被deprecated了的，不要用。

1、Log 接口
Common-logging的应用程序编程接口主要在org.apache.commons.logging.log接口中定义，这个接口主要定义了两类操作： 一类是级别判断，用于减少不必要的日志操作的参数计算从而提高性能。另一类是日志登记，按照级别登记日志信息。
通用日志包把日志消息分为6种级别Fatal,Error,Warn,Info,Debug和Trace

org.apache.commons.logging.Log接口代表日志器,它提供了一组输出日志的方法，日志登记操作分又为两小类：一个参数的日志信息登记操作和两个参数的日志信息登记操作。前者对三类用户都适用，后者用于打印日志登记处的出错堆栈信息，所以更适用于开发人员调式与维护使用
       fatal(Object message);
       error(Object message);
       warn (Object message);
       info (Object message);
       debug(Object message);
       trace(Object message);

debug(Object message, Throwable t);
       trace(Object message, Throwable t);
       ......
      这里需要注意的是,只有当输出日志的级别大于等于日志器配置的日志级别时,这个方法才会真正被执行.例如日志器设置日志级别为Warn,那么程序中,它的
      fatal(),error(),warn()方法会被执行,而info(),debug(),trace()
      不会被执行.

Log接口还提供了一组判断是否允许输出特定级别日志消息的方法

isFatalEnable();
       isErrorEnable();
       isWarnEnable();
       isInfoEnable();
       isDebugEnable();
       isTraceEnable();
  
2、LogFactory接口
       org.apache.commons.logging.LogFactory接口提供了获得日志器实例的两个静态方法
       public static Log getLog(String name)throws LogConfigurationException
       public static Log getLog(Class class)throws LogConfigurationException
  
       public static Log getLog(Class class)
       {
          getLog(class.getName());
       }

三、Log4J 日志器(log4j.jar)介绍
Log4J 是Apache的一个开放源代码的项目.
Log4J由三大组件构成：
Logger: 负责生成日志,并能根据配置的日志器级别来决定什么日志消息应该被输出.
Appender: 定义日志消息输出的目的地,指定日志消息应该被输出到什么地方, 这些地方可以是控制台,文件和网络设备等.
Layout:指定日志消息的输出格式

1、配置通用日志接口

在web应用中使用通用日志包,首先必须进行以下配置

准备有关的jar文件
在commons-logging.properties 属性文件中指定日志器(即日志实线类)，为特定的日志器设置日志级别,输出格式和输出地点等.

准备有关jar文件
这里主要是准备 commons-logging.jar和 log4j.jar 放到lib目录下

指定日志器

通用日志接口从名为 commons-logging.properties的属性文件中获取实现日志
接口的日志器信息,这个文件放在web-inf/class目录下
在该文件的org.apache.commons.logging.Log属性指定日志实现类
例如用Log4J日志器,那么设置
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

2、设置日志器属性

多数日志器允许以配置的方式,指定日志器的输出格式,地点,或者级别.
配置Log4J
Log4J,由三个重要的组件构成,Logger,Appender和Layout.
Log4J支持两种配置文件格式:一种是XML格式文件,一种是java属性文件.

配置Log4J组件
Logger组件支持继承关系,所有的Logger组件都直接或者间接继承rootLogger,
配置rootLogger的语法为
log4j.rootLogger=[priority],appenderName,appenderName,..

其中priority是日志级别,可选值OFF,FATAL,ERROR,WARN,INFO,DEBUG,TRACE和ALL
appenderName指定Appender组件,用户可以同时指定多个Appender组件,例如
以下代码指定rootLogger的日志级别为INFO,它有两个Appender,名为console和flie
log4j.rootLogger=INFO,console,file

配置Appender组件
配置日志消息输出目的地Appender,有以下几种
org.apache.log4j.ConsoleAppender(控制台)
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小达到指定尺寸的时候产生一个新文件)
org.apache.log4j.WriterAppender(将日志信息以流个格式发送到任意指定的地方)

例如以下代码定义了一个名了file的Appender,它把日志信息输出到log.txt文件
      log4j.appender.file=org.apache.log4j.RollingFileAppender
      log4j.appender.file.File=log.txt

配置Layout组件

Log4j提供下面几种Layout
org.apache.log4j.HTMLLayout(以html表格形式布局)
org.apache.log4j.PatterLayout(可以灵活的指定布局模式)
org.apache.log4j.SimpleLayout(包含日志消息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间线程和类别)

Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息

　　%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
　　%r 输出自应用启动到输出该log信息耗费的毫秒数
　　%c 输出所属的类目，通常就是所在类的全名
　　%t 输出产生该日志事件的线程名
　　%n 输出一个回车换行符，Windows平台为“\r\n”，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)

如果为名"file"的Appender配置PatterLayout布局,则可以采用如下代码
       log4j.appender.file.layout=org.apache.log4j.PatterLayout
       log4j.appender.file.layout.ConversionPattern=%t%p-%m%n
  
       采用以上PatternLayout布局,从日志文件中看到的输出日志的形式如下
         http8080-Processor24 INFO -This is an info message
       %t对应"http8080-Processor24" %p对应INFO,%m%n对应后面具体的日志消息
  
一个简单的应用

新建log4j.properties
      
       log4j.rootLogger=INFO,a
       log4j.appender.a=org.apache.log4j.RollingFileAppender
       log4j.appender.a.File=log.txt
       log4j.appender.a.layout=org.apache.log4j.SimpleLayout
  
       新建一个Log4JTest.class,如下：
        import org.apache.commons.logging.Log;
        import org.apache.commons.logging.LogFactory;

public class Log4JTest {

/**
         * @param args
         */
        private static Log log=LogFactory.getLog(Log4JTest.class);
        public static void main(String[] args) {
            // TODO Auto-generated method stub
          log.info("aaa");
   
        }
}