Log4j配置

1.Log4j是什么，引用一下百科上的解释

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

 

2. Log4j的使用，需要下面几个东西

1)log4j的jar包，这个是由Apache提供的，将它加载到项目的build path下即可。

2)log4j的配置文件，Log4j有两种配置文件，一个是log4j.property，另一个是log4j.xml，其原理是相同的，都是通过被加载，对log4j日志的一些属性进行配置，这个是比较关键的文件。

3)在代码中调用方法写日志。写的日志会根据配置文件的配置情况，将日志写到指定的位置。

 

3.重点说说log4j配置文件。

在log4j中有两种角色，一种是Logger就是写日志的程序，一种是Appender就是接受日志的文件。

我们要配置的有以下几点：(以XML文件为例)

 下面的是一个标准配置文件

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"><log4j:configuration>    <!-- ===================================================================== -->    <!--  以下是appender的定义                                                 -->    <!-- ===================================================================== -->    <appender name="" class="">        <param name="" value=""/>        <layout class="">            <param name="" value=""/>        </layout>    </appender>    <!-- ===================================================================== -->    <!--  以下是logger的定义                                                   -->    <!-- ===================================================================== -->    <logger name="" additivity="">        <level value="">        <param name="" value=""/>        </level>        <appender-ref ref=""/>    </logger>    <!-- ===================================================================== -->    <!--  Root logger的定义                                                    -->    <!-- ===================================================================== -->    <root>    <param name="" value=""/>        <level value="">        <param name="" value=""/>        </level>        <appender-ref ref=""/>    </root></log4j:configuration>

3.1 Appender

3.1.1 appender的class及其param

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.1.2Appender中layout的class及layout的param

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

layout中名为ConversionPattern的param设置日志输出格式。

参数：

%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921

%r: 输出自应用启动到输出该log信息耗费的毫秒数

%c: 输出日志信息所属的类目，通常就是所在类的全名

%t: 输出产生该日志事件的线程名

%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像javaservlets这样的多客户多线程的应用中。

%%: 输出一个”%”字符

%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字符，就从左边交远销出的字符截掉。

3.2 Logger

通常会配置一个root logger和若干个其他logger。

3.2.1logger及其对应的appender-ref

(1)logger的name有两种情况，一种是包名，就是该包下面的以class为名称的Logger对象都会设置在这个logger内。另一种是名称id，该名称的Logger对象就会设置在这个logger内。appender-ref对应的就是之前配置的appender,打出的日志就会由这个appender接收。

(2)additivity是子Logger是否继承父Logger的输出源（appender） 的标志位。具体说，默认情况下子Logger会继承父Logger的appender，也就是说子Logger会在父Logger的appender里输 出。若是additivity设为false，则子Logger只会在自己的appender里输出，而不会在父Logger的appender里输出。

3.2.2 logger的level

Level.ALL打开所有日志
Level.DEBUG 用于调试
Level.INFO 用于运行过程
Level.WARN 用于潜在的错误
Level.ERROR 用于错误事件
Level.FATAL 用于严重错误时间
Level.OFF 关闭所有日志

在root或者logger中设置level以后，日志中会打印出严重等级更高的日志(包括其自身等级在内)。

 

4.代码中写Log

有两种方式Logger.getLogger()和LogFactory.getLog()。

(1) Logger.getLogger()，参数有两种，一种是String，另一种是Class。根据源代码来看，传入Class的话会将通过Class.getName()获取String，再调用参数为String的方法。Logger对象通过名字对配置文件中的logger进行注册，从而可以将日志写出到logger对应的appender中。

(2) LogFactory.getLog()和Logger.getLogger()方法类似，区别如下：

Logger来自log4j自己的包。如果用Logger.getLogger，需要一个log4j的jar包，用此方式你只能依靠log4j：

LogFactory来自common-logging包。如果用LogFactory.getLog， 你可以用任何实现了通用日志接口的日志记录器替换log4j，而程序不受影响。apache的common-logging包是通用日志接口，通过这个中 间层，你可以随便指定到底用哪个日志系统。增加系统的灵活性。若log4j它不存在, commons-logging 会另行选择其它的日志实现类。 这样保证了程序中不一定要使用log4j这个日志文件了。