Log4j编程的基本用法

Log4j的简介

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

log4j一搬由三大组件

Log4j有三个主要的组件：Loggers(记录器)，Appenders(输出源)和Layouts(布局)，这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松的记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

log4j基本编程方法

Java编程使用Log4j可以参照以下示例：
1. 建立Logger实例：
　语法表示：public static Logger getLogger( String name)
　实际使用：
　static Logger logger =Logger.getLogger(ServerWithLog4j.class.getName ()) ;
2. 读取配置文件：
　获得了Logger的实例之后，接下来将配置Log4j使用环境：
　语法表示：
　 BasicConfigurator.configure()：自动快速地使用缺省Log4j环境。
　 PropertyConfigurator.configure(String configFilename)：读取使用Java的特性文件编写的配置文件。
　 DOMConfigurator.configure(String filename)：读取XML形式的配置文件。
　 实际使用：
　 PropertyConfigurator.configure(“log4j.properties”);
　 若log4j.properties放在工程的根目录，可以不写上面的程序语句，程序会自动找到配置文件。
　3. 插入日志信息
　　完成了以上连个步骤以后，下面就可以按日志的不同级别插入到你要记录日志的任何地方了。
　　语法表示：
　　Logger.debug(Object message);//调试信息
　　Logger.info(Object message);//一般信息
　　Logger.warn(Object message);//警告信息
　　Logger.error(Object message);//错误信息
　　Logger.fatal(Object message);//致命错误信息
　　实际使用：logger.info(“ServerSocket before accept: ” + server);

log4j配置文件

在实际编程时，要使Log4j真正在系统中运行事先还要对配置文件进行定义。定义步骤就是对Logger、Appender及Layout的分别使用。
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties(key=value)[Java特性文件（键=值）]。下面我们介绍使用Java特性文件做为配置文件的方法 ,具体如下：
　　1、配置根Logger，其语法为：
　　 log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
　 appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
例如：log4j.rootLogger＝info,A1,B2,C3
　　 2、配置日志信息输出目的地，其语法为：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
“fully.qualified.name.of.appender.class” 可以指定下面五个目的地中的一个：
1）.org.apache.log4j.ConsoleAppender（控制台）
2）.org.apache.log4j.FileAppender（文件）
3）.org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
4）.org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
5）.org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
ConsoleAppender选项：
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台
FileAppender 选项：
Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
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: 每分钟
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:指定可以产生的滚动文件的最大数。
实际应用：**
　　log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender
3、配置日志信息的格式，其语法为：
　　1). log4j.appender.appenderName.layout = ully.qualified.name.of.layout.class
　　 “fully.qualified.name.of.layout.class” 可以指定下面4个格式中的一个：
　　 1）.org.apache.log4j.HTMLLayout（以HTML表格形式布局）
　　 2）.org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
　　 3）.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
　　 4）.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
　　 HTMLLayout 选项：
　　 LocationInfo=true:默认值是false,输出java文件名称和行号
　　 Title=my app file: 默认值是 Log4J Log Messages.
　　 PatternLayout 选项:
　　 ConversionPattern=%m%n :指定怎样格式化指定的消息。
　　 XMLLayout 选项:
　　 LocationInfo=true:默认值是false,输出java文件和行号
　实际应用：
　 1). log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　 2). log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ss} %c %m%n
这里需要说明的就是日志信息格式中几个符号所代表的含义：
－X号: X信息输出时左对齐；
%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(嵌套诊断环境),尤其用到像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组件说明的一个简化；下面给出一个具体配置例子，在程序中可以参照执行：
　　log4j.rootLogger=INFO,A1，B2
　　log4j.appender.A1=org.apache.log4j.ConsoleAppender
　　log4j.appender.A1.layout=org.apache.log4j.PatternLayout
　　log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ss,SSS} %c %m%n
　　根据上面的日志格式，某一个程序的输出结果如下：
　　0　　INFO　2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: ‘Java server with log4j, Fri Jun 13 13:23:46 CST 2003’
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Command ‘HELLO’ not understood.’
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Vocabulary: HELP QUIT’
　　16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT