1.      介绍

1.1.      Log4j 是什么?

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，能够更加细致地控制日志的生成过程，而这些可以通过一个配置文件来灵活地进行配置，不需要修改应用的代码。

1.2.      构成Log4j的三大类组件

(1) Logger : 负责输出信息日志信息，并能够对日志信息过滤，确定哪些日志信息输出，哪些信息被忽略。

(2) Appender : 指定日志输出到什么地方，可以是控制台、文件或网络设备等等。

(3) Layouts : 加在Appender后面用以实现格式化输出日志的内容。

2. Log4j的设置

第一步：加入log4j的jar包到lib下。

第二步：在CLASSPATH下建立log4j.properties或XML格式的配置文件。

第三步：导入所有需的commongs-logging类：
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

第四步：在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员：
private final Log log = LogFactory.getLog(getClass());
LogFactory.getLog()方法的参数使用的是当前类的class。

第五步：使用org.apache.commons.logging.Log类的成员方法输出日志信息：

例如：if (log.isDebugEnabled())
{log.debug("Test log4j!");}

3. Log4j的配置文件

3.1 Log4j输出日志信息的优先级

Log4j输出日志信息的级别分别为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，只有等于及高于这个级别的才进行处理，则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志，OFF：关闭所有的日志输出。

3.2 Log4j配置文件的详细介绍

Log4j支持两种配置文件格，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:

①、              配置根Logger
Logger 负责处理日志记录的大部分操作。
其语法为：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中，level 是日志记录的优先级。

②、              配置日志信息输出目的地 Appender
Appender 负责控制日志记录操作的输出。
其语法为：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
这里的appenderName为在①里定义的，可任意起名。
其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定义一个名为stdout的输出目的地，ConsoleAppender为控制台。
③、配置日志信息的格式（布局）Layout
Layout 负责格式化Appender的输出。
其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
其中，Log4j提供的layout有以下几种：
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{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
4.Logger组件的继承性

Log4j中定义的Logger可以有继承关系，Log4j提供了一个root Logger,它是所有Logger的”根”,其它的Logger都会继承root Logger.Logger 之间的继承关系是通过名称体现的，例如：log4j.logger.helloappLogger.childLogger的名称是在log4j.logger.helloappLogger之后加符号“.”定义的，则childLogger继承helloappLogger.

Logger组件的继承关系有以下特点：

●     如果子Logger没有定义日志级别，则继承父Logger的日志级别。

●     如果子Logger定义了日志级别，则不会继承父Logger的日志级别。

●      默认情况，子Logger会继承Logger的所有Appender，反它们加入到自己的Appender中。

附录 A Log4j配置相对路径实现日志记录

解决Log4j配置相对路径实现日志记录有三种办法：

①、              用相对路径代替绝对路径

其实log4j的FileAppender本身就有这样的机制，如：log4j.appender.logfile.File=${WORKDIR}/logs/app.log其中“${WORKDIR}/”是个变量，会被System Property中的“WORKDIR”的值代替。这样，我们就可以在log4j加载配置文件之前，先用System.setProperty设置好根路径

②、             可以使用环境变量

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=${catalina.base}/logs/logs_tomcat.log
log4j.appender.R.MaxFileSize=10KB

③、             采用了动态改变日志路径方法来实现相对路径保存日志文件

代码：

public class Log4jInit extends HttpServlet {   

     static Logger logger = Logger.getLogger(Log4jInit.class);     

     public Log4jInit() {        }   

     public void init(ServletConfig config) throws ServletException     {   

String prefix = config.getServletContext().getRealPath("/");       String file = config.getInitParameter("log4j");   

 String filePath = prefix + file;  

 Properties props = new Properties();   

         try {   

          FileInputStream istream = new FileInputStream(filePath);   

              props.load(istream);   

              istream.close();   

              String logFile = prefix + props.getProperty("log4j.appender.file.File");//设置路径   

             props.setProperty("log4j.appender.file.File",logFile);                

         PropertyConfigurator.configure(props);//装入log4j配置信息   

        } catch (IOException e) {   

  toPrint("Could not read configuration file [" + filePath + "].");   toPrint("Ignoring configuration file [" + filePath + "].");                return;            }   

    }   

    public static void toPrint(String content) {   

    System.out.println(content);   

    }   

   }   

(2).Web.xml中的配置

代码

1. <servlet>       
2.   <servlet-name>log4j-init</servlet-name>       
3.   <servlet-class>Log4jInit</servlet-class>  
4.   <init-param>  
5.     <param-name>log4j</param-name>  
6.     <param-value>WEB-INF/classes/log4j.properties</param-value>        
7.   </init-param>       
8.     <load-on-startup>1</load-on-startup>