log4j.properties配置文件

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活，不建议直接在代码里对日志环境进行设置 。

Log4j支持两种配置文件格式，一种是XML(log4j.xml)格式的文件，一种是properties(log4j.properties )格式的文件。

下面我们介绍使用properties格式做为配置文件的方法：

示例：

<span style="white-space: pre;"></span>log4j.rootLogger=INFO, A1 <span style="white-space: pre;"></span>log4j.appender.A1=org.apache.log4j.ConsoleAppender <span style="white-space: pre;"></span>log4j.appender.A1.layout=org.apache.log4j.PatternLayout <span style="white-space: pre;"></span>log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

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

<span style="white-space: pre;"></span>log4j.rootLogger = [ level ] , appenderName, appenderName, … 

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

appenderName就是指定日志信息输出到哪个地方 。您可以同时指定多个输出目的地 。

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

<span style="white-space:pre"></span>log4j.appender.appenderName = fully.qualified.name.of.appender.class<span style="white-space:pre"></span>log4j.appender.appenderName.option1 = value1<span style="white-space:pre"></span>…<span style="white-space:pre"></span>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 （将日志信息以流格式发送到任意指定的地方）
(1).ConsoleAppender选项
Threshold =WARN:指定日志消息的输出最低层次。
ImmediateFlush =true:默认值是true,意谓着所有的消息都会被立即输出。
Target =System.err：默认情况下是：System.out,指定输出控制台
(2).FileAppender 选项
Threshold =WARN:指定日志消息的输出最低层次。
ImmediateFlush =true:默认值是true,意谓着所有的消息都会被立即输出。
File =mylog.txt:指定消息输出到mylog.txt文件。
Append =false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
(3).DailyRollingFileAppender 选项
Threshold =WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File =mylog.txt:指定消息输出到mylog.txt文件。
Append =false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
DatePattern =’.'yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：
  1)’.'yyyy-MM: 每月
  2)’.'yyyy-ww: 每周
  3)’.'yyyy-MM-dd: 每天
  4)’.'yyyy-MM-dd-a: 每天两次
  5)’.'yyyy-MM-dd-HH: 每小时
  6)’.'yyyy-MM-dd-HH-mm: 每分钟
(4).RollingFileAppender 选项
Threshold =WARN:指定日志消息的输出最低层次。
ImmediateFlush =true:默认值是true,意谓着所有的消息都会被立即输出。
File =mylog.txt:指定消息输出到mylog.txt文件。
Append =false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize =100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex =2:指定可以产生的滚动文件的最大数。

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

<span style="white-space:pre"></span>log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class<span style="white-space:pre"></span>log4j.appender.appenderName.layout.option1 = value1<span style="white-space:pre"></span>…<span style="white-space:pre"></span>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 （包含日志产生的时间、线程、类别等等信息）

4、输出格式设置
在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。
参数：
%p : 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d : 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2009-11-19 23:12:23,130
%r : 输出自应用启动到输出该log信息耗费的毫秒数
%c : 输出日志信息所属的类目，通常就是所在类的全名，也即日志记录器的名
%t : 输出产生该日志事件的线程名
%l : 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：TestLog.log(TestLog.java:9)
%x : 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%% : 输出一个”%”字符
%F : 输出日志消息产生时所在的文件名称
%L : 输出代码中的行号
%m : 输出代码中指定的消息,产生的日志具体信息
%n : 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
1)%20c ：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，前面补空格。
2)%-20c :指定输出category的名称，最小的宽度是20，如果category的名称小于20的话， 后面补齐空格。
3)%.30c :指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
4)%20.30c :如果category的名称小于20就在前面补空格，并且右对齐，如果其名称长于30字符，就从左边较远销出的字符截掉。

三、在程序中的使用
在程序中使用Log4j之前，首先要将commons-logging.jar和logging-log4j-1.2.9.jar导入到classpath中，并将log4j.properties放于src根目录中。接下来就可以使用了。

1.得到记录器
使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

<span style="font-size:18px;"><span style="white-space:pre"></span>public static Logger getLogger( String name)；</span>

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

<span style="font-size:18px;"><span style="white-space:pre"></span>private static Logger logger = Logger.getLogger ( TestLog.class.getName());</span>

注：推荐使用commons-logging结合log4j进行日志记录，这样便于以后更换成其他日志工具，降低系统的藕合性，使其可以不依赖于log4j：

<span style="font-size:18px;"><span style="white-space:pre"></span>private static Log logger = LogFactory.getLog(TestLog.class); <span style="color:#ff0000;"></span></span>

另外，一个类我们只需一个日志记录器，因此我们需把日志记录器定义成该类的一个私有的且为静态的属性，如上面的：private static Log logger = LogFactory.getLog(TestLog.class)，其实如果我们不这样定义，即使每次使用时我们就创建一个日志记录器，得到的还是以前使用过的，因为log4j帮我们做了这样的处理：相同名的日志记录器在内存中只有一个。

2.插入记录信息（格式化日志信息）
当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：
Logger.debug (Object message ) ;
Logger.debug (Object message ,Throwable e) ;
Logger.info (Object message ) ;
Logger. info (Object message ,Throwable e) ;
Logger.warn ( Object message ) ;
Logger.warn (Object message ,Throwable e) ;
Logger.error ( Object message ) ;
Logger.error (Object message ,Throwable e) ; 

这里要注意的是，这里接口中传递的为Object类型，所以当我们想记录日常日志时，不能调用一个参数的接口，如果这样只能记录异常的简单信息，而不能输出详细的堆栈信息，这里我们要使用两个参数的接口，如：logl.error(null,new Exception("错误"));，第一个参数为null都可以。总觉得这样调用法有点不方便，自己也试着写了一个日志代码类，在记录异常时，可以只传一个参数就能输出详细堆栈信息，请参见《日志代理类LogProxy 》，但这个代理日志类有个问题就是在记录日志时，如果我们的设置了输出格式中带 %l 时，就不好使了，因为此时记录的日志输出位置为代理类的位置了，按理因该为调用代理类方法所在的位置信息。下面是对%l 的测试：

JAVA代码：

<span style="font-size:18px;">public class TestLog {</span>

<span style="font-size:18px;"><span style="white-space:pre"></span></span><pre name="code" class="java"><span style="white-space:pre"></span>private static LogProxy log =  LogProxy.getInstance(TestLog.class);

//private static Log log = LogFactory.getLog(TestLog.class);public void log() {log.debug("Debug info.");log.info("Info info");log.warn("Warn info");log.error("Error info");log.fatal("Fatal info");}public static void main(String[] args) {System.out.println("log obj = " + log);TestLog test = new TestLog();test.log();}}

输出：

log obj = LogProxy @119cca4 (通过LogProxy对象创建)
LogProxy.info(LogProxy.java:122)2009-11-19 23:19:07,557  INFO [main] - Info info
  LogProxy.warn(LogProxy.java:138) 2009-11-19 23:19:07,560  WARN [main] - Warn info
  LogProxy.error(LogProxy.java:90) 2009-11-19 23:19:07,560 ERROR [main] - Error info
  LogProxy.fatal(LogProxy.java:106) 2009-11-19 23:19:07,562 FATAL [main] - Fatal info 

可以看出输出的%l信息不准确，不是我们想要的，如果不使用代理输出如下：

log obj = org.apache.commons.logging.impl.Log4JLogger @337838(通过LogFactory对象创建)
TestLog.log(TestLog.java:11) 2009-11-19 23:22:02,470  INFO [main] - Info info
  TestLog.log(TestLog.java:12)2009-11-19 23:22:02,470  WARN [main] - Warn info
  TestLog.log(TestLog.java:13)2009-11-19 23:22:02,470 ERROR [main] - Error info
  TestLog.log(TestLog.java:14)2009-11-19 23:22:02,470 FATAL [main] - Fatal info