Apache Log4j使用详细介绍

Apache Log4j使用详细介绍：

 

一、简介：1， Log4J 是Apache 的Logging项目。可去官网查看。

          2，下载地址：http://logging.apache.org/log4j/1.2/download.html

          3，Apache Log4j是当前在J2EE和J2SE开发中用得最多的日志框架（几乎所有项目都用它），因为它具有出色的性能、灵活的配置以及丰富的功能，并且在业务有特殊的要求时，可以使用自定义组件来代替框架中已有的组件来满足要求（别人吹的）。

 

二、优点： 
   1. 动态的改变记录级别和策略，不需要重启Web应用。

   2. 把log文件定在/WEB-INF/logs/而不需要写绝对路径。因为系统把web目录的路径压入webapp.root的系统变量。这样写log文件路径时不用写绝对路

径了. log4j.appender.logfile.File=${webapp.root}/WEB-INF/logs/Myfuse.log 
   3. 可以把log4j.properties和其他properties一起放

   4.log4jRefreshInterval为6000表示 开一条watchdog线程每6秒扫描一下配置文件的变化; 

三：Log4J 配置使用步骤： 

 1，添加log4j.jar

 2,在web.xml中配置log4j：

  <context-param>  

      <param-name>log4jConfigLocation</param-name>  

      <param-value>classpath:log4j.properties</param-value>  

  </context-param>     

 

  <context-param>  

     <param-name>log4jRefreshInterval</param-name>  

      <param-value>3000</param-value>  

  </context-param>  

  

 <listener>  

    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>

 </listener>  

 

3，log4j.properties配置文件（有关配置文件说明后文详细介绍，这里只说明使用）。
 #log4j.rootLogger=INFO, stdout ,f ,database

log4j.rootLogger=DEBUG, stdout ,f

#log4j.logger.org.jbpm = OFF

#log4j.logger.org.springframework = OFF

#log4j.logger.org.hibernate = OFF

#log4j.logger.com.opensymphony = OFF

#log4j.logger.org.apache.cxf = DEBUG

#log4j.logger.org.apache.struts2 =OFF

 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Threshold=info

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 

log4j.appender.stdout.layout.ConversionPattern=%d [%p] %c - %m \n

 

log4j.appender.f=org.apache.log4j.RollingFileAppender

log4j.appender.f.File=${catalina.home}/webapps/logs/AppWebApi/AppWebApi

log4j.appender.f.Threshold=debug

log4j.appender.f.DatePattern='-'yyyy-MM-dd'.log'

log4j.appender.f.layout=org.apache.log4j.PatternLayout

log4j.appender.f.append = true

log4j.appender.f.layout.ConversionPattern=%d %p [%c] - %m%n

log4j.appender.f.MaxFileSize=25MB

 

#log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender

#log4j.appender.database.bufferSize =1

#log4j.appender.database.URL=jdbc:oracle:thin:@localhost:1521:QQJG

#log4j.appender.database.driver=oracle.jdbc.driver.OracleDriver

#log4j.appender.database.user=HFQIMS

#log4j.appender.database.password=HFQIMS

#log4j.appender.database.sql=INSERT INTO "HFQIMS"."SYS_LOG" ("_DATE" ,"_TYPE" ,"_CLASS" ,"_RUN_TIME" ,"_LOG_INFO" ) VALUES ('%d','%p','%c','%r','%m')

#log4j.appender.database.layout=org.apache.log4j.PatternLayout

log4j.properties详解与例子

     Log4j支持两种配置文件格式，一种是XML格式的文件，一种是java properties（key=value）【Java特性文件（键=值）】。（只说明properties文件，常用）

一、配置根Logger

 其语法为：
    log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
    level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。

    Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG.通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

    appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
    例如上文：log4j.rootLogger=DEBUG, stdout ,f

二、配置日志信息输出目的地

     1）其语法为：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（将日志信息以流格式发送到任意指定的地方）

   2）五个目的地说明：

      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:指定可以产生的滚动文件的最大数。

三、配置日志信息的格式

  其语法为：1).log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class 。

  其中："fully.qualified.name.of.layout.class" 可以指定下面4个格式中的一个：
                  1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
                  2.org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
                  3.org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
                  4.org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

1.HTMLLayout 选项LocationInfo=true:默认值是false,输出java文件名称和行号Title=my app file: 默认值是 Log4J Log Messages.
2.PatternLayout 选项ConversionPattern=%m%n :指定怎样格式化指定的消息。
3.XMLLayout选项LocationInfo=true:默认值是false,输出java文件和行号

                     2). log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n这里需要说明的就是日志信息格式中几个符号所代表的含义：
    －X号: X信息输出时左对齐；
    %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平台为""，Unix平台为"  。"输出日志信息换行
  可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
  1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
  2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
  3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
  4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉

 

四：例子

log4j.rootLogger=INFO,consoleAppender,logfile,MAIL
log4j.addivity.org.apache=true

#ConsoleAppender，控制台输出
#FileAppender，文件日志输出
#SMTPAppender，发邮件输出日志
#SocketAppender，Socket日志
#NTEventLogAppender，Window NT日志
#SyslogAppender，
#JMSAppender，
#AsyncAppender，
#NullAppender

#文件输出：RollingFileAppender
#log4j.rootLogger = INFO,logfile
log4j.appender.logfile = org.apache.log4j.RollingFileAppender
log4j.appender.logfile.Threshold = INFO  
# 输出以上的INFO信息
log4j.appender.logfile.File = INFO_log.html    
#保存log文件路径
log4j.appender.logfile.Append = true   
# 默认为true，添加到末尾，false在每次启动时进行覆盖
log4j.appender.logfile.MaxFileSize = 1MB
# 一个log文件的大小，超过这个大小就又会生成1个日志 # KB ，MB，GB
log4j.appender.logfile.MaxBackupIndex = 3  
# 最多保存3个文件备份
log4j.appender.logfile.layout = org.apache.log4j.HTMLLayout
# 输出文件的格式
log4j.appender.logfile.layout.LocationInfo = true
#是否显示类名和行数
log4j.appender.logfile.layout.Title =title:\u63d0\u9192\u60a8\uff1a\u7cfb\u7edf\u53d1\u751f\u4e86\u4e25\u91cd\u9519\u8bef
#html页面的 < title >
############################## SampleLayout ####################################
# log4j.appender.logfile.layout = org.apache.log4j.SampleLayout
############################## PatternLayout ###################################
# log4j.appender.logfile.layout = org.apache.log4j.PatternLayout
# log4j.appender.logfile.layout.ConversionPattern =% d % p [ % c] -   % m % n % d
############################## XMLLayout #######################################
# log4j.appender.logfile.layout = org.apache.log4j.XMLLayout
# log4j.appender.logfile.layout.LocationInfo = true #是否显示类名和行数
############################## TTCCLayout ######################################
# log4j.appender.logfile.layout = org.apache.log4j.TTCCLayout
# log4j.appender.logfile.layout.DateFormat = ISO8601
#NULL, RELATIVE, ABSOLUTE, DATE or ISO8601.
# log4j.appender.logfile.layout.TimeZoneID = GMT - 8 : 00
# log4j.appender.logfile.layout.CategoryPrefixing = false ##默认为true 打印类别名
# log4j.appender.logfile.layout.ContextPrinting = false ##默认为true 打印上下文信息
# log4j.appender.logfile.layout.ThreadPrinting = false ##默认为true 打印线程名
# 打印信息如下：
#2007 - 09 - 13   14 : 45 : 39 , 765 [http - 8080 - 1 ] ERROR com.poxool.test.test - error成功关闭链接
###############################################################################
#每天文件的输出：DailyRollingFileAppender
#log4j.rootLogger = INFO,errorlogfile
log4j.appender.errorlogfile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorlogfile.Threshold = ERROR
log4j.appender.errorlogfile.File = ../logs/ERROR_log
log4j.appender.errorlogfile.Append = true
#默认为true，添加到末尾，false在每次启动时进行覆盖
log4j.appender.errorlogfile.ImmediateFlush = true  
#直接输出，不进行缓存
# ' . ' yyyy - MM: 每个月更新一个log日志
# ' . ' yyyy - ww: 每个星期更新一个log日志
# ' . ' yyyy - MM - dd: 每天更新一个log日志
# ' . ' yyyy - MM - dd - a: 每天的午夜和正午更新一个log日志
# ' . ' yyyy - MM - dd - HH: 每小时更新一个log日志
# ' . ' yyyy - MM - dd - HH - mm: 每分钟更新一个log日志
log4j.appender.errorlogfile.DatePattern = ' . ' yyyy - MM - dd ' .log '
#文件名称的格式
log4j.appender.errorlogfile.layout = org.apache.log4j.PatternLayout
log4j.appender.errorlogfile.layout.ConversionPattern =%d %p [ %c] -   %m %n %d

#控制台输出：
#log4j.rootLogger = INFO,consoleAppender
log4j.appender.consoleAppender = org.apache.log4j.ConsoleAppender
log4j.appender.consoleAppender.Threshold = ERROR
log4j.appender.consoleAppender.layout = org.apache.log4j.PatternLayout
log4j.appender.consoleAppender.layout.ConversionPattern =%d %-5p %m %n
log4j.appender.consoleAppender.ImmediateFlush = true

# 直接输出，不进行缓存
log4j.appender.consoleAppender.Target = System.err
# 默认是System.out方式输出

#发送邮件：SMTPAppender
#log4j.rootLogger = INFO,MAIL
log4j.appender.MAIL = org.apache.log4j.net.SMTPAppender
log4j.appender.MAIL.Threshold = INFO
log4j.appender.MAIL.BufferSize = 10
log4j.appender.MAIL.From = [e-mail]
log4j.appender.MAIL.SMTPHost = smtp.gmail.com
log4j.appender.MAIL.Subject = Log4J Message
log4j.appender.MAIL.To = [e-mail]
log4j.appender.MAIL.layout = org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern =%d - %c -%-4r [%t] %-5p %c %x - %m %n

#数据库：JDBCAppender
log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.DATABASE.URL = jdbc:oracle:thin:@ 210.51 . 173.94 : 1521 :YDB
log4j.appender.DATABASE.driver = oracle.jdbc.driver.OracleDriver
log4j.appender.DATABASE.user = ydbuser
log4j.appender.DATABASE.password = ydbuser
log4j.appender.DATABASE.sql = INSERT INTO A1 (TITLE3) VALUES ( ' %d - %c %-5p %c %x - %m%n ' )
log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout
log4j.appender.DATABASE.layout.ConversionPattern =% d -   % c -%- 4r [ % t] %- 5p % c % x -  % m % n
#数据库的链接会有问题，可以重写org.apache.log4j.jdbc.JDBCAppender的getConnection() 使用数据库链接池去得链接，可以避免insert一条就链接一次数据库

Log4j自定义Appender介绍
 一，Log4j主要有三个组件：

·Logger：负责供客户端代码调用，执行debug(Object msg)、info(Object msg)、warn(Object msg)、error(Object msg)等方法。

·Appender：负责日志的输出，Log4j已经实现了多种不同目标的输出方式，可以向文件输出日志、向控制台输出日志、向Socket输出日志等。

·Layout：负责日志信息的格式化。

二，执行顺序及关系 

·调用Log4j输出日志时，调用各个组件的顺序:

·1、日志信息传入 Logger。

·2、将日志信息封装成 LoggingEvent 对象并传入 Appender。

·3、在 Appender 中调用 Filter 对日志信息进行过滤，调用 Layout 对日志信息进行格式化，然后输出。

三，实现自定义log4j  Appender 

明白了log4j的结构关系实现自定义的log4j appender就迎刃而解了 

继承log4j公共的基类：AppenderSkeleton 

打印日志核心方法：abstract protected void append(LoggingEvent event); 

初始化加载资源：public void activateOptions()，默认实现为空 

释放资源：public void close() 

是否需要按格式输出文本：public boolean requiresLayout() 

正常情况下我们只需要覆盖append方法即可。然后就可以在log4j中使用了 

四：demo代码： 

import org.apache.log4j.AppenderSkeleton;  

import org.apache.log4j.spi.LoggingEvent;   

public class HelloAppender extends AppenderSkeleton {  

   private String account ;  

  @Override  

  protected void append(LoggingEvent event) {  

               System.out.println("Hello, " + account + " : "+ event.getMessage());  

  }  

    @Override  

   public void close() {  

   }  

  @Override  

 public boolean requiresLayout() {  

      return false;  

    }  

   public String getAccount() {  

       return account;  

    }  

   public void setAccount(String account) {  

       this.account = account;  

   }  

}  

Java代码  

public static void main(String[] args) {  

  Log log = LogFactory.getLog("helloLog") ;  

  log.info("I am ready.") ;  

}  

 

引用

log4j.properties 配置 

log4j.logger.helloLog=INFO, hello 

log4j.appender.hello=HelloAppender 

log4j.appender.hello.account=World

执行main函数，输出结果 

Hello, World : I am ready.  

 

 

 

JAVASE中：
public class TestLog4j { 
   public static void main(String[] args) { 
            PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " ); 
            Logger logger = Logger.getLogger(TestLog4j. class ); 
            logger.debug( " debug " ); 
            logger.error( " error " ); 
        } 
}

运行一下，看看异常信息是不是保存在了一个单独的文件error.log中 

 

 最后感谢许多网友写的文档，我只是做了总结，如果有问题可与我联系qq：1096392534

 附上apache-log4j.jar ，http://download.csdn.net/detail/gudu1289/9134157

参考资料：

http://www.jb51.net/article/16394.htm

http://gemantic.iteye.com/blog/1234996

http://blog.sina.com.cn/s/blog_520998920100af7h.html

http://elf8848.iteye.com/blog/2008595

http://blog.csdn.net/duming88888/article/details/6647470等。