log4j简介

Log4j简介

第1章。 Log4j 的优点

Log4j是亚帕基印第安人的一个开放源代码项目，通过使用Log4j我们可以控制日志信息输送的; 我们也可以控制每一条日志的输出格式; 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。 log4j的好处在于： 1) 通过修改配置文件，就可以决定日志信息的目的地- -控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等 2) 通过修改配置文件，可以定义每一条日志信息的级别，从而控制是否输出。在系统开发阶段可以打印详细的日志信息以跟踪系统运行情况,而在系统稳定后可以关闭日志输出,从而在能跟踪系统运行情况的同时,又减少了垃圾代码(System.out.println (......)等)。 3) 使用log4j需要整个系统有一个统一的日志机制，有利于系统的规划。

第2章。 配置文件

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

2.1. 日志信息的优先级

分为[[OFF]]、致命、错误、警告、信息、调试、所有或者您定义的级别。 Log4j建议只使用四个级别，优先级从高到低分别是错误、警告、信息、调试。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。 假如在一个级别为q的日志记录器中发生一个级别为p的日志请求，如果p> =q，那么请求将被启用。这是Log4j的核心原则。 比如在这里定义了信息级别，则应用程序中所有调试级别的日志信息将不被打印出来;

2.2. 输出源的使用

有选择的能用或者禁用日志请求仅仅是Log4j的一部分功能。Log4j允许日志请求被输出到多个输出源。用Log4j的话说，一个输出源被称做一个Appender。 Appender包括控制台(控制台)文件(文件)GUI组分(图形的组件)遥远的插口服务器（插口 服务) JMS（Java信息服务)NT事件日志记录器（NT的事件日志)和遥远的UNIX Syslog邪魔(远程UNIX的后台日志服务)。它也可以做到异步记录。 一个日志记录器可以设置超过一个的appender。 用addAppender 方法添加一个appender到一个给定的日志记录器。对于一个给定的日志记录器它每个生效的日志请求都被转发到该日志记录器所有的appender上和该日志记录器的父辈日志记录器的appender上。

2.2.1. ConsoleAppender

如果使用ConsoleAppender那么日志信息将写到控制台。效果等同于直接把信息打印到System.out上了。

2.2.2. FileAppender

使用FileAppender那么日志信息将写到指定的文件中。这应该是比较经常使用到的情况。 相应地，在配置文件中应该指定日志输出的文件名。如下配置指定了日志文件名为dglog。txt log4j.appender. A2.File=dglog.txt 注意将A2替换为具体配置中Appender的别名。

2.2.3. DailyRollingAppender

使用FileAppender可以将日志信息输出到文件中，但是如果文件太大了读起来就不方便了。这时就可以使用DailyRollingAppender。DailyRollingAppender可以把日志信息输出到按照日期来区分的文件中。配置文件就会每天产生一个日志文件，每个日志文件只记录当天的日志信息： log4j.appender. A2=org.apache.log4j.DailyRollingFileAppender log4j.appender. A2.file=dglog log4j.appender. A2.DatePattern='. ‘yyyy毫米dd log4j.appender. A2.layout=org.apache.log4j.PatternLayout log4j.appender. A2.layout.ConversionPattern= %5r %-5p %c {2} - %m%n

2.2.4. org.apache.log 4j.RollingFileAppender

文件大小到达指定尺寸的时候产生一个新的文件。 log4j.appender. R=org.apache.log4j.RollingFileAppender log4j.appender. R.File= ../logs/dglog.log #控制最大记录文件大小 log4j.appender. R.MaxFileSize=100KB #归档日志文件(这里一个备用文件) log4j.appender. R.MaxBackupIndex=1 log4j.appender. R.layout=org.apache.log4j.PatternLayout log4j.appender. R.layout.ConversionPattern=%p %t %c - %m%n 这个配置文件指定了输出源R是一个轮转日志文件。最大的文件是100KB当一个日志文件达到最大尺寸时，Log4J会自动把example.log重命名为dglog.log .1然后重建一个新的dglog.log文件，依次轮转。

2.2.5. org.apache.log 4j.WriterAppender

将日志信息以流格式发送到任意指定的地方。

2.3. 布局的配置

布局指定了日志信息输出的样式。

2.3.1. 布局样式

org.apache.log 4j.HTMLLayout(以HTML表格形式布局)， org.apache.log 4j.PatternLayout(可以灵活地指定布局模式)， org.apache.log 4j.SimpleLayout(包含日志信息的级别和信息字符串)， org.apache.log 4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

2.3.2. 格式

%m 输出代码中指定的消息 %p 输出优先级，即调试，信息，警告，错误，致命 %r 输出自应用启动到输出该日志信息耗费的毫秒数 %c 输出所属的类目，通常就是所在类的全名 %t 输出产生该日志事件的线程名 %n 输出一个回车换行符，窗口平台为"rn"，Unix平台为"n" %d 输出日志时间点的日期或时间，默认格式为ISO8601也可以在其后指定格式，比如：%d {yyy MMM dd HH ：毫米：ss， SSS}输出类似：2002年10月18日 22：10：28，921 %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (测试Log4.java ：10)

2.3.3. 例子

例子1：显示日期和日志信息 log4j.appender. A2.layout=org.apache.log4j.PatternLayout log4j.appender. A2.layout.ConversionPattern=%d {yyyy毫米dd HH ：毫米：ss， SSS} %m%n 打印的信息是： 2002-11-12 11:49 ：42,866精选*从角色， 1=1顺序由createDate desc 例子2：显示日期，日志发生地方和日志信息 log4j.appender. A2.layout=org.apache.log4j.PatternLayout log4j.appender. A2.layout.ConversionPattern=%d {yyyy毫米dd HH ：毫米：ss， SSS} %l “#” %m%n 2002-11-12 11:51 ：46,313 cn.net .unet.weboa.system.dao.RoleDAO.select (RoleDAO.java ：409) “#” 选择*从角色， 1=1顺序由createDate desc 例子3：显示日志级别,时间,调用方法日志信息 log4j.appender. A2.layout=org.apache.log4j.PatternLayout log4j.appender. A2.layout.ConversionPattern= [%-5p] %d {yyyy毫米dd HH ：毫米：ss， SSS} 方法：%l%n%m%n 日志信息: [调试] 2002-11-12 12:00 ：57,376 方法：cn.net.unet.weboa.system.dao.RoleDAO.select (RoleDAO.java ：409) 选择*从角色， 1=1顺序由createDate desc

2.4. 配置文件的例子:

log4j.rootLogger=DEBUG #将DAO层日志记录到DAOLog， allLog中 log4j.log ger.DAO=DEBUG， A2， A4 #将逻辑层日志记录到BusinessLog， allLog中 log4j.log ger。Businesslog=DEBUG， A3， A4 #A1--打印到屏幕上 log4j.appender. A1=org.apache.log4j.ConsoleAppender log4j.appender. A1.layout=org.apache.log4j.PatternLayout log4j.appender. A1.layout.ConversionPattern=%-5p [%t] %37c %3x - %m%n #A2--打印到文件DAOLog中--专门为DAO层服务 log4j.appender. A2=org.apache.log4j.DailyRollingFileAppender log4j.appender. A2.file=DAOLog log4j.appender. A2.DatePattern='. ‘yyyy毫米dd log4j.appender. A2.layout=org.apache.log4j.PatternLayout log4j.appender. A2.layout.ConversionPattern= [%-5p] %d {yyyy毫米dd HH ：毫米：ss， SSS} 方法：%l%n%m%n #A3--打印到文件BusinessLog中--专门记录逻辑处理层服务日志信息 log4j.appender. A3=org.apache.log4j.DailyRollingFileAppender log4j.appender. A3.file=BusinessLog log4j.appender. A3.DatePattern='. ‘yyyy毫米dd log4j.appender. A3.layout=org.apache.log4j.PatternLayout log4j.appender. A3.layout.ConversionPattern= [%-5p] %d {yyyy毫米dd HH ：毫米：ss， SSS} 方法：%l%n%m%n #A4--打印到文件alllog中--记录所有日志信息 log4j.appender. A4=org.apache.log4j.DailyRollingFileAppender log4j.appender. A4.file=alllog log4j.appender. A4.DatePattern='. ‘yyyy毫米dd log4j.appender. A4.layout=org.apache.log4j.PatternLayout log4j.appender. A4.layout.ConversionPattern= [%-5p] %d {yyyy毫米dd HH ：毫米：ss， SSS} 方法：%l%n%m%n

第3章。 API使用

log4j使用步骤有3个：

3.1. 初始化

3.1.1. 雄猫下的初始化

默认的Log4j初始化典型的应用是在网络服务器 环境下。在tomcat3.x和tomcat4.x下，你应该将配置文件Log4j.properties放在你的网应用程序的网INF/classes 目录下。 Log4j将发现属性文件，并且以此初始化。这是使它工作的最容易的方法。 你也可以选择在运行雄猫前设置系统属性Log4j.configuration 。对于雄猫3.x，TOMCAT_OPTS 系统变量是用来设置命令行的选项。对于tomcat4.0用系统环境变量CATALINA_OPTS 代替了TOMCAT_OPTS。 UNIX 命令行 出口TOMCAT_OPTS= " - DLog4j.configuration=foobar.txt " 告诉Log4j用文件foobar.txt作为默认的配置文件。这个文件应该放在网INF/classes 目录下。这个文件将被PropertyConfigurator所读。每个网应用将用不同的默认配置文件，因为每个文件是和它的网应用 相关的。 1. 出口TOMCAT_OPTS= " - DLog4j.debug - DLog4j.configuration=foobar.xml " 出口TOMCAT_OPTS= " - DLog4j.debug - DLog4j.configuration=foobar.xml " 告诉Log4j输出Log4j内部的调试信息，并且用foobar.xml作为默认的配置文件。这个文件应该放在你的网应用的网INF/classes 目录下。因为有.xml的扩展名，它将被DOMConfigurator所读。每个网应用将用不同的默认配置文件。因为每个文件都和它所在的网应用 相关的。 2. 设置TOMCAT_OPTS=-DLog4j.configuration=foobar.lcf - DLog4j.configuratorClass=com.foo.BarConfigurator 告诉Log4j用文件foobar.lcf作为默认的配置文件。这个文件应该放在你的网应用的网INF/classes 目录下。因为定义了Log4j.configuratorClass 系统属性，文件将用自定义的com.foo.barconfigurator类来解析。每个网应用将用不同的默认配置文件。因为每个文件都和它所在的网应用 相关的。 3. 设置TOMCAT_OPTS=-DLog4j.configuration= file:/c:/foobar.lcf 设置TOMCAT_OPTS=-DLog4j.configuration= file:/c:/foobar.lcf 告诉Log4j用文件foobar.lcf作为默认的配置文件。这个配置文件用URL file:/c:/foobar.lcf定义了全路径名。这样同样的配置文件将被所有的网应用所用。 不同的网应用将通过它们自己的类装载器来装载Log4j。这样，每个Log4j的环境将独立的运作，而没有任何的相互同步。例如：在多个网应用中定义了完全相同的输出源的FileAppenders将尝试写同样的文件。结果好象是缺乏安全性的。你必须确保每个不同的网应用的Log4j配置没有用到同样的系统资源。

3.1.2. Servlet 的初始化

用一个特别的servlet来做Log4j的初始化也是可以的。如下是一个例子： 公开类Log4jInit延伸HttpServlet { 公众空init () { 串起前缀= getServletContext () .getRealPath (“/”); 串文件= getInitParameter (“Log4j init文件”); 如果(文件! =零位) { PropertyConfigurator.configure (prefix+file); } } 公众空doGet (HttpServletRequest req， HttpServletResponse res) { } } 在web.xml中定义随后的servlet为你的网应用。 <servlet> <servlet名字>Log4j-init< /servlet-name> <servlet类>xx.xx。Log4jInit< /servlet-class> <init氰胍> <氰胍名字>Log4j init文件</param-name> <氰胍价值>网INF/classes/Log4j.properties< /param-value> </init-param> <装载在起动>1< /load-on-startup> </servlet> 写一个初始化的servlet是最有弹性的初始化Log4j的方法。代码中没有任何限制，你可以在servlet的init方法中定义它。

3.2. 根据配置文件初始化log4j

log4j可以使用3中配置器来初始化：BasicConfigurator， DOMConfigurator， PropertyConfigurator 其语法为： BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。 PropertyConfigurator.configure (串configFilename) ：读取使用Java的特性文件编写的配置文件。 DOMConfigurator.configure (串文件名) ：读取XML形式的配置文件。 这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。如下的语句： PropertyConfigurator.configure (“log4j.properties”); 就以log4j.properties为配置文件初始化好了log4j环境。 注意一点：这个语句只需要在系统启动的时候执行一次。例如，在ActionServlet的init ()方法中调用一次。 公开类ActionServlet延伸HttpServlet { ... /** *初始化全局变量 */ 公众空init ()投掷ServletException { // 初始化行动资源 尝试{ initLog4j (); ... }抓住(IOException e) { 投掷新的ServletException (“装载ActionRes是错误”); } } ... 被保护的空initLog4j () { PropertyConfigurator.configure (“log4j.properties”); } ... } //end类ActionServlet

3.3. 在需要使用log4j的地方获取日志记录器实例

使用Log4j首先就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： 公开静态日志记录器getLogger (串名字)， 通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。名字一般取本类的名字，比如： 静态日志记录器日志记录器= Logger.getLogger (ServerWithLog4j.class.getName ()); Log4j使得通过软件组件命名日志记录器很容易。我们可以通过日志记录器的静态的初始化方法在每一个类里定义一个日志记录器令日志记录器的名字等于类名的全局名，而实现日志记录器的命名。这是一个实效的简单的定义一个日志记录器的方法。因为日志输出带有产生日志的类的名字，这个命名策略使得我们更容易定位到一个日志信息的来源。虽然普通，但却是命名日志记录器的常用策略之一。 Log4j没有限制定义日志记录器的可能。开发员可以自由的按照它们的意愿定义日志记录器的名称。 然而，以类的所在位置来命名日志记录器好象是目前已知的最好方法。

3.4. 使用日志记录器对象的调试，信息，致命…方法

log.debug (“它是调试信息”);

第4章。 优化

一个经常引用的依靠于采伐的参数是可以计算的花费。这是一个合理的概念，一个适度的应用程序可能产生成千上万个日志请求。许多努力花在测量和调试采伐的优化上。Log4j要求快速和弹性：速度最重要，弹性是其次。

4.1. 日志为禁用时，日志的优化。

当日志被彻底的关闭，一个日志请求的花费等于一个方法的调用加上整数的比较时间。在233mhz的奔腾II 机器上这个花费通常在5-50纳秒之间。 然而，方法调用包括参数构建的隐藏花费。 例如，对于日志记录器猫，logger.debug (“词条数字： “+ i +”是“+ String.valueOf (词条[i])); 引起了构建信息参数的花费，例如，转化整数i和词条[i]到一个串并且连接中间字符串，不管信息是否被输出。这个参数的构建花费可能是很高，它主要决定于被调用的参数的大小。 避免参数构建的花费应如下，

如果(logger.isDebugEnabled ()) { logger.debug (“结果是” +结果); }

如果日志记录器的调试被关闭这将不会招致参数构建的花费。另一方面，如果日志记录器是调试的话，它将产生两次判断 日志记录器是否能用的花费。一次是在debugenabled一次是调试。这是无关紧要的，因为判断日志的能用 只占日志实际花费时间的约1%。 在Log4j里，日志请求在日志记录器 类的实例里。日志记录器 是一个类，而不是一个接口。这大量的减少了在方法调用上的弹性化的花费。 当然用户采用预处理或编译时间技术去编译出所有的日志声明。这将导致完美的执行成效。然而因为二进制应用程序不包括任何的日志声明的结果，日志不可能对那个二进制程序开启。以我的观点，以这种较大的代价来换取较小的性能优化是不值得的。

4.2. 当日志状态为启用时，日志的优化。

这是本质上的优化日志记录器的层次。当日志状态为开，Log4j依然需要比较请求的级别与日志记录器的级别。然而， 日志记录器可能没有被安排一个级别; 它们将从它们的父亲继承。这样，在继承之前，日志记录器可能需要搜索它的祖先。 这里有一个认真的努力使层次的搜索尽可能的快。例如，子日志记录器仅仅连接到它的存在的父亲日志记录器。 在先前展示的BasicConfigurator 例子中，名为com.foo.bar 的日志记录器是连接到跟根日志记录器因此绕过 了不存在的日志记录器com和com.foo。这将显著的改善执行的速度，特别是解析日志记录器的层结构时。 典型的层次结构的解析的花费是日志记录器彻底关闭时的三倍。

4.3. 日志信息的输出时，日志的优化。

这是主要花费在日志输出的格式化和发送它到它的输出源上。这里我们再一次的付出努力以使格式化执行的尽可能快。同appender一样。实际上典型的花费大约是100-300毫秒。 详情看org.apache.log 4.performance。采伐。 虽然Log4j有许多特点，但是它的第一个设计目标还是速度。一些Log4j的组件已经被重写过很多次以改善性能。不过，投稿者经常提出了新的优化。你应该满意的知道，以SimpleLayout的配置执行测试已经展示了Log4j的输出同System.out.println一样快。