zoukankan      html  css  js  c++  java

  • log4j 总结 精华

    去年这个时候，为做软件工程的大作业就详细学过Log4J的用法了，时隔一年想要在新的项目中好好使用一下的时候，发现几乎全忘了，悲催啊……

    再上网查资料，总是不能找到一篇符合我的口味，拿来就能轻松上手，方便查阅的文章。看了几篇网文以及Apache的官方文档，耐心的总结了一下，贴出来分享，也方便自己以后查阅！

    着急的话，可以直接从第8部分配置文件示例中截取一段配置文件拿去用就好啦~（可能还需要看一眼第7部分回顾一下基本使用方法。）

    log4j主要由三大组件组成：loggers，appenders和layouts。

    1.      定义日志组件logger

    每个logger都可以拥有一个或者多个appender，每个appender表示一个日志的输出目的地，比如console或者某个文件。

    配置root Logger的语法为：

    log4j.rootLogger=[priority],appenderName,appenderName,...-

    配置自定义Logger组件的语法为：

    log4j.logger.loggerName=[priority],appenderName,appenderName,...-

    log4j.rootLogger=INFO,stdout , R

    此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码，可以任意起名。

    日志等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息。

    默认情况下，logger的additive标志被设置为true，表示未被分配level的logger将继承离他最近的父logger的所有appenders。该选项可以被重新设置，表示子logger将不再继承父logger的appenders。

    log4j.logger.myLogger=WARN-

    自定义了一个Logger组件，名称为myLogger，日志级别为WARN。

    2.      配置输出目的地appender

    appender的任务是把layout格式化好的输出内容送往指定的目的地。每个appender都和一个layout相联系；layout的任务是格式化用户的logging request。

    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有特定的配置选项；具体可参照本文最后的示例，或查看官方文档。

    3.      指定layout类型

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

    4.      具体格式

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

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

    l   [QC]是log信息的开头，可以为任意字符，例如项目简称。

    l   %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,

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

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

    l   %c: 输出日志信息所属的类目，通常就是所在类的全名

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

    l   %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)

    l   %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

    l   %%: 输出一个"%"字符

    l   %F: 输出日志消息产生时所在的文件名称

    l   %L: 输出代码中的行号

    l   %m: 输出代码中指定的消息,产生的日志具体信息

    l   %n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

    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字符，就从左边较远输出的字符截掉。

    5.      继承关系

    Log4J提供了一个root Logger，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用，通过Logger.getRootLogger()方法取得它。

    可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如：-

       log4j.apache.myLogger=WARN-

       log4j.apache.myLogger.mySonLogger=,file-

    以上代码中, mySonLogger是myLogger的子类Logger组件。

    6.      以包为单位指定日志等级

    log4j.logger.com.neareast =DEBUG

    log4j.logger.org.apache.struts=WARN

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

    指定struts 包下的所有类的等级为WARN。

    7.       基本使用方法

    通常会见到两种使用方法：

    1、使用org.apache.commons.logging.Log类：

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

    2、直接使用log4j的Logger类：

    获得rootLogger：Logger rootLogger=Logger.getRootLogger();-

    获得自定义Logger：Logger myLogger =Logger.getLogger("log4j.logger.myLogger");-

    Logger由一个String类的名字识别，根logger(root logger)是所有logger的祖先，它具有如下属性：1)它总是存在的；2)它不可以通过名字获得。

    public staticLogger Logger.getLogger(Class clazz)相当于调用Logger.getLogger(clazz.getName())，该方法被认为是目前所知的最理智的命名logger的方法。

    两种方法的区别：

    LogFactory来自common-logging包。如果用LogFactory.getLog:

    优点：你可以用任何实现了通用日志接口的日志记录器替换log4j，而程序不受影响。

    缺点：需要多一个common-logging包，这勉强算一个缺点。

    Logger来自log4j自己的包。如果用Logger.getLogger：

    优点：你只需要一个log4j的jar包。

    缺点：你只能用log4j作为日志记录器，因为log4j已经硬编码进你的系统了。

    apache的common-logging包是通用日志接口，通过这个中间层，你可以通过其配置文件commons-logging.properties，来指定到底用哪个日志系统，以此增加系统的灵活性。

    另：

    为尽可能的提高系统性能，减小不必要的性能损耗，使用类似下面的判断可以在某级别的日志被关闭时，避免隐性的性能损耗（即使不需要输出日志，大量debug等语句的参数处理也需要消耗可观的计算量）：

    [java] view plaincopyprint?
     
    1. if(logger.isDebugEnabled() {  
    2.     logger.debug("Entry number: " + i + " is " +String.valueOf(entry[i]));  
    3. }  

    要将异常信息写入日志，使用e.getMessage()方法并不能得到正确的异常栈。要输出完整的异常栈，可以定义一个getTrace方法，然后使用logger.debug(getTrace(e))来记录日志；getTrace方法定义如下：

    [java] view plaincopyprint?
     
    1. public String getTrace(Throwable t) {  
    2.     StringWriter stringWriter= new StringWriter();  
    3.     PrintWriter writer= new PrintWriter(stringWriter);  
    4.     t.printStackTrace(writer);  
    5.     StringBuffer buffer= stringWriter.getBuffer();  
    6.     return buffer.toString();  
    7. }  



    

    8.       配置文件示例
    

    

    

    [plain] view plaincopyprint?

     
    

    

    

      

    1. log4j.rootLogger=DEBUG,CONSOLE,DATABASE,FILE,ROLLING_FILE  
      2. 

    2. #log4j.logger.cn.com.cnpc.backGroundServer.component.messageComponent=DEBUG,CONSOLE,FILE,ROLLING_FILE  
      3. 

    3. #children-logger是否使用 rootLogger的配置  
      4. 

    4. log4j.additivity.org.apache=false  
      5. 

    5.   
      6. 

    6. # 应用于控制台  
      7. 

    7. log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender  
      8. 

    8. log4j.appender.CONSOLE.Target=System.out  
      9. 

    9. log4j.appender.CONSOLE.encoding=utf-8  
      10. 

    10. log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout  
      11. 

    11. log4j.appender.CONSOLE.layout.ConversionPattern=[%-5p]%l - %m%n  
      12. 

    12.   
      13. 

    13. #应用于文件  
      14. 

    14. log4j.appender.FILE=org.apache.log4j.FileAppender  
      15. 

    15. log4j.appender.FILE.File=E:/work/logs/OfflineMap.log  
      16. 

    16. log4j.appender.FILE.Append=false  
      17. 

    17. log4j.appender.FILE.encoding=utf-8  
      18. 

    18. log4j.appender.FILE.layout=org.apache.log4j.PatternLayout  
      19. 

    19. log4j.appender.FILE.layout.ConversionPattern=%d-%-4r [%t]%-5p%l %x- %m%n  
      20. 

    20.   
      21. 

    21. # 应用于文件回滚  
      22. 

    22. log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender  
      23. 

    23. log4j.appender.ROLLING_FILE.File=E:/work/logs/OfflineMap.r.log  
      24. 

    24. log4j.appender.ROLLING_FILE.Threshold=INFO  
      25. 

    25. log4j.appender.ROLLING_FILE.Append=true  
      26. 

    26. log4j.appender.ROLLING_FILE.Encoding=utf-8  
      27. 

    27. log4j.appender.ROLLING_FILE.MaxFileSize=10240KB  
      28. 

    28. log4j.appender.ROLLING_FILE.MaxBackupIndex=10  
      29. 

    29. log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout  
      30. 

    30. log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r[%t] %-5p %c %x - %m%n  
      31. 

    31.   
      32. 

    32. # 每天新建日志  
      33. 

    33. log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender  
      34. 

    34. log4j.appender.A1.File=C:/log4j/log  
      35. 

    35. log4j.appender.A1.Encoding=GBK  
      36. 

    36. log4j.appender.A1.Threshold=DEBUG  
      37. 

    37. log4j.appender.A1.DatePattern='.'yyyy-MM-dd  
      38. 

    38. log4j.appender.A1.layout=org.apache.log4j.PatternLayout  
      39. 

    39. log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L : %m%n  
      40. 

    40.   
      41. 

    41. # 用于数据库  
      42. 

    42. log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender  
      43. 

    43. log4j.appender.DATABASE.URL=jdbc:oracle:thin:@90.0.12.20:1521:ORCL  
      44. 

    44. log4j.appender.DATABASE.driver=oracle.jdbc.driver.OracleDriver  
      45. 

    45. log4j.appender.DATABASE.user=Nation  
      46. 

    46. log4j.appender.DATABASE.password=1  
      47. 

    47. log4j.appender.CONSOLE.Threshold=WARN  
      48. 

    48. log4j.appender.DATABASE.sql=INSERT INTO LOG4J(stamp,thread,infolevel,class,messages) VALUES ('%d{yyyy-MM-dd HH:mm:ss}', '%t', '%p', '%l','%m')  
      49. 

    49. # INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c%x - %m%n')  
      50. 

    50. # 写入数据库中的表LOG4J的Message字段中，内容％d（日期）%c:日志信息所在地（类名）%p:日志信息级别%m: 产生的日志具体信息 %n: 输出日志信息换行  
      51. 

    51. log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout  
      52. 

    52. log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t]%-5p %c %x - %m%n  
      53. 

    53.   
      54. 

    54. #自定义Appender  
      55. 

    55. log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender  
      56. 

    56. log4j.appender.im.host = mail.cybercorlin.net  
      57. 

    57. log4j.appender.im.username = username  
      58. 

    58. log4j.appender.im.password = password  
      59. 

    59. log4j.appender.im.recipient = corlin@cybercorlin.net  
      60. 

    60. log4j.appender.im.layout=org.apache.log4j.PatternLayout  
      61. 

    61. log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p%c %x - %m%n  
      62. 

    62.   
      63. 

    63. #应用于socket  
      64. 

    64. log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender  
      65. 

    65. log4j.appender.SOCKET.RemoteHost=localhost  
      66. 

    66. log4j.appender.SOCKET.Port=5001  
      67. 

    67. log4j.appender.SOCKET.LocationInfo=true  
      68. 

    68. log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout  
      69. 

    69. log4j.appender.SOCKET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n  
      70. 

    70.   
      71. 

    71. #LogFactor 5 Appender  
      72. 

    72. log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender  
      73. 

    73. log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000  
      74. 

    74. log4j.appender.LF5_APPENDER.layout=org.apache.log4j.PatternLayout  
      75. 

    75. log4j.appender.LF5_APPENDER.layout.ConversionPattern =[framework] %d - %c -%-4r[%t] %-5p %c %x - %m%n  
      76. 

    76.   
      77. 

    77. #发送日志给邮件  
      78. 

    78. log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender  
      79. 

    79. log4j.appender.MAIL.Threshold=FATAL  
      80. 

    80. log4j.appender.MAIL.BufferSize=10  
      81. 

    81. log4j.appender.MAIL.From=web@www.wuset.com  
      82. 

    82. log4j.appender.MAIL.SMTPHost=www.wusetu.com  
      83. 

    83. log4j.appender.MAIL.Subject=Log4J Message  
      84. 

    84. log4j.appender.MAIL.To=web@www.wusetu.com  
      85. 

    85. log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout  
      86. 

    86. log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t]%-5p %c %x - %m%n  
      87. 

    

    

    
    
                
    
                
              
    • 
              
    
              
  • 

                相关阅读:
    
                
                  前端事件系统（四）
                    
    前端事件系统（三）
                    
    前端事件系统（二）
                    
    前端事件系统（一）
                    
    前端图片选择问题
                    
    浅谈前端移动端页面开发（布局篇）
                    
    诙谐论设计模式（一）——创建型设计模式
                    
    总结三年未满的工作经历，写下自己对技术的坚持
                    
    java内存优化牛刀小试
                    
    将上下文融入知识图谱以进行常识推理
                    
                        
              
    • 
              
    
              
  • 
                原文地址：https://www.cnblogs.com/Struts-pring/p/3955823.html
              
    • 

            

          



          
          

            

            

          

        

      

      



      

      

        

          Copyright © 2011-2022 走看看