log4j使用及详细配置说明

一、首先简单介绍log4j的使用步骤


  整体上分为如下几个步骤:1、引入log4j-*.*jar,的Jar包;2、添加配置文件(log4j.xml或log4j.properties);3、包装log工具类在业务中使用。此为传统的使用步骤,不过我们可以直接用lombok包装好的log工具类,具体步骤:


1.1  引入jar包

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.6</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.6</version>
        </dependency>

1.2  添加配置文件


  配置文件我们可以用log4j.xml或log4j.properties,如果二者都存在,默认加载的是log4j.xml配置。直接将配置文件添加到类路径(例如resources路径)下面即可。


  log4j.xml示例一:

<?xml version="1.0" encoding="GBK" ?>    
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">    
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">      
    <!-- 输出日志到控制台  ConsoleAppender -->   
        <appender name="console" class="org.apache.log4j.ConsoleAppender">  
        <param name="Threshold" value="info"></param>  
        <layout class="org.apache.log4j.TTCCLayout">  
            <param name="ConversionPattern" value="TTCCLayout"></param>  
        </layout>  
    </appender>  
  
    <!-- 输出日志到文件  每天一个文件 -->  
    <appender name="dailyRollingFile" class="org.apache.log4j.DailyRollingFileAppender">  
        <param name="Threshold" value="info"></param>  
        <param name="ImmediateFlush" value="true"></param>  
        <param name="File" value="c:/logs/dailyRollingFile.log"></param>  
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'"></param>  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>  
        </layout>  
    </appender>   
      
    <!-- 输出日志到文件  文件大小到达指定尺寸的时候产生一个新的文件 -->  
    <appender name="railyFile"  class="org.apache.log4j.RollingFileAppender">  
        <param name="File" value="c:/logs/railyFile.log"></param>  
        <param name="ImmediateFlush" value="true"/>  
        <param name="Threshold" value="info"></param>  
        <param name="Append" value="true"></param>  
        <param name="MaxFileSize" value="30KB"></param>  
        <param name="MaxBackupIndex" value="100"></param>  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>  
        </layout>  
    </appender>  
  
    <!-- 输出日志到文件 -->  
    <appender name="file" class="org.apache.log4j.FileAppender">  
        <param name="File" value="c:/logs/file.log"></param>  
        <param name="Threshold" value="info"></param>  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss\} %-5p] [%t] {%c:%L}-%m%n"></param>  
        </layout>  
    </appender>  
  
    <!--   
        定义全局的日志输出级别,但是在输出目的地的配置中配置的具体输出级别优先级高于全局定义的优先级。  
        如果在railyFile中定义<param name="Threshold" value="info"></param>,那么将会把info以上级别的信息输出  
     -->  
    <root>       
        <priority value="debug" />       
        <appender-ref ref="console" />    
        <appender-ref ref="dailyRollingFile" />    
        <appender-ref ref="railyFile" />    
        <appender-ref ref="file" />    
    </root>         
  
</log4j:configuration>   


  log4j.xml示例二:(可以将控制台warn/error级别的日志打印成红色以区分info级别)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>

    <!-- warn,error,fatal级别以红色显示。debug,info, 默认的颜色-->
    <appender name="console-warn" class="org.apache.log4j.ConsoleAppender">
        <param name="target" value="System.err"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p] [%t] %c{2\} %L - %m%n"/>
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="levelMin" value="warn"/>
            <param name="levelMax" value="fatal"/>
            <param name="AcceptOnMatch" value="false"/>
        </filter>
    </appender>
    <appender name="console-info" class="org.apache.log4j.ConsoleAppender">
        <param name="target" value="System.out"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p] [%t] %c{2\} %L - %m%n"/>
        </layout>
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="levelMin" value="debug"/>
            <param name="levelMax" value="info"/>
            <param name="AcceptOnMatch" value="false"/>
        </filter>
    </appender>

    <appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="../log/tacserviceprovider/tacserviceprovider.log"/>
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="[%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p] [%t] %c{2\} %L - %m%n"/>
        </layout>
    </appender>

    <root>
        <priority value="debug"/>
        <appender-ref ref="console-warn"/>
        <appender-ref ref="console-info"/>
        <appender-ref ref="activexAppender"/>
    </root>
</log4j:configuration>


  log4j.properties示例一:

#配置全局日志级别,与输出位置项
log4j.rootLogger=info, console, rollingFile
#控制台日志配置项
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d [%t] %-5p %c --- %m%n
#RollingFile日志配置项
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.File=example.log
log4j.appender.rollingFile.MaxFileSize=100KB
log4j.appender.rollingFile.MaxBackupIndex=1
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=%p %t %c - %m%n
#指定特定包下的日志级别
log4j.logger.com.acfun=WARN
  


  log4j.properties示例二:(最全配置,可以从中提取所需部分)

#OFF,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB,ALL 
log4j.rootLogger =ALL,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB 

#输出到控制台 
log4j.appender.systemOut = org.apache.log4j.ConsoleAppender 
log4j.appender.systemOut.layout = org.apache.log4j.PatternLayout 
log4j.appender.systemOut.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
log4j.appender.systemOut.Threshold = DEBUG 
log4j.appender.systemOut.ImmediateFlush = TRUE 
log4j.appender.systemOut.Target = System.out 

#输出到文件 
log4j.appender.logFile = org.apache.log4j.FileAppender 
log4j.appender.logFile.layout = org.apache.log4j.PatternLayout 
log4j.appender.logFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
log4j.appender.logFile.Threshold = DEBUG 
log4j.appender.logFile.ImmediateFlush = TRUE 
log4j.appender.logFile.Append = TRUE 
log4j.appender.logFile.File = ../Struts2/WebRoot/log/File/log4j_Struts.log 
log4j.appender.logFile.Encoding = UTF-8 

#按DatePattern输出到文件 
log4j.appender.logDailyFile = org.apache.log4j.DailyRollingFileAppender 
log4j.appender.logDailyFile.layout = org.apache.log4j.PatternLayout 
log4j.appender.logDailyFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
log4j.appender.logDailyFile.Threshold = DEBUG 
log4j.appender.logDailyFile.ImmediateFlush = TRUE 
log4j.appender.logDailyFile.Append = TRUE 
log4j.appender.logDailyFile.File = ../Struts2/WebRoot/log/DailyFile/log4j_Struts 
log4j.appender.logDailyFile.DatePattern = '.'yyyy-MM-dd-HH-mm'.log' 
log4j.appender.logDailyFile.Encoding = UTF-8 

#设定文件大小输出到文件 
log4j.appender.logRollingFile = org.apache.log4j.RollingFileAppender 
log4j.appender.logRollingFile.layout = org.apache.log4j.PatternLayout 
log4j.appender.logRollingFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
log4j.appender.logRollingFile.Threshold = DEBUG 
log4j.appender.logRollingFile.ImmediateFlush = TRUE 
log4j.appender.logRollingFile.Append = TRUE 
log4j.appender.logRollingFile.File = ../Struts2/WebRoot/log/RollingFile/log4j_Struts.log 
log4j.appender.logRollingFile.MaxFileSize = 1MB 
log4j.appender.logRollingFile.MaxBackupIndex = 10 
log4j.appender.logRollingFile.Encoding = UTF-8 

#用Email发送日志 
log4j.appender.logMail = org.apache.log4j.NET.SMTPAppender 
log4j.appender.logMail.layout = org.apache.log4j.HTMLLayout 
log4j.appender.logMail.layout.LocationInfo = TRUE 
log4j.appender.logMail.layout.Title = Struts2 Mail LogFile 
log4j.appender.logMail.Threshold = DEBUG 
log4j.appender.logMail.SMTPDebug = FALSE 
log4j.appender.logMail.SMTPHost = SMTP.163.com 
log4j.appender.logMail.From = xly3000@163.com 
log4j.appender.logMail.To = xly3000@gmail.com 
#log4j.appender.logMail.Cc = xly3000@gmail.com 
#log4j.appender.logMail.Bcc = xly3000@gmail.com 
log4j.appender.logMail.SMTPUsername = xly3000 
log4j.appender.logMail.SMTPPassword = 1234567 
log4j.appender.logMail.Subject = Log4j Log Messages 
#log4j.appender.logMail.BufferSize = 1024 
#log4j.appender.logMail.SMTPAuth = TRUE 

#将日志登录到MySQL数据库 
log4j.appender.logDB = org.apache.log4j.jdbc.JDBCAppender 
log4j.appender.logDB.layout = org.apache.log4j.PatternLayout 
log4j.appender.logDB.Driver = com.mysql.jdbc.Driver 
log4j.appender.logDB.URL = jdbc:mysql://127.0.0.1:3306/xly 
log4j.appender.logDB.User = root 
log4j.appender.logDB.Password = 123456 
log4j.appender.logDB.Sql = INSERT INTOT_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('Struts2','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')


1.3  使用log4j


  由于我们结合了lombok,因此我们可以直接使用它包装好的log工具了。只需要在类上面打上注解 ”@Slf4j”,然后就可以在类中使用log.info(““)等了。

实例:

import lombok.extern.slf4j.Slf4j;

/**
 * Created by wangzhipeng on 2017/6/11.
 */
@Slf4j
public class TestLog4j {
  public static void main(String[] args) {
    log.info("hello world");
  }
}

 

二、重点讲解log4j配置中各个项的含义



2.1  先来一份主要配置项说明


  1、配置根Logger


    语法:log4j.rootLogger = [ level ] , appenderName1, appenderName2,… 

    level: 定义全局的日志输出级别,但是在输出目的地的配置中配置的具体输出级别优先级高于全局定义的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

    appenderName: 就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。例如:log4j.rootLogger=info,A1,B2,C3 


  2、输出级别的种类


    OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE 、ALL 

    OFF 为最高等级 关闭了日志信息 

    FATAL  为可能导致应用中止的严重事件错误 

    ERROR 为严重错误 主要是程序的错误 

    WARN 为一般警告,比如session丢失 

    INFO 为一般要显示的信息,比如登录登出 

    DEBUG 为程序的调试信息 

    TRACE 为比DEBUG更细粒度的事件信息 

    ALL 为最低等级,将打开所有级别的日志


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


    log4j.appender.appenderName = 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(将日志信息以流格式发送到任意指定的地方)

 

  4、配置日志信息的格式


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

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

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

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

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

 

  5、控制台选项


    Threshold=DEBUG:指定日志消息的输出最低层次。

    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

    Target=System.err:默认情况下是:System.out,指定输出控制台

    FileAppender 选项

    Threshold=DEBUF:指定日志消息的输出最低层次。

    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

    File=mylog.txt:指定消息输出到mylog.txt文件。

    Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。

    RollingFileAppender 选项

    Threshold=DEBUG:指定日志消息的输出最低层次。

    ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

    File=mylog.txt:指定消息输出到mylog.txt文件。

    Append=false:默认值是true,即将消息增加到指定文件中,false指将消息覆盖指定的文件内容。

    MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到mylog.log.1文件。

    MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

    log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-ddHH:mm:ssS} %c %m%n

 

  6、日志信息格式中几个符号所代表的含义:


      -X号: X信息输出时左对齐;

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

      %d: 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyMMM 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"输出日志信息换行

 

    可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。

    如:

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

 


2.2  再来一份全面的配置说明(如果上面主要配置项没有你需要的可以看下面的说明)


################################################################################ 
#
①配置根Logger,其语法为: 

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

#log4j.appender.appenderName = fully.qualified.name.of.appender.class 
#log4j.appender.appenderName.optionN = valueN 

#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(
将日志信息以流格式发送到任意指定的地方

#1)ConsoleAppender
选项属性 
# -Threshold = DEBUG:
指定日志消息的输出最低层次 
# -ImmediateFlush = TRUE:
默认值是true,所有的消息都会被立即输出 
# -Target = System.err:
默认值System.out,输出到控制台(err为红色,out为黑色

#2)FileAppender
选项属性 
# -Threshold = INFO:
指定日志消息的输出最低层次 
# -ImmediateFlush = TRUE:
默认值是true,所有的消息都会被立即输出 
# -File = C:\log4j.log:
指定消息输出到C:\log4j.log文件 
# -Append = FALSE:
默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
# -Encoding = UTF-8:
可以指定文件编码格式 
#
 
#3)DailyRollingFileAppender选项属性 
#-Threshold = WARN:指定日志消息的输出最低层次 
#-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
#-File = C:\log4j.log:指定消息输出到C:\log4j.log文件 
#-Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
#-DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。还可以按用以下参数: 
#              '.'yyyy-MM:每月 
#              '.'yyyy-ww:每周 
#              '.'yyyy-MM-dd:每天 
#              '.'yyyy-MM-dd-a:每天两次 
#              '.'yyyy-MM-dd-HH:每小时 
#              '.'yyyy-MM-dd-HH-mm:每分钟 
#-Encoding = UTF-8:可以指定文件编码格式 
# 
#4)RollingFileAppender选项属性 
#-Threshold = ERROR:指定日志消息的输出最低层次 
#-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
#-File = C:/log4j.log:指定消息输出到C:/log4j.log文件 
#-Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
#-MaxFileSize = 100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动.:log4j.log.1 
#-MaxBackupIndex = 2:指定可以产生的滚动文件的最大数 
#-Encoding = UTF-8:可以指定文件编码格式 
################################################################################ 
################################################################################ 
#③配置日志信息的格式(布局),其语法为: 
# 
#log4j.appender.appenderName.layout= fully.qualified.name.of.layout.class 
#log4j.appender.appenderName.layout.optionN= valueN 
# 
#Log4j提供的layout有以下几种: 
#5)org.apache.log4j.HTMLLayout(HTML表格形式布局) 
#6)org.apache.log4j.PatternLayout(可以灵活地指定布局模式) 
#7)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串) 
#8)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息) 
#9)org.apache.log4j.xml.XMLLayout(XML形式布局) 
# 
#5)HTMLLayout选项属性 
#-LocationInfo = TRUE:默认值false,输出Java文件名称和行号 
#-Title=Struts Log Message:默认值 Log4JLog Messages 
# 
#6)PatternLayout选项属性 
#-ConversionPattern = %m%n:格式化指定的消息(参数意思下面有) 
# 
#9)XMLLayout选项属性 
#-LocationInfo = TRUE:默认值false,输出java文件名称和行号 
# 
#Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: 
#%m 输出代码中指定的消息 
#%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL 
#%r 输出自应用启动到输出该log信息耗费的毫秒数 
#%c 输出所属的类目,通常就是所在类的全名 
#%t 输出产生该日志事件的线程名 
#%n 输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n 
#%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式 
#    如:%d{yyyyMMddHH:mm:ss,SSS},输出类似:20120105 22:10:28,921 
#%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数 
#    如:Testlog.main(TestLog.java:10) 
#%F 输出日志消息产生时所在的文件名称 
#%L 输出代码中的行号 
#%x 输出和当前线程相关联的NDC(嵌套诊断环境),javaservlets多客户多线程的应用中 
#%% 输出一个"%"字符 
# 
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如: 
#  %5c: 输出category名称,最小宽度是5category<5,默认的情况下右对齐 
#  %-5c:输出category名称,最小宽度是5category<5"-"号指定左对齐,会有空格 
#  %.5c:输出category名称,最大宽度是5category>5,就会将左边多出的字符截掉,<5不会有空格 
#  %20.30c:category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉 
################################################################################ 
################################################################################ 
#④指定特定包的输出特定的级别 
#log4j.logger.org.springframework=DEBUG 
################################################################################ 

©️2020 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页