首页 > 代码库 > 聊聊log4j
聊聊log4j
log4j是apache的一个项目，旨在让我们在项目中可以灵活的把输出信息存放在各种设备或文件中，而不需要自己重新开发一套这样的工具。
首先要对配置文件的各个参数进行说明，这样才能合理的进行配置
参数意义说明:
1.配置根Logger:
Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。下面将介绍使用log4j.properties文件作为配置文件的方法:
①、配置根Logger :
Logger 负责处理日志记录的大部分操作。
其语法为：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，只有等于及高于这个级别的才进行处理，则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志，OFF：关 闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。例如：log4j.rootCategory=DEBUG, stdout,R 就是说我要显示所有优先权等於和高于Debug的信息，"stdout"，”R”表示我定义了两个输出端(其实就是Appender，随便什么名字都好)。
②、配置日志信息输出目的地 Appender：
其语法为：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.optionN = valueN
这里的appenderName为在①里定义的，可任意起名。
其中，Log4j提供的appender有以下几种：
org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），可通过 log4j.appender.R.MaxFileSize=100KB设置文件大小，还可通过 log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定义一个名为stdout的输出目的地，ConsoleAppender为控制台。
例如： log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
定义一个名为R的输出目的地，DailyRollingFileAppender为一个每天生成的文件
log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log 指定文件的路径和名字
③、配置日志信息的格式（布局）Layout
Layout 负责格式化Appender的输出。
其语法为：
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.optionN = valueN
其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
如： log4j.appender.stdout.layout=org.apache.log4j.PatternLayout（指定输出格式）
log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n（指定输出格式参数）
2、格式化日志信息
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
%m 输出代码中指定的消息
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%r 输出自应用启动到输出该log信息耗费的毫秒数
%c 输出所属的类目，通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。
二、下面说说xml的配置：
首先看看一些参数的意思：
<strong>控制台选项</strong>Threshold=DEBUG:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 Target=System.err：默认情况下是：System.out,指定输出控制台 <strong>FileAppender 选项</strong> Threshold=DEBUF:指定日志消息的输出最低层次。 ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 File=mylog.txt:指定消息输出到mylog.txt文件。 Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 <strong>RollingFileAppender 选项</strong> Threshold=DEBUG:指定日志消息的输出最低层次。 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.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
再看看xml各元素的说明：
log4j:configuration (root element) xmlns:log4j [#FIXED attribute] : 定义log4j的名字空间，取定值"http://jakarta.apache.org/log4j/"appender [* child] : 一个appender子元素定义一个日志输出目的地logger [* child] : 一个logger子元素定义一个日志写出器root [? child] : root子元素定义了root logger appenderappender元素定义一个日志输出目的地。 name [#REQUIRED attribute] : 定义appender的名字，以便被后文引用class [#REQUIRED attribute] : 定义appender对象所属的类的全名param [* child] : 创建appender对象时传递给类构造方法的参数layout [? child] : 该appender使用的layout对象 layoutlayout元素定义与某一个appender相联系的日志格式化器。 class [#REQUIRED attribute] : 定义layout对象所属的类的全名param [* child] : 创建layout对象时传递给类构造方法的参数 loggerlogger元素定义一个日志输出器。 name [#REQUIRED attribute] : 定义logger的名字，以便被后文引用additivity [#ENUM attribute] : 取值为"true"（默认）或者"false"，是否继承父logger的属性level [? child] : 定义该logger的日志级别appender-ref [* child] : 定义该logger的输出目的地 rootroot元素定义根日志输出器root logger。 param [* child] : 创建root logger对象时传递给类构造方法的参数level [? child] : 定义root logger的日志级别appender-ref [* child] : 定义root logger的输出目的地 levellevel元素定义logger对象的日志级别。 class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类value [#REQUIRED attribute] : 为level对象赋值。可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。当值为"off"时表示没有任何日志信息被输出param [* child] : 创建level对象时传递给类构造方法的参数 appender-refappender-ref元素引用一个appender元素的名字，为logger对象增加一个appender。 ref [#REQUIRED attribute] : 一个appender元素的名字的引用appender-ref元素没有子元素 paramparam元素在创建对象时为类的构造方法提供参数。它可以成为appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。 name and value [#REQUIRED attributes] : 提供参数的一组名值对param元素没有子元素在xml文件中配置appender和layout创建不同的Appender对象或者不同的Layout对象要调用不同的构造方法。可以使用param子元素来设定不同的参数值。创建ConsoleAppender对象ConsoleAppender的构造方法不接受其它的参数。 ... ... ... ...<appender name="console.log" class="org.apache.log4j.ConsoleAppender"> <layout ... > ... ... </layout></appender>... ... ... ... 创建FileAppender对象可以为FileAppender类的构造方法传递两个参数：File表示日志文件名；Append表示如文件已存在，是否把日志追加到文件尾部，可能取值为"true"和"false"（默认）。 ... ... ... ...<appender name="file.log" class="org.apache.log4j.FileAppender"> <param name="File" value="/tmp/log.txt" /> <param name="Append" value="false" /> <layout ... > ... ... </layout></appender>... ... ... ... 创建RollingFileAppender对象除了File和Append以外，还可以为RollingFileAppender类的构造方法传递两个参数：MaxBackupIndex备份日志文件的个数（默认是1个）；MaxFileSize表示日志文件允许的最大字节数（默认是10M）。 ... ... ... ...<appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender"> <param name="File" value="/tmp/rollingLog.txt" /> <param name="Append" value="false" /> <param name="MaxBackupIndex" value="2" /> <param name="MaxFileSize" value="1024" /> <layout ... > ... ... </layout></appender>... ... ... ... 创建PatternLayout对象可以为PatternLayout类的构造方法传递参数ConversionPattern。 ... ... ... ...<layout class="org.apache.log4j.PatternLayout> <param name="ConversionPattern" value="%d [%t] %p - %m%n" /></layout>... ... ... ...
最后看个xml的例子：
<?xml version="1.0" encoding="GBK" ?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <!-- 输出日志到控制台 ConsoleAppender --> <appender name="console" class="org.apache.log4j.ConsoleAppender"> <param name="Threshold" value="info"></param> <layout class="org.apache.log4j.TTCCLayout"> <param name="ConversionPattern" value="TTCCLayout"></param> </layout> </appender> <!-- 输出日志到文件 每天一个文件 --> <appender name="dailyRollingFile" class="org.apache.log4j.DailyRollingFileAppender"> <param name="Threshold" value="info"></param> <param name="ImmediateFlush" value="true"></param> <param name="File" value="c:/logs/dailyRollingFile.log"></param> <param name="DatePattern" value="‘.‘yyyy-MM-dd‘.log‘"></param> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param> </layout> </appender> <!-- 输出日志到文件 文件大小到达指定尺寸的时候产生一个新的文件 --> <appender name="railyFile" class="org.apache.log4j.RollingFileAppender"> <param name="File" value="c:/logs/railyFile.log"></param> <param name="ImmediateFlush" value="true"/> <param name="Threshold" value="info"></param> <param name="Append" value="true"></param> <param name="MaxFileSize" value="30KB"></param> <param name="MaxBackupIndex" value="100"></param> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param> </layout> </appender> <!-- 输出日志到文件 --> <appender name="file" class="org.apache.log4j.FileAppender"> <param name="File" value="c:/logs/file.log"></param> <param name="Threshold" value="info"></param> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param> </layout> </appender> <!-- 定义全局的日志输出级别,但是在输出目的地的配置中配置的具体输出级别优先级高于全局定义的优先级。 如果在railyFile中定义<param name="Threshold" value="http://www.mamicode.com/info"></param>，那么将会把info以上级别的信息输出 --> <root> <priority value="debug" /> <appender-ref ref="console" /> <appender-ref ref="dailyRollingFile" /> <appender-ref ref="railyFile" /> <appender-ref ref="file" /> </root> </log4j:configuration>
log4j范例程序：
import org.apache.log4j.*; public class LogTest ...{ static Logger logger = Logger.getLogger(LogTest.class.getName()); public static void main(String[] args) ...{ PropertyConfigurator.configure ( “.\srclog4j.properties”)； logger.debug("Debug ..."); logger.info("Info ..."); logger.warn("Warn ..."); logger.error("Error ..."); } }
① static Logger logger = Logger.getLogger(LogTest.class.getName());就是创建一个属于LogTest类的Logger对象，创建时要告知Logger你当前的Class是什么。
② PropertyConfigurator.configure ( “log4j.properties”)就是说使用当前工程目录下的src文件夹中的log4j.properties文件或者log4j.xml作为配置文件。若将log4j.properties(log4j.xml)放在工程根目录下也可不写此句，程序会自动找到配置文件。
③ logger.debug就是输出debug的信息，logger.info就是输出提示信息，logger.warn就是显示警告信息，logger.error就是显示错误信息。