这是log4j默认的配置

本文详细介绍了Log4j的XML配置方法,包括如何通过不同的Appender实现日志输出到控制台或文件,并展示了如何利用PatternLayout配置日志格式。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

这是log4j默认的配置,我们先熟悉一下
<!-- ============================== -->
<!-- Append messages to the console -->
<!-- ============================== -->
<!--输出方式:输出到控制台-->
<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
<!-- 设置通道名称:console和输出方式:org.apache.log4j.RollingFileAppender
其中输出方式appender有5种,分别为
org.apache.log4j.ConsoleAppender (控制台)
org.apache.log4j.FileAppender (文件)
org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)-->
<param name="Target" value="System.out"/>
<param name="Threshold" value="INFO"/>
<!--Threshold是个全局的过滤器,它将把低于所设置的level的信息过滤不显示出来-->
<!--level:是日记记录的优先级,优先级由高到低分为
OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。
Log4j建议只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG这四个级别。-->

<layout class="org.apache.log4j.PatternLayout">
<!-- 配置日志输出的格式-->
参数都以%开始后面不同的参数代表不同的格式化信息(参数按字母表顺序列出):
%c 输出所属类的全名,可在修改为 %d{Num} ,Num类名输出的围 如:"org.apache.elathen.ClassName",
%C{2}将输出elathen.ClassName

%d 输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS},可指定格式 如 %d{HH:mm:ss}
%l 输出日志事件发生位置,包括类目名、发生线程,在代码中的行数
%n 换行符
%m 输出代码指定信息,如info(“message”),输出message
%p 输出优先级,即 FATAL ,ERROR 等
%r 输出从启动到显示该log信息所耗费的毫秒数
%t 输出产生该日志事件的线程名
<!-- The default pattern: Date Priority [Category] Message\n -->
<param name="ConversionPattern" value="%d{ABSOLUTE} %-5p [%c{1}] %m%n"/>
</layout>
</appender>

<!输出方式是:每天一个日志文件>
<!-- A time/date based rolling appender -->
<appender name="FILE" class="org.jboss.logging.appender.DailyRollingFileAppender">
<!--设置通道名称是:file,输出方式DailyRollingFileAppender-->
<param name="File" value="${jboss.server.home.dir}/log/server.log"/>
<!--日志文件路径和文件名称 -->
<param name="Append" value="false"/>
<!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->


<!-- Rollover at midnight each day -->
<param name="DatePattern" value="'.'yyyy-MM-dd"/>

<!-- Rollover at the top of each hour
<param name="DatePattern" value="'.'yyyy-MM-dd-HH"/>
-->

<layout class="org.apache.log4j.PatternLayout">
<!-- The default pattern: Date Priority [Category] Message\n -->
<param name="ConversionPattern" value="%d %-5p [%c] %m%n"/>

<!-- The full pattern: Date MS Priority [Category] (Thread:NDC) Message\n
<param name="ConversionPattern" value="%d %-5r %-5p [%c] (%t:%x) %m%n"/>
-->
</layout>
</appender>



xml格式的log4j配置文件概述

xml格式的log4j配置文件需要使用org.apache.log4j.html.DOMConfigurator.configure()方法来读入。对xml文件的语法定义可以在log4j的发布包中找到:org/apache/log4j/xml/log4j.dtd。

log4j的xml配置文件的树状结构

log4j的xml配置文件的树状结构如下所示,注意下图只显示了常用的部分。 :.

xml declaration and dtd

|

log4j:configuration

|

+-- appender (name, class)

| |

| +-- param (name, value)

| +-- layout (class)

| |

| +-- param (name, value)

+-- logger (name, additivity)

| |

| +-- level (class, value)

| | |

| | +-- param (name, value)

| +-- appender-ref (ref)

+-- root

|

+-- param (name, class)

+-- level

| |

| +-- param (name, value)

+-- appender-ref (ref)


xml declaration and dtd

xml配置文件的头部包括两个部分:xml声明和dtd声明。头部的格式如下: :.

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">


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

appender

appender元素定义一个日志输出目的地。

name [#REQUIRED attribute] : 定义appender的名字,以便被后文引用

class [#REQUIRED attribute] : 定义appender对象所属的类的全名

param [* child] : 创建appender对象时传递给类构造方法的参数

layout [? child] : 该appender使用的layout对象

layout

layout元素定义与某一个appender相联系的日志格式化器。

class [#REQUIRED attribute] : 定义layout对象所属的类的全名

param [* child] : 创建layout对象时传递给类构造方法的参数

logger

logger元素定义一个日志输出器。

name [#REQUIRED attribute] : 定义logger的名字,以便被后文引用

additivity [#ENUM attribute] : 取值为"true"(默认)或者"false",是否继承父logger的属性

level [? child] : 定义该logger的日志级别

appender-ref [* child] : 定义该logger的输出目的地

root

root元素定义根日志输出器root logger。

param [* child] : 创建root logger对象时传递给类构造方法的参数

level [? child] : 定义root logger的日志级别

appender-ref [* child] : 定义root logger的输出目的地

level

level元素定义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-ref

appender-ref元素引用一个appender元素的名字,为logger对象增加一个appender。

ref [#REQUIRED attribute] : 一个appender元素的名字的引用

appender-ref元素没有子元素

param

param元素在创建对象时为类的构造方法提供参数。它可以成为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="Conversion" value="%d [%t] %p - %m%n" />

</layout>

... ... ... ...


我自己的一个使用xml文件配置log4j环境的很简单的例子

为WSOTA项目开发java web start的胖客户端时,使用了如下的xml文件配置log4j环境(文件名为wsota-rc.log4j.html)::.

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

<!-- ================================================================= -->

<!-- a rolling file appender -->

<!-- ================================================================= -->

<appender name="wsota-rc.file.log" class="org.apache.log4j.RollingFileAppender">

<param name="File" value="/tmp/wsota-rc.log" />

<param name="Append" value="false" />

<layout class="org.apache.log4j.PatternLayout">

<param name="ConversionPattern" value="%d [%t] %p - %m%n" />

</layout>

</appender>

<!-- ================================================================= -->

<!-- a console appender -->

<!-- debug can be turned off by setting level of root to "off" -->

<!-- ================================================================= -->

<appender name="wsota-rc.console.log" class="org.apache.log4j.ConsoleAppender">

<layout class="org.apache.log4j.PatternLayout">

<param name="ConversionPattern" value="%d [%t] %p - %m%n" />

</layout>

</appender>

<!-- use this to turn on debug to a rolling file. -->

<root>

<level value="debug" />

<appender-ref ref="wsota-rc.file.log" />

</root>

<!-- use this to turn on debug to console. -->

<!--

<root>

<level value="off" />

<appender-ref ref="wsota-rc.console.log" />

</root>

-->

<!-- use this to turn off debug. -->

<!--

<root>

<level value="off" />

<appender-ref ref="wsota-rc.console.log" />

</root>

-->

</log4j:configuration>

在胖客户程序中使用了如下代码来使用外部xml文件配置log4j环境,注意该代码段位于程序的main class的静态初始化块中,含有以下代码的类和xml配置文件在同一个目录下::.

import org.apache.log4j.html.DOMConfigurator;

public class SapFrame extends JFrame {

static {

DOMConfigurator.configure(SapFrame.class.getResource("wsota-rc.log4j.html"));

}

... ... ... ...

}


Log4j的编码习惯

让每个类都拥有一个private static的Logger对象,用来输出该类中的全部日志信息

使用xml文件来完成对log4j环境的配置。在项目的main class中的静态初始化块里放log4j环境的配置代码。注意:在一个项目中,log4j环境只需要被配置一次,而不是在每个使用了logger的类里都需要调用一次

用MyClass.class作为参数创建该类的静态Logger对象

补充中...
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值