Log4j使用详解

日志记录

作用：监视代码中变量的变化情况，周期性的记录到文件中供其他应用进行统计分析工作；跟踪代码运行时轨迹，作为日后审计的依据；向文件或控制台打印代码的调试信息。

Log4j简述

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

通过 Log4j 其他语言接口，可以在 C 、 C+ + 、 .Net 、 PL/SQL 程序中使用 Log4j ，其语法和用法与在 Java 程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，可以很方便地将 Log4j 集成到 J2EE 、 JINI 甚至是 SNMP 应用中。

常见参数配置

输出级别的种类

ERROR、WARN、INFO、DEBUG

ERROR 为严重错误 主要是程序的错误

WARN 为一般警告，比如session丢失

INFO 为一般要显示的信息，比如登录登出

DEBUG 为程序的调试信息

优先级别

可以设置级别：debug>info>error 

debug ：显示 debug、 info 、 error 

info ：显示 info、 error 

error ：只 error

配置日志信息输出目的地

log4j.appender.appenderName= fully.qualified.name.of.appender.class

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

配置日志信息的格式

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

控制台选项

Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台
FileAppender 选项
Threshold=DEBUF:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
RollingFileAppender 选项
Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

格式中符号

 -X号: X信息输出时左对齐；
 %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
 %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2012年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"输出日志信息换行

Log4j基本流程

Log4j 由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有 ERROR、 WARN 、 INFO、 DEBUG ，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

定义配置文件

Log4j 支持两种配置文件格式，一种是 XML 格式的文件，一种是 Java 特性文件：键 = 值 properties 文件。

1．  配置根目录

log4j.rootLogger= [ level ] , appenderName, appenderName, …

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

2.  输出目的地

          log4j.appender.appenderName =fully.qualified.name.of.appender.class. 

3．布局格式

log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class

使用案例

#根配置：log4j.rootLogger

log4j.rootLogger=INFO,ROLLING_FILE,stdout

 

#DEBUG, CONSOLE,ROLLING_FILE

log4j.addivity.org.apache=true

 

#CONSOLE

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

#灵活指定布局的模式

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%d%p [%c] - %m%n

 

#ROLLING_FILE

log4j.appender.ROLLING_FILE=org.apache.log4j.DailyRollingFileAppender

#指定日志消息的输出最低层次。

log4j.appender.ROLLING_FILE.Threshold=all

#指定消息输出的文件

log4j.appender.ROLLING_FILE.File=${catalina.home}/logs/log.txt

#指定日志编码

log4j.appender.ROLLING_FILE.Encoding=utf-8

#指定日志名称格式

log4j.appender.ROLLING_FILE.DatePattern='-'yyyyMMdd'.txt'

#默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

log4j.appender.ROLLING_FILE.Append=true

#自动灵活布局

log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout

#日志打印格式

log4j.appender.ROLLING_FILE.layout.ConversionPattern=[%-5p]%d{yyyy-MM-dd HH\:mm\:ss,SSS}- %c %n%m%n

问题补充

java 中的应用

Logger.debug(Object message);// 调试信息

Logger.info(Object message);// 一般信息

Logger.warn(Object message);// 警告信息

Logger.error(Object message);// 错误信息

Logger.fatal(Object message);// 致命错误信息

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: 每分钟