开发者社区> zting科技> 正文

log4j 详解

简介:
+关注继续查看
在强调可重用组件开发的今天,除了自己从头到尾开发一个可重用的日志操作类外,Apache为我们提供了一个强有力的日志操作包-Log4j。 

    Log4j是Apache的一个开放源代码项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。 

    此外,通过Log4j其他语言接口,您可以在C、C++、.Net、PL/SQL程序中使用Log4j,其语法和用法与在Java程序中一样,使得多语言分布式系统得到一个统一一致的日志组件模块。而且,通过使用各种第三方扩展,您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

    说明:下面分为三部分,
        第一部分讲解如何配置log4j;
        第二部分为对log4j.properties配置文件中的各个属性的讲解;
        第三部分为对log4j的详细讲解。
    如果只想配置上log4j,那么只需要看前两个部分就可以,如果想对log4j深入了解,则还需看第三部分。

一、Log4j配置
   
    第一步:加入log4j-1.2.8.jar到lib下。

    第二步:在CLASSPATH下建立log4j.properties。内容如下:

        1 log4j.rootCategory=INFO, stdout , R

        2 

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

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

        5 log4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%n

        6 

        7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

        8 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log

        9 log4j.appender.R.layout=org.apache.log4j.PatternLayout

        10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

        11 

        12 log4j.logger.com.neusoft=DEBUG

        13 log4j.logger.com.opensymphony.oscache=ERROR

        14 log4j.logger.net.sf.navigator=ERROR

        15 log4j.logger.org.apache.commons=ERROR

        16 log4j.logger.org.apache.struts=WARN

        17 log4j.logger.org.displaytag=ERROR

        18 log4j.logger.org.springframework=DEBUG

        19 log4j.logger.com.ibatis.db=WARN

        20 log4j.logger.org.apache.velocity=FATAL

        21 

        22 log4j.logger.com.canoo.webtest=WARN

        23 

        24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

        25 log4j.logger.org.hibernate=DEBUG

        26 log4j.logger.org.logicalcobwebs=WARN


    第三步:相应的修改其中属性,修改之前就必须知道这些都是干什么的,在第二部分讲解。

    第四步:在要输出日志的类中加入相关语句:

        定义属性:protected final Log log = LogFactory.getLog(getClass());

        在相应的方法中:

        if (log.isDebugEnabled()){

           log.debug(“System …..”);

        }

二、Log4j说明

    log4j.rootCategory=INFO, stdout , R

    此句为将等级为INFO的日志信息输出到stdout和R这两个目的地,stdout和R的定义在下面的代码,可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL,如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO, WARN, ERROR的log信息,而DEBUG信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。

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

    此句为定义名为stdout的输出端是哪种类型,可以是

    org.apache.log4j.ConsoleAppender(控制台), 

    org.apache.log4j.FileAppender(文件), 

    org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),

    org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)

    org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

    具体讲解可参照第三部分定义配置文件中的Appender。

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

    此句为定义名为stdout的输出端的layout是哪种类型,可以是

    org.apache.log4j.HTMLLayout(以HTML表格形式布局), 

    org.apache.log4j.PatternLayout(可以灵活地指定布局模式), 

    org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串), 

    org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

    具体讲解可参照第三部分定义配置文件中的Layout。

    5 log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n

    如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下:

        %m 输出代码中指定的消息

        %p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL 

        %r 输出自应用启动到输出该log信息耗费的毫秒数 

        %c 输出所属的类目,通常就是所在类的全名 

        %t 输出产生该日志事件的线程名 

        %n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n” 

        %d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921 

        %l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。

        [QC]是log信息的开头,可以为任意字符,一般为项目简称。

        输出的信息
        
        [TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy'

        具体讲解可参照第三部分定义配置文件中的格式化日志信息。

    7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

    此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。

    8 log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log

    此句为定义名为R的输出端的文件名为D:\\Tomcat 5.5\\logs\\qc.log可以自行修改。

    9 log4j.appender.R.layout=org.apache.log4j.PatternLayout

    与第4行相同。

    10 log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

    与第5行相同。

    12 log4j.logger.com. neusoft =DEBUG

    指定com.neusoft包下的所有类的等级为DEBUG。

    可以把com.neusoft改为自己项目所用的包名。

    13 log4j.logger.com.opensymphony.oscache=ERROR

    14 log4j.logger.net.sf.navigator=ERROR

    这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置EHCache,则不需要这两句。

    15 log4j.logger.org.apache.commons=ERROR

    16 log4j.logger.org.apache.struts=WARN

    这两句是struts的包。

    17 log4j.logger.org.displaytag=ERROR

    这句是displaytag的包。(QC问题列表页面所用)

    18 log4j.logger.org.springframework=DEBUG

    此句为Spring的包。

    24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

    25 log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。

三、log4j详解

1、定义配置文件

    Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:

    ①、配置根Logger

    Logger 负责处理日志记录的大部分操作。 

    其语法为:

        log4j.rootLogger = [ level ] , appenderName, appenderName, …

    其中,level 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志,OFF:关闭所有的日志输出。 appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。

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

    Appender 负责控制日志记录操作的输出。 

    其语法为:

    log4j.appender.appenderName = fully.qualified.name.of.appender.class 

    log4j.appender.appenderName.option1 = value1 

    … 

    log4j.appender.appenderName.optionN = valueN 

    这里的appenderName为在①里定义的,可任意起名。

    其中,Log4j提供的appender有以下几种: 

        org.apache.log4j.ConsoleAppender(控制台), 

        org.apache.log4j.FileAppender(文件), 

        org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),

        org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。 

        org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

    例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender

    定义一个名为stdout的输出目的地,ConsoleAppender为控制台。

    ③、配置日志信息的格式(布局)Layout

    Layout 负责格式化Appender的输出。

    其语法为:

    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(包含日志产生的时间、线程、类别等等信息)

2、格式化日志信息

    Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: 

        %m 输出代码中指定的消息

        %p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL 

        %r 输出自应用启动到输出该log信息耗费的毫秒数 

        %c 输出所属的类目,通常就是所在类的全名 

        %t 输出产生该日志事件的线程名 

        %n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n” 

        %d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921 

        %l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。

3、在代码中使用Log4j

    我们在需要输出日志信息的类中做如下的三个工作:

        1、导入所有需的commongs-logging类:

            import org.apache.commons.logging.Log;

            import org.apache.commons.logging.LogFactory;

        2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:

            private final Log log = LogFactory.getLog(getClass());

            LogFactory.getLog()方法的参数使用的是当前类的class。

        3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:

            if (log.isDebugEnabled()){
                log.debug("111");

            }

            if (log.isInfoEnabled()){
                log.info("222");
            }

            if (log.isWarnEnabled()){
                log.warn("333");
            }

            if (log.isErrorEnabled()){
                log.error("444");
            }

            if (log.isFatalEnabled()){
                log.fatal("555")
            } 


总结
将commons-logging和Log4j的jar包都放置到classpath下,同时也将Log4j的配置文件放到classpath中,两者就可以很好的合作。

采用Log4j配合commons-logging作为日志系统,是目前Java领域非常非常流行的模式,使用非常非常的普遍。两者的结合带来的结果就是:简单 + 强大。
commons-logging提供了简捷、统一的接口,不需要额外配置,简单;
Log4j功能非常全面、强大;
commons-logging仅仅对Log4j(当然还包括其它LOG实现)作了一层包装,具体的日志输出还是在内部转交给身后的Log4j来处理;而Log4j虽然做了所有的事情,却甘作绿叶,从不以真身示人。

两者堪称绝配。



本文转自左正博客园博客,原文链接:http://www.cnblogs.com/soundcode/archive/2010/12/20/1911879.html,如需转载请自行联系原作者

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,大概有三种登录方式:
10010 0
使用SSH远程登录阿里云ECS服务器
远程连接服务器以及配置环境
13978 0
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
20692 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,云吞铺子总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系统盘、创建快照、配置安全组等操作如何登录ECS云服务器控制台? 1、先登录到阿里云ECS服务器控制台 2、点击顶部的“控制台” 3、通过左侧栏,切换到“云服务器ECS”即可,如下图所示 通过ECS控制台的远程连接来登录到云服务器 阿里云ECS云服务器自带远程连接功能,使用该功能可以登录到云服务器,简单且方便,如下图:点击“远程连接”,第一次连接会自动生成6位数字密码,输入密码即可登录到云服务器上。
33609 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
18992 0
使用NAT网关轻松为单台云服务器设置多个公网IP
在应用中,有时会遇到用户询问如何使单台云服务器具备多个公网IP的问题。 具体如何操作呢,有了NAT网关这个也不是难题。
35346 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
25237 0
windows server 2008阿里云ECS服务器安全设置
最近我们Sinesafe安全公司在为客户使用阿里云ecs服务器做安全的过程中,发现服务器基础安全性都没有做。为了为站长们提供更加有效的安全基础解决方案,我们Sinesafe将对阿里云服务器win2008 系统进行基础安全部署实战过程! 比较重要的几部分 1.
11861 0
+关注
3550
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
JS零基础入门教程(上册)
立即下载
性能优化方法论
立即下载
手把手学习日志服务SLS,云启实验室实战指南
立即下载