• 1. Log4j李明 2011·01
  • 2. 问题的提出 log4j = Log for Java 在项目运行的过程之中,我们希望周期性地将项目运行过 程中的一些状况纪录在日志文件或者打印在控制台。 用户操作的错误信息 程序运行的过程 代码调试的打印
  • 3. 介绍Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。  Log4j由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制了日志信息的显示内容。 
  • 4. Properties配置文件其实您也可以完全不使用配置文件,而是在代码中配置Log4j环境。但是,使用配置文件将使您的应用程序更加灵活。  Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties格式的文件。 Properties文件配置示例:  log4j.rootLogger=debug,stdout log4j.appender.stdout=org.apache.log4j.ConsoleAppender  log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  log4j.appender.stdout.layout.ConversionPattern=%5p %c{1}:%L - %m%n
  • 5. XML配置文件  
  • 6. Properties文件配置之Logger 语法:  log4j.rootLogger = [level],appenderName,appenderName, …  level:是日志记录的优先级,分别为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。 
  • 7. XML文件配置之Logger示例: name:logger名称,与在程序中的Logger.getLogger(…) 对应。 additivity: children-logger是否使用 父Logger的配置。 appender-ref:此项可以为多个;指定要输出的地方。
  • 8. Log4j - Appender语法为(properties配置文件):  log4j.appender.appenderName = fully.qualified.name.of.appender.class  log4j.appender.appenderName.option1 = value1  …  log4j.appender.appenderName.optionN = valueN  Log4j提供的appender有以下几种:  org.apache.log4j.ConsoleAppender(控制台),  org.apache.log4j.FileAppender(文件),  org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),  org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),  org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) 
  • 9. Log4j - Appender SMTPAppender 当特定的日志事件发生时,一般是指发生错误或者重大错误时,发送一封邮件 , SocketAppender 给远程日志服务器(通常是网络套接字节点)发送日志事件(LoggingEvent)对象,  SocketHubAppender 给远程日志服务器群组(通常是网络套接字节点)发送日志事件(LoggingEvent)对象,  SyslogAppender给远程异步日志记录的后台精灵程序(daemon)发送消息,  TelnetAppender 一个专用于向只读网络套接字发送消息的log4j appender 我们还可以实现 Appender 接口,创建以自己的方式进行日志输出的Appender 自定义Appender:CustomCatalogDailyRollingFileAppender
  • 10. ConsoleAppender & FileAppender ConsoleAppender选项 Threshold=WARN:指定日志消息的输出最低层次。  ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 Target=System.err:默认情况下是:System.out,指定输出控制台  FileAppender选项  Threshold=WARN:指定日志消息的输出最低层次。  ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。  File=mylog.txt:指定消息输出到mylog.txt文件。  Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。 
  • 11. DailyRollingFileAppenderDailyRollingFileAppender选项 Threshold=WARN:指定日志消息的输出最低层次。  ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。  File=mylog.log:指定消息输出到mylog.log文件。 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: 每分钟 
  • 12. RollingFileAppenderRollingFileAppender 选项  Threshold=WARN:指定日志消息的输出最低层次。  ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。  File=mylog.log:指定消息输出到mylog. log文件。  Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。  MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。  MaxBackupIndex=2:指定可以产生的滚动文件的最大数。 
  • 13. 配置日志信息的布局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(包含日志产生的时间、线程、类别等等信息) 
  • 14. 输出格式设置在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。  参数:  %p: 输出日志信息优先级,即DEBUG,INFO,WARN,ERROR,FATAL %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921  %r: 输出自应用启动到输出该log信息耗费的毫秒数  %c: 输出日志信息所属的类目,通常就是所在类的全名  %t: 输出产生该日志事件的线程名  %l: 输出日志事件的发生位置,相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程,以及在代码中的行数。举例:Testlog4.main(TestLog4.java:10) 
  • 15. 输出格式设置 %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 %%: 输出一个”%”字符 %F: 输出日志消息产生时所在的文件名称 %L: 输出代码中的行号 %m: 输出代码中指定的消息,产生的日志具体信息 %n: 输出一个回车换行符,Windows平台为”\r\n”,Unix平台为”\n”输出日志信息换行
  • 16. 输出格式设置可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如: %20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,默认的情况下右对齐。 %-20c:指定输出category的名称,最小的宽度是20,如果category的名称小于20的话,”-”号指定左对齐。 %.30c:指定输出category的名称,最大的宽度是30,如果category的名称大于30的话,就会将左边多出的字符截掉,但小于30的话也不会有空格。 %20.30c:如果category的名称小于20就补空格,并且右对齐,如果其名称长于30字符,就从左边将多出的字符截掉。
  • 17. 在程序中的使用 log4j log4j 1.2.16 根据使用到其他不同的API,需要引入一些依赖的包。 如使用 SMTPAppender,则需要引入JavaMail API。
  • 18. 在程序中的使用得到记录器  使用Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:  public static Logger getLogger( String name),  通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。Name一般取本类的名字,比如:  static Logger logger = Logger.getLogger ( ServerWithLog4j.class ) ;  Logger的命名规则 Logger由一个String类的名字识别,logger的名字是大小写敏感的,且名字之间具有继承的关系,子名有父名作为前缀,用点号“.”分隔。如:x.y是x.y.z的父Logger。
  • 19. 在程序中的使用插入记录信息(格式化日志信息)  当上两个必要步骤执行完毕,您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:  Logger.debug ( Object message ) ;  Logger.info ( Object message ) ;  Logger.warn ( Object message ) ;  Logger.error ( Object message ) ;  
  • 20. Log4j比较全面的配置log4j.rootLogger=DEBUG,CONSOLE,A1,im   log4j.addivity.org.apache=true   # 应用于控制台   log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender   log4j.appender.Threshold=DEBUG   log4j.appender.CONSOLE.Target=System.out   log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout   log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[thread] n%c[CATEGORY]%n%m[MESSAGE]%n%n   #应用于文件   log4j.appender.FILE=org.apache.log4j.FileAppender   log4j.appender.FILE.File=file.log   log4j.appender.FILE.Append=false   log4j.appender.FILE.layout=org.apache.log4j.PatternLayout   log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n   # Use this layout for LogFactor 5 analysis  
  • 21. (本页无文本内容)
  • 22. Log4j的架构
  • 23. 不同优先级的日志输出到不同文件Log4j的Filter: LevelRangeFilter: LevelMatchFilter:
  • 24. 在项目中使用它调试时,将项目的log级别定低一些(DEBUG),实际运行时可以将log级别定高一些,屏蔽掉调试时要输出的信息。
  • 25. 小结Log4j 是一个非常流行的基于java的log处理开发包。它与其它的log开发包(如IBM的Jlog以及SUN在JDK1.4中包含的Log API)最明显的区别是运用了Category继承的特性。依赖于这种category的层次关系,使用者就能做到准确的控制每一个log语句的输出,这样大大减少了多余log信息的输出和尽可能的减少对整个系统性能的影响。
  • 26. 小结Log4j的其中一个最有令人称道的一个方面是它的可操作性,使用者一旦在程序中添加了用于log输出的代码,他们就能通过一个外部的配置文件对这些log信息进行运行时控制而无需重新编译源代码。并且,使用者能够有选择的开启或关闭一些log信息的输出。并能够按照自己喜欢的格式将这些log信息输出到许多不同的输出设备中。Log4j还在性能方面做了最大程度的优化。
  • 27. (本页无文本内容)