log4j

原文地址：log4j 作者：СомёО

1.为什么要用log4j
无论是是桌面应用程序，普通网站，还是web服务程序都需要记录日志文件，记录日志的作用主要有三：
a.监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作.
b.跟踪代码运行时轨迹，作为日后审计的依据.
c.担当集成开发环境中的调试器的作用，向文件或控制台打印代码的调试信息
最简单的方法是在程序中添加向console里打印信息的代码System.out.println(.....).但如果希望留下点persistance的信息，那么这种方法显然是行不通的，因为command不会记录上次运行是输出的信息。于是想到将输出的console里的信息输出到某个文件里永久保存起来，而在写JPad的时候我还真的是这么做的，新建一个Logger类，添加log（String logInfo）方法。然后建立日志文件输出PrintWriter writer=new PrintWriter(new FileWriter("fileName.log",true),true)，再调用writer.println(logInfo)把日志写到文件里。这是个不错的注意，对于像JPad那样非常轻量级的软件完全足够用了。
当时如果是更大型的project，希望动态的配置日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。那么自己写的那个原始的Logger就显得不够用了，这个时候就需要借助Apache为我们提供的一个强有力的日志操作包-Log4j。

2.关于log4j
Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。
Apache官方的下载地址是：http://logging.apache.org/log4j/1.2/download.html,版本是1.2.15
下载解压后在examples文件夹下可以找到一些例子程序，通过运行这些例子可以了解log4j基本的使用方法。
当然首先要把log4j包装入classpath。打开command,set CLASSPATH=%CLASSPATH%；[apache-log4j-1.2.15 path]log4j-1.2.15.jar，然后就可以依次编译运行examples里面的例子了。
在site文件夹下有log4j的html说明文档，其中apidocs文件夹下是log4j的api的document. 

3.log4j使用详解
Log4j有 FATAL、ERROR、WARN、INFO、DEBUG、ALL六个级别,在Logger中的code如下

package org.apache.log4j; public class Logger {
// Creation & retrieval methods:
public static Logger getRootLogger();
public static Logger getLogger(String name);
// printing methods:
public void trace(Object message);
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(Level l, Object message);}  

Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG
(1)要使用Log4j的Logger首先要编写配置文件，虽然在例子里有DefaultLF5Configurator.configure()好像不用使用配置文件，但是在DefaultLF5Configurator的code里其实还是读取配置文件 String resource ="/org/apache/log4j/lf5/config/defaultconfig.properties"。

A.配置根Logger，其语法为：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日志记录的优先级，如上所述。当然也可以定义自己的级别，具体方法在examples的customLevel文件夹下由一个很好的例子。通过在这里定义的级别，就可以控制到应用程序中相应级别的日志信息的开关。指定输出只显示比该级别以上的信息，所有比该级别低的信息都不会被显示。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。该项可以是缺省的，表示接受所有级别的日志信息。 appenderName就是指定日志信息输出到哪个地方。也可以同时指定多个输出目的地。

B.配置日志信息输出目的地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（将日志信息以流格式发送到任意指定的地方）


C.配置日志信息的格式（布局），其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）



D.当layout为PatternLayout时，ConversionPattern的格式有下面选项：
%r: 自程序开始后消耗的毫秒数
%t: 表示日志记录请求生成的线程
%p: 表示日志语句的优先级
%r: 与日志请求相关的类别名称
%c: 信息所在的类名
%m%n: 表示消息的内容 



配置文件示例：log4j.properties



＃配置文件log4j.properties
log4j.rootLogger=INFO, A1, A2
#setting for appender A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
#setting for appender A2
log4j.appender. A2=org.apache.log4j.RollingFileAppender
log4j.appender. A2.File=example.log
log4j.appender. A2.MaxFileSize=100KB
log4j.appender. A2.MaxBackupIndex=1
log4j.appender. A2.layout=org.apache.log4j.PatternLayout
log4j.appender. A2.layout.ConversionPattern=%p %t %c - %m%n 



(2)代码中的使用 Logger记录日志文件

A. import中加入以下几行：
import org.apache.log4j.PropertyConfigurator ;
import org.apache.log4j.Logger ;
import org.apache.log4j.Level ;


B. 定义Logger变量
static Logger logger = Logger.getLogger(ThisClassName.class.getName ()) ;


C. 读配置文件 

BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。 PropertyConfigurator.configure ("log4j.properties") ：读取使用Java的特性文件编写的配置文件。 

DOMConfigurator.configure ("log4j.xml") ：读取XML形式的配置文件

在这里要注意读取文件的路径.


D. 显示日志信息
按显示级别显示日志信息
logger.debug(String log_info);
用于显示调试信息
logger.info (String log_info);
用于显示系统提示信息
logger.warn(String log_info);
用于显示警告或特殊提示
logger.error(String log_info);
用于显示错误信息，一般在异常中使用。例如：
catch(IOException e) {
logger.error("IOException!");
System.exit(0);
}