欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

log4j配置

程序员文章站 2022-07-08 16:00:21
...

Logger - 日志写出器 ,供程序员输出日志信息
Appender - 日志目的地 ,把格式化好的日志信息输出到指定的地方去
Layout - 日志格式化器 ,用来把程序员的 logging request 格式化成字符串

Log4j 基本使用方法
   Log4j 由三个重要的组件构成:日志信息的优先级,日志信息的输出目的地,日志信息的输出格式 。日志信息的优先级从高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ,分别用来指定这条日志信息的重要程度;日志信息的输出目的地指定了日志将打印到控制台还是文件中;而输出格式则控制了日志信息的显示内容。
    1 、定义配置文件
      其实您也可以完全不使用配置文件,而是在代码中配置 Log4j 环境。但是,使用配置文件将使您的应用程序更加灵活。 Log4j 支持两种配置文件格式,一种是 XML 格式的文件,一种是 Java 特性文件(键 = 值 properties 文件)。下面我们介绍使用 Java 特性文件做为配置文件的方法:

   1 ) . 配置根 Logger ,其语法为:
   log4j.rootLogger = [ level ] , appenderName, appenderName, …
  其中, level 是日志记录的优先级,分为 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL 或者您定义的级别。 Log4j 建议只使用四个级别 ,优先级从高到低分别是 ERROR 、 WARN 、 INFO 、 DEBUG 。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了 INFO 级别,则应用程序中所有 DEBUG 级别的日志信息将不被打印出来 。 appenderName 就是指 B 日志信息输出到哪个地方。您可以同时指定多个输出目的地。

   2 )配置日志信息输出目的地 Appender ,其语法为:
   log4j.appender.appenderName = fully.qualified.name.of.appender.class. 其中, Log4j 提供的 appender 有以下几种:
          1.org.apache.log4j.ConsoleAppender (控制台),
          2.org.apache.log4j.FileAppender (文件),
          3.org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件),
          4.org.apache.log4j.RollingFileAppender (文件大小到达指定尺寸的时候产生一个    新的文件)
          5.org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)

   3) . 配置日志信息的格式(布局),其语法为:
   log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
  其中, Log4j 提供的 layout 有以 e 几种:
          1.org.apache.log4j.HTMLLayout (以 HTML 表格形式布局),
          2.org.apache.log4j.PatternLayout (可以灵活地指定布局模式),
          3.org.apache.log4j.SimpleLayout (包含日志信息的级别和信息字符串),
          4.org.apache.log4j.TTCCLayout (包含日志产生的时间、线程、类别等等信息)
   Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息,打印参数如下: %m 输出代码中指定的消息
   %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)
     %x: 输出和当前线程相关联的 NDC( 嵌套诊断环境 ), 尤其用到像 java servlets 这样的多客户多线程的应用中。
     %%: 输出一个 "%" 字符
     %F: 输出日志消息产生时所在的文件名称
     %L: 输出代码中的行号
     %m: 输出代码中指定的消息 , 产生的日志具体信息
     %n: 输出一个回车换行符, Windows 平台为 "/r/n" , Unix 平台为 "/n" 输出日志信息换行
     可以在 % 与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。

在代码中使用 Log4j
   1. 得到记录器
   使用 Log4j ,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
   public static Logger getLogger( String name)
   通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。 Name 一般取本类的名字,比如:
   static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
   2. 读取配置文件
  当获得了日志记录器之后,第二步将配置 Log4j 环境,其语法为:
   BasicConfigurator.configure () : 自动快速地使用缺省 Log4j 环境。
   PropertyConfigurator.configure ( String configFilename) :读取使用 Java 的特性文件编写的配置文件。
   DOMConfigurator.configure ( String filename ) :读取 XML 形式的配置文件。
    3. 插入记录信息(格式化日志信息)
  当上两个必要步骤执行完毕,您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:
   Logger.debug ( Object message ) ;
   Logger.info ( Object message ) ;
   Logger.warn ( Object message ) ;
   Logger.error ( Object message ) ; 

配置日志信息输出目的地,其语法为:
     log4j.appender.appenderName = fully.qualified.name.of.appender.class  //
     "fully.qualified.name.of.appender.class" 可以指定下面五个目的地中的一个:
          1.org.apache.log4j.ConsoleAppender (控制台)
          2.org.apache.log4j.FileAppender (文件)
          3.org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
          4.org.apache.log4j.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新的文件)
          5.org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)
             1.ConsoleAppender 选项
                    Threshold=WARN: 指定日志消息的输出最低层次。
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
                    Target=System.err :默认情况下是: System.out, 指定输出控制台
              2.FileAppender 选项
                    Threshold=WARN: 指定日志消息的输出最低层次。
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。
                    Append=false: 默认值是 true, 即将消息增加到指定文件中, false 指将消息覆盖指定的文件内容。
            3.DailyRollingFileAppender 选项
                    Threshold=WARN: 指定日志消息的输出最低层次。
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。
                    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: 每分钟
            4.RollingFileAppender 选项
                    Threshold=WARN: 指定日志消息的输出最低层次。
                    ImmediateFlush=true: 默认值是 true, 意谓着所有的消息都会被立即输出。
                    File=mylog.txt: 指定消息输出到 mylog.txt 文件。
                    Append=false: 默认值是 true, 即将消息增加到指定文件中, false 指将消息覆盖指定的文件内容。
                    MaxFileSize=100KB: 后缀可以是 KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到 mylog.log.1 文件。
                    MaxBackupIndex=2: 指定可以产生的滚动文件的最大数。