Log4j.properties配置详解加示例

た入场券 2022-08-19 00:26 101阅读 0赞

## 一.基本知识介绍 ##

Log4j有三个主要的组件：Loggers(记录器)，Appenders (输出源)和Layouts(布局)。这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。综合使用这三个组件可以轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。  
**1. Loggers组件**

在此系统中被分为五个级别：**DEBUG、INFO、WARN、ERROR和FATAL**。  
ERROR ：为严重错误 主要是程序的错误  
WARN ：为一般警告，比如session丢失  
INFO ：为一般要显示的信息，比如登录登出  
DEBUG： 为程序的调试信息

这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL，分别用来指定这条日志信息的重要程度，明白这一点很重要，Log4j有一个规则：只输出级别不低于设定级别的日志信息，假设Loggers级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

**2.Appenders**

禁用和使用日志请求只是Log4j的基本功能，Log4j日志系统还提供许多强大的功能，比如允许把日志输出到不同的地方，如控制台（Console）、文件（Files）等，可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其它地方等等。  
配置日志信息输出目的地  
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（将日志信息以流格式发送到任意指定的地方）

**3、Layouts**

有时用户希望根据自己的喜好格式化自己的日志输出，Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供四种日志输出样式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。

常使用的类如下：

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

## 二、配置详解 ##

**1. 配置过程**

1） 在应用程序中使用log4j  
　　2) 把log4j-\*.\*jar放入CLASSPATH变量中  
　　3) 新建一个配置文件log4j.properties，放于bin文件下  
　　  
**2. 示例，新建一个配置文件log4j.properties**

log4j.rootLogger=DEBUG, stdout, logfile,ERROR
    //配置根Logger：设定日志记录的最低级别，
    log4j.category.org.springframework=ERROR
    log4j.category.org.apache=INFO
    log4j.logger.org.hibernate=ERROR 
    
    //输出到控制台
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.Threshold=ERROR
    //：指定日志信息的最低输出级别，默认为DEBUG。
    log4j.appender.stdout.ImmediateFlush=true
    //表示所有消息都会被立即输出，设为false则不输出，默认值是true。
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    //可以灵活自定义布局模式
    log4j.appender.stdout.Target=System.out 
    //默认值是System.out。
    log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{
       1}:%L - %m%n   
    //设定以怎样的格式显示消息
    
    //文件大小到达指定尺寸的时候产生一个新的文件
    log4j.appender.logfile=org.apache.log4j.RollingFileAppender
    log4j.appender.logfile.File=D:\workspace\TestDemo\src\logging.log4j 
    //日志的输出文件所在目录
    log4j.appender.logfile.Append=false：
    //true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
    log4j.appender.logfile.Threshold=DEBUG
    log4j.appender.logfile.MaxFileSize=100KB
    //后缀可以是KB, MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件中。
    log4j.appender.logfile.MaxBackupIndex=2
    //指定可以产生的滚动文件的最大数，例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件。
    log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
    log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n
    
    //每天产生一个日志文件
    log4j.appender.DAILY=org.apache.log4j.DailyRollingFileAppender
    log4j.appender.DAILY.Threshold=DEBUG
    log4j.appender.DAILY.File=D:\workspace\TestDemo\src\logging.log4j 
    log4j.appender.DAILY.Append=true
    log4j.appender.DAILY.DatePattern='_'yyyy-MM-dd'.txt'
    //每天滚动一次日志文件，即每天产生一个新的日志文件。当天的日志文件名为logging.log4j，前一个天的日志文件名为logging.log4j.yyyy-MM-dd。
    log4j.appender.DAILY.layout=org.apache.log4j.PatternLayout
    log4j.appender.RollingFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{
       1}:%L - %m%n

## 三．附加内容 ##

**1. 日期设定：**

log4j.appender.DAILY.DatePattern=’\_’yyyy-MM-dd’.txt’每天滚动一次日志文件，即每天产生一个新的日志文件。当天的日志文件名为logging.log4j，前一个天的日志文件名为logging.log4j.yyyy-MM-dd。  
另外，也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：  
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：每分钟

**2..日志信息格式中几个符号所代表的含义：**

\-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”输出日志信息换行

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

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