Log4j框架配置文件log4j.properties配置使用详解

╰半夏微凉° 2023-10-11 09:18 24阅读 0赞

### 一.Log4j的配置文件分类 ###

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties（key=value）文件，其中properties格式的配置文件最为常用，其有一个固定的文件名log4j.properties，下面我们介绍使用properties文件做为配置文件的方法：

### 二.log4j.properties配置文件详解 ###

上一篇文章中曾指出Log4j框架主要的工作内容围绕着三个功能：

产生日志信息  
将日志信息输出到指定位置  
调整输出样式  
而Log4j的配置文件主要就是对这三种功能的实现方式进行设置

### 1.配置rootLogger ###

**rootLogger的配置方式：**

> `log4j.rootLogger = level,appenderName1,appenderName2, .....`

**rootLogger的配置详解**

level是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别，默认优先级：ALL < DEBUG < INFO <WARN < ERROR < FATAL < OFF

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

appenderName是日志信息输出位置，可以同时指定多个输出目的地

#### 2.配置日志信息输出目的地Appender ####

**Appender的配置方式：**

log4j.appender.appenderName = Log4j提供的appender类
    log4j.appender.appenderName.属性名 = 属性值
    .....
    log4j.appender.appenderName.属性名 = 属性值

**Appender的配置详解**  
Log4j提供的appender有以下5种，分别可以将日志信息输出到5个不同的平台

org.apache.log4j.ConsoleAppender（控制台）
    org.apache.log4j.FileAppender（文件）
    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
    org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

**ConsoleAppender**  
Threshold=WARN：指定日志消息的输出最低层次。  
ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。  
Target=System.err：默认情况下是：System.out,指定输出控制台

**FileAppender**  
Threshold=WARN：指定日志消息的输出最低层次。  
ImmediateFlush=true：默认值是true,意谓着所有的消息都会被立即输出。  
File=mylog.txt：指定消息输出到mylog.txt文件。  
Append=false：默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。  
**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: 每分钟

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

#### 3.配置日志信息的格式（布局） ####

**日志信息格式的配置方式：**

log4j.appender.appenderName.layout = Log4j提供的layout类
    log4j.appender.appenderName.layout.属性 = 值
    .....
    log4j.appender.appenderName.layout.属性 = 值

**日志信息格式的配置详解**  
Log4j提供的layout有以下几种：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

**HTMLLayout**  
LocationInfo=true：默认值是false,输出java文件名称和行号  
Title=my app file：默认值是 Log4J Log Messages

**PatternLayout**  
ConversionPattern=%m%n：指定怎样格式化指定的消息。

**XMLLayout**  
LocationInfo=true：默认值是false,输出java文件和行号  
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：

og4j.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平台为”\\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字符，就从左边交远销出的字符截掉

#### 三.log4j.properties配置文件案例 ####

根据上文对配置文件的分析，下面给出一个具体的log4j.properties配置文件，完整的进行了各个方面的配置：

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 从入门到详解
    10
    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\u8b
    ef
    #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 从入门到详解
    11
    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 = yourmail@gmail.com
    log4j.appender.MAIL.SMTPHost = smtp.gmail.com
    log4j.appender.MAIL.Subject = Log4J Message
    log4j.appender.MAIL.To = yourmail@gmail.com
    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 一条就链接一次数据库