log4j配置详解

今天药忘吃喽~ 2023-07-16 03:54 21阅读 0赞

## Log4j ##

apache推出开源免费的日志处理类库  
在项目发布后，无控制台，不易观察一些输出结果  
作用：不仅能把内容输出到控制台，还能把内容输出到文件，便于观察结果

## 使用 ##

①导入jar包  
②在src下新建log4J.properties（路径和名称都不允许改变）  
Ps：此处主要说明的是properties配置文件的相关配置

## 具体配置 ##

#### 输出级别 ####

主要使用的级别一共有七种，只建议使用四种：  
error（错误）> warn（警告）> info（普通信息）> debug（调试信息）

#### 元素及配置步骤 ####

①根  
可声明全局输出级别和输出方向  
如：log4j.rootCategory=ERROR,CONSOLE,LOGFILE  
全局输出级别为：ERROR  
定义了两个方向：CONSOLE，LOGFILE可在之后进行详细配置

②特定输出级别  
使用：log4j.logger.包名 = 输出级别  
可专门设置对于某个包具体的输出级别，此时可将全局输出级别设置到较高，专门对某个包的信息做记录

③具体输出方向的配置  
默认有五个方向：

<table> 
 <thead> 
  <tr> 
   <th>配置名</th> 
   <th>输出方向</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>org.apache.log4j.ConsoleAppender</td> 
   <td>控制台</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.FileAppender</td> 
   <td>文件</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.DailyRollingFileAppender</td> 
   <td>每天产生一个日志文件</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.RollingFileAppender</td> 
   <td>文件大小溢出时产生新的文件</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.WriterAppender</td> 
   <td>将日志以流格式发送到指定的地方</td> 
  </tr> 
 </tbody> 
</table>

此处需使用在根中所声明的输出方向：  
如：log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender  
设置CONSOLE的输出方向CONSOLE

④声明输出方向后需指定的属性  
**目标为控制台需指定的属性**：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>log4j.appender.CONSOLE.Threshold</td> 
   <td>设置该方向的输出级别</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.CONSOLE.layout</td> 
   <td>设置输出时的格式</td> 
  </tr> 
 </tbody> 
</table>

Tips：对于输出时的格式一共有四种

<table> 
 <thead> 
  <tr> 
   <th>选项</th> 
   <th>格式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>org.apache.log4j.HTMLLayout</td> 
   <td>以HTML表格形式布局</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.PatternLayout</td> 
   <td>可以自定义布局模式</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.SimpleLayout</td> 
   <td>包含日志的级别和信息字符串</td> 
  </tr> 
  <tr> 
   <td>org.apache.log4j.TTCCLayout</td> 
   <td>包含日志产生的时间、线程、类别等</td> 
  </tr> 
 </tbody> 
</table>

Ps：若是选择格式时，选择了自定义格式‘  
则需设置log4j.appender.CONSOLE.layout.ConversionPattern = 格式  
格式会由特殊字符进行设置，之后会进行详解  
例：

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
    log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
    log4j.appender.CONSOLE.Threshold=DEBUG
    log4j.appender.CONSOLE.layout.ConversionPattern=%C  %d{yyyy-MM-dd HH:mm:ss} %m

**目标为文件需指定的属性**：  
输出级别、输出格式同上，其他：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>log4j.appender.LOGFILE.File</td> 
   <td>设置输出的目标文件</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.LOGFILE.Append</td> 
   <td>设置追加（true）、覆盖（false）</td> 
  </tr> 
 </tbody> 
</table>

例：

log4j.appender.LOGFILE = org.apache.log4j.FileAppender
    log4j.appender.LOGFILE.File = outfile/out.log
    log4j.appender.LOGFILE.Append = true
    log4j.appender.LOGFILE.layout = org.apache.log4j.PatternLayout
    log4j.appender.LOGFILE.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

**目标为每天产生日志文件**：  
和目标为文件时设置基本相同  
例：

log4j.appender.DAILYFILE = org.apache.log4j.DailyRollingFileAppender
    log4j.appender.DAILYFILE.File = outfile/daily.log
    log4j.appender.DAILYFILE.Append = true
    log4j.appender.DAILYFILE.Threshold = DEBUG 
    log4j.appender.DAILYFILE.layout = org.apache.log4j.PatternLayout
    log4j.appender.DAILYFILE.layout.ConversionPattern = %C  %d{yyyy-MM-dd HH:mm:ss} %m%n

**目标为溢出时建立新文件**：  
输出级别、输出格式同上，其他：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>log4j.appender.ROLLFILE.MaxFileSize</td> 
   <td>文件大小上限（带单位）</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.ROLLFILE.MaxBackupIndex</td> 
   <td>文件数目上限</td> 
  </tr> 
 </tbody> 
</table>

例：

log4j.appender.ROLLFILE = org.apache.log4j.RollingFileAppender
    log4j.appender.ROLLFILE.File = outfile/roll.log
    log4j.appender.ROLLFILE.Append = true
    log4j.appender.ROLLFILE.Threshold = DEBUG
    log4j.appender.ROLLFILE.MaxFileSize = 100KB
    log4j.appender.ROLLFILE.MaxBackupIndex = 10
    log4j.appender.ROLLFILE.layout = org.apache.log4j.PatternLayout
    log4j.appender.ROLLFILE.layout.ConversionPattern = %C  %d{yyyy-MM-dd HH:mm:ss} %m%n

### 日志信息格式设置 ###

使用’%'进行转义：

<table> 
 <thead> 
  <tr> 
   <th>符号</th> 
   <th>所代表格式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%%</td> 
   <td>%字符</td> 
  </tr> 
  <tr> 
   <td>-</td> 
   <td>信息输出时左对齐（默认右对齐）</td> 
  </tr> 
  <tr> 
   <td>%p</td> 
   <td>信息优先级（DEBUG，INFO，WARN，ERROR等）</td> 
  </tr> 
  <tr> 
   <td>%d</td> 
   <td>时间,可指定格式如：%d{yyyy-MM-dd HH:mm:ss}</td> 
  </tr> 
  <tr> 
   <td>%r</td> 
   <td>自应用启动到输出该log信息耗费的毫秒数</td> 
  </tr> 
  <tr> 
   <td>%t</td> 
   <td>产生该日志事件的线程名</td> 
  </tr> 
  <tr> 
   <td>%x</td> 
   <td>和当前线程相关联的NDC(嵌套诊断环境)</td> 
  </tr> 
  <tr> 
   <td>%c</td> 
   <td>日志信息所属的类的全名</td> 
  </tr> 
  <tr> 
   <td>%m</td> 
   <td>自己指定的消息,日志具体信息</td> 
  </tr> 
  <tr> 
   <td>%F</td> 
   <td>日志消息产生时所在的文件名称</td> 
  </tr> 
  <tr> 
   <td>%L</td> 
   <td>代码中的行号</td> 
  </tr> 
  <tr> 
   <td>%l</td> 
   <td>相当于：%C.%M(%F:%L)，包括类目名、发生的线程，以及在代码中的行数</td> 
  </tr> 
  <tr> 
   <td>%n</td> 
   <td>输出一个回车换行符，不同操作系统各不相同</td> 
  </tr> 
 </tbody> 
</table>

Ps：此处可在%与字符间填充信息来设置最大长度（截掉）、最小长度（对齐）

<table> 
 <thead> 
  <tr> 
   <th>格式</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%am</td> 
   <td>最小长度为a，以右对齐方式显示</td> 
  </tr> 
  <tr> 
   <td>%-am</td> 
   <td>最小长度为a，以左对齐方式显示</td> 
  </tr> 
  <tr> 
   <td>%.am</td> 
   <td>最大长度为a，截去左边多出的字符</td> 
  </tr> 
 </tbody> 
</table>

## Log4j的具体使用 ##

①建立org.apache.log4j.Logger的对象  
Logger log = Logger.getLogger(Test.class)

②通过不同的方法，输出不同的信息，与%m相对应  
如：  
log.error(“错误”);  
log.debug(“调试信息”);

#### 此处还有一个输出方向为DATABASE ####

具体配置：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>log4j.appender.DATABASE</td> 
   <td>org.apache.log4j.jdbc.JDBCAppender</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.URL</td> 
   <td>jdbc:mysql://localhost:3306/数据库名?serverTimezone = GMT</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.driver</td> 
   <td>com.mysql.cj.jdbc.Driver</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.user</td> 
   <td>用户名</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.password</td> 
   <td>密码</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.sql</td> 
   <td>使用插入语句：INSERT INTO 表名(列名) VALUES （格式符)</td> 
  </tr> 
  <tr> 
   <td>log4j.appender.DATABASE.layout</td> 
   <td>设置格式：org.apache.log4j.PatternLayout</td> 
  </tr> 
 </tbody> 
</table>

例：

log4j.rootCategory=ERROR,DATABASE
    
    log4j.appender.DATABASE = org.apache.log4j.jdbc.JDBCAppender
    log4j.appender.DATABASE.URL = jdbc:mysql://localhost:3306/log4j_message?serverTimezone = GMT
    log4j.appender.DATABASE.driver = com.mysql.cj.jdbc.Driver
    log4j.appender.DATABASE.user = root
    log4j.appender.DATABASE.password = *********
    log4j.appender.DATABASE.sql = INSERT INTO message(information) VALUES ("%C  %d{yyyy-MM-dd HH:mm:ss} %m")
    log4j.appender.DATABASE.layout = org.apache.log4j.PatternLayout

结果（此处，我全局设置为error，使用上面的输出，只记录error信息）：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODkxODA1_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODkxODA1_size_16_color_FFFFFF_t_70]: /images/20230528/2ba4b662cd684c32aa0f513f2adb184d.png