使用log4j大概涉及3个主要概念:
公共类 | Logger | 负责处理日志记录的大部分操作 |
公共接口 | Appender | 负责控制日志记录操作的输出 |
公共抽象类 | Layout | 负责格式化Appender的输出 |
Logger
日志记录器(Logger)是日志处理的核心组件。
log4j具有5种正常级别(Level)
DEBUG |
指出细粒度信息事件对调试应用程序是非常有帮助的 |
INFO |
表明消息在粗粒度级别上突出强调应用程序的运行过程 |
WARN |
表明会出现潜在错误的情形 |
ERROR |
指出虽然发生错误事件,但仍然不影响系统的继续运行 |
FATAL |
指出每个严重的错误事件将会导致应用程序的退出 |
另外,还有两个可用的特别的日志记录级别
ALL |
是最低等级的,用于打开所有日志记录 |
OFF |
是最高等级的,用于关闭所有日志记录 |
日志记录器(Logger)将只输出那些级别高于或等于它的级别的信息。如果没有设置日志记录器(Logger)的级别,那么它将会继承最近的祖先的级别。因此,如果在包com.foo.bar中创建一个日志记录器(Logger)并且没有设置级别,那它将会继承在包com.foo中创建的日志记录器(Logger)的级别。如果在com.foo中没有创建日志记录器(Logger)的话,那么在com.foo.bar中创建的日志记录器(Logger)将继承root 日志记录器(Logger)的级别,root日志记录器(Logger)经常被实例化而可用,它的级别为DEBUG。
日志记录器(Logger)的创建和设置级别:
//取回root日志记录器 Logger logger = Logger.getRootLogger(); //创建一个新的日志记录器 Logger logger = Logger.getLogger("MyLogger"); //比较常用的用法,就是根据类名实例化一个静态的全局日志记录器 static Logger logger = Logger.getLogger(test.class); //设置日志记录器的级别 logger.setLevel((Level)Level.WARN);
日志级别可以是7个级别中的任意一个。
Appender
Appender 控制日志怎样输出。下面列出一些可用的Appender:
ConsoleAppender |
使用用户指定的布局(layout) 输出日志事件到System.out或者 System.err。默认的目标是System.out。 |
FileAppender |
把日志事件写入一个文件 |
DailyRollingFileAppender |
扩展FileAppender,因此多个日志文件可以以一个用户选定的频率进行循环日志记录。 |
RollingFileAppender |
扩展FileAppender,备份容量达到一定大小的日志文件。 |
WriterAppender |
根据用户的选择把日志事件写入到Writer或者OutputStream。 |
SMTPAppender |
当特定的日志事件发生时,一般是指发生错误或者重大错误时,发送一封邮件。 |
SocketAppender |
给远程日志服务器(通常是网络套接字节点)发送日志事件(LoggingEvent)对象。 |
SocketHubAppender |
给远程日志服务器群组(通常是网络套接字节点)发送日志事件(LoggingEvent)对象。 |
SyslogAppender |
给远程异步日志记录的后台精灵程序(daemon)发送消息。 |
TelnetAppender |
一个专用于向只读网络套接字发送消息的log4j appender。 |
还可以实现 Appender 接口,创建以自己的方式进行日志输出的Appender。
Layout
Appender必须使用一个与之相关联的 Layout,这样它才能知道怎样格式化它的输出。当前,log4j具有三种类型的Layout:
HTMLLayout | 格式化日志输出为HTML表格。 |
PatternLayout | 根据指定的 转换模式格式化日志输出,或者如果没有指定任何转换模式,就使用默认的转换模式。 |
SimpleLayout | 以一种非常简单的方式格式化日志输出,它打印级别 Level,然后跟着一个破折号"-",最后才是日志消息。 |
基本示例
例1:SimpleLayout和FileAppender
import org.apache.log4j.Level; import org.apache.log4j.Logger; import org.apache.log4j.SimpleLayout; import org.apache.log4j.FileAppender; public class SimpandFile { static Logger logger = Logger.getLogger(SimpandFile.class); public static void main(String args[]) { SimpleLayout layout = new SimpleLayout(); FileAppender appender = null; try { appender = new FileAppender(layout,"output1.txt",false); } catch(Exception e) {} logger.addAppender(appender); logger.setLevel((Level) Level.DEBUG); logger.debug("Here is some DEBUG"); logger.info("Here is some INFO"); logger.warn("Here is some WARN"); logger.error("Here is some ERROR"); logger.fatal("Here is some FATAL"); } }
例2:HTMLLayout和 WriterAppender
import java.io.*; import org.apache.log4j.Level; import org.apache.log4j.Logger; import org.apache.log4j.HTMLLayout; import org.apache.log4j.WriterAppender; public class HTMLLandWrite { static Logger logger = Logger.getLogger(HTMLLandWrite.class); public static void main(String args[]) { HTMLLayout layout = new HTMLLayout(); WriterAppender appender = null; try { FileOutputStream output = new FileOutputStream("output2.html"); appender = new WriterAppender(layout,output); } catch(Exception e) {} logger.addAppender(appender); logger.setLevel((Level) Level.DEBUG); logger.debug("Here is some DEBUG"); logger.info("Here is some INFO"); logger.warn("Here is some WARN"); logger.error("Here is some ERROR"); logger.fatal("Here is some FATAL"); } }
例3:PatternLayout和ConsoleAppender
import org.apache.log4j.Level; import org.apache.log4j.Logger; import org.apache.log4j.PatternLayout; import org.apache.log4j.ConsoleAppender; public class ConsandPatt { static Logger logger = Logger.getLogger(ConsandPatt.class); public static void main(String args[]) { // Note, %n is newline String pattern = "Milliseconds since program start: %r %n"; pattern += "Classname of caller: %C %n"; pattern += "Date in ISO8601 format: %d{ISO8601} %n"; pattern += "Location of log event: %l %n"; pattern += "Message: %m %n %n"; PatternLayout layout = new PatternLayout(pattern); ConsoleAppender appender = new ConsoleAppender(layout); logger.addAppender(appender); logger.setLevel((Level) Level.DEBUG); logger.debug("Here is some DEBUG"); logger.info("Here is some INFO"); logger.warn("Here is some WARN"); logger.error("Here is some ERROR"); logger.fatal("Here is some FATAL"); } }
外部配置文件
Log4j经常与外部日志文件联合使用,这样很多可选项不必硬编码在软件中。使用外部配置文件的优点就是修改可选项不需要重新编译程序。唯一的缺点就是,由于用到io 指令,速度稍微有些减慢。
有两个方法可以用来指定外部配置文件:文本文件或者XML文件。
XML配置文件示例:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.SimpleLayout"/> </appender> <root> <priority value ="debug" /> <appender-ref ref="ConsoleAppender"/> </root> </log4j:configuration>
文件以标准的XML声明作为开始,后面跟着指出DTD(文档类型定义)的DOCTYPE声明,它定义了XML文件的结构,例如,什么元素可以嵌入在其他元素中等等。上面文件在log4j发行版的src/java/org/apache/log4j/xml目录中。 接着看看封装所有元素的 log4j:configuration 元素,它在DOCTYPE声明中被指定为根元素。嵌入在根元素中有两个结构:appender和root。
appender
这里创建一个名叫"ConsoleAppender"的 Appender,注意,你可以选择任何名字,该示例之所以选择"ConsoleAppender",完全是为了示例的设计。接着这个appender类以全名形式给出,经常用规范(fully qualified)类名。 Appender必须具有一个指定的 name和class。嵌入在 Appender之内的是 layout元素,这里它被指定为SimpleLayout。 Layout 必须具有一个 class属性。
root
root元素必须存在且不能被子类化。示例中的优先级被设置为"debug",设置appender饱含一个appender-ref元素。还有更多的属性或元素可以指定。查看log4j发行版中的src/main/resources/org/apache/log4j/xml/log4j.dtd以了解关于XML配置文件结构的更多信息。
DOMConfigurator 用一棵DOM树来初始化log4j环境。测试代码如下:
public class ExternalXMLTest { static Logger logger = Logger.getLogger(filetest.class); public static void main(String args[]) { DOMConfigurator.configure("xmllog4jconfig.xml"); logger.debug("Here is some DEBUG"); logger.info("Here is some INFO"); logger.warn("Here is some WARN"); logger.error("Here is some ERROR"); logger.fatal("Here is some FATAL"); } }
实现带有PatternLayout的FileAppender的日志记录器的XML配置:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <appender name="appender" class="org.apache.log4j.FileAppender"> <param name="File" value="Indentify-Log.txt"/> <param name="Append" value="false"/> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d [%t] %p - %m%n"/> </layout> </appender> <root> <priority value ="debug"/> <appender-ref ref="appender"/> </root> </log4j:configuration>
相关推荐
log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记log4j学习笔记
Log4j 学习笔记. 1. Log4j的类图 2. Logger:日志写出器 1. Logger的输出方法 2. Logger的命名规则 3. Log level 4. 示例代码 5. 关于logger的两点说明 3. Appender:日志目的地 1. ConsoleAppender 2. ...
Log4j学习笔记和一套完整定义实例 精辟
Log4j 学习笔记,主要介绍了Log4j如何使用。
Log4j2学习笔记,引入log4j2的依赖-log4j2.xml配置模板-application.properties文件配置-使用
log4j的笔记,教你用log4j。
log4j 学习笔记 自己整理出来的 网上写的很杂乱。其实在java企业级中开发 我们更重视的是如何做日志记录。本笔记快速入门使用 log4j 节省了企业开发的学习成本
Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件等等,我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成...
log4j学习笔记.
Jerry lv的log4j笔记,图文并茂,推荐
Log4J学习笔记 1、配置文件 2、数据库 3、封装
log4j的详细学习笔记,最适合初级、中级学员
*Log4j 学习笔记,自己的一点学习经验
log4j学习笔记及写入数据库配置,一份log4j学习资料。还包含log4j写入数据库的配置方法。
Log4j 是 Apache 的一个开放源代码项目,通过使用 Log4j ,我们可以控制日志信 送的目的地是控制台、文件、 GUI 组件、甚至是套接口服务器、 NT 的事件记录器、 X Syslog 守护进程等;我们也可以控制每一条日志的...
log4j的学习笔记,网上找到的,写的很不错
pptx格式。Log4j详细讲解。Logger--日志写出器,供程序员输出日志信息 。Log4j 允许开发人员定义多个Logger,每个Logger拥有自己的名字,Logger之间通过名字来表明隶属关系。