springmvc+log4j操作日志记录,详细配置

喜欢ヅ旅行 2022-06-10 20:07 287阅读 0赞

需要导入包：

log包：log4j-12.17.jar

第一步：web.xml配置

![复制代码][copycode.gif]

<context-param>     
          <param-name>log4jConfigLocation</param-name>     
          <param-value>/WEB-INF/log4j.xml</param-value>     
    </context-param>     
     
    <context-param> 
      <param-name>controller</param-name> 
      <param-value>controller-log</param-value> 
    </context-param> 
    
    <context-param> 
      <param-name>loggingLevel</param-name> 
      <param-value>info</param-value> 
    </context-param> 
     
     <listener>
      <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
     </listener>

![复制代码][copycode.gif]

第二步log4j.xml配置

(配置文件可以有两种方式，一种是xml，一种是properties。个人比较喜欢xml，一目了然)

先讲解一下核心对象：

logger对象： Logger对象负责捕获日志信息及它们存储在一个空间的层次结构。

Appender对象：下位层提供Appender对象。Appender对象负责发布日志信息，以不同的首选目的地，如数据库，文件，控制台，UNIX系统日志等。

layout对象： 该层提供其用于格式化不同风格的日志信息的对象。布局层提供支持Appender对象到发布日志信息之前。

打个比方：logger是个情报站，负责收集他 所在地方（用name="xxx包"指定）下的所有信息。appender是发送出去的方式，如写信（FileAppender）、电报（SMTPAppender）等多种。layout就是发送内容以什么格式书写，如自定义格式（PatternLayout），html（[HTMLLayout][]）格式。

![复制代码][copycode.gif]

<?xml version="1.0" encoding="UTF-8"?>    
    <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">  
    <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
      
        
      <appender name="console" class="org.apache.log4j.ConsoleAppender">  
         <param name="encoding" value="GBK" />  
         <param name="target" value="System.out" />  
         <layout class="org.apache.log4j.PatternLayout">  
           <param name="ConversionPattern" value="%d{ISO8601} 耗时：%r [日志来自：%-40.40c{3} 日志类型: %-5p 日志内容：%m]%n" />  
         </layout>  
            
            <filter class="org.apache.log4j.varia.LevelRangeFilter">  
                <param name="levelMin" value="debug" />  
                <param name="levelMax" value="warn" />  
                <param name="AcceptOnMatch" value="true" />  
            </filter>  
      </appender>  
      
        
      <appender name="DEFAULT-APPENDER" class="org.apache.log4j.DailyRollingFileAppender">  
         <param name="File" value="${webapp.root}/logs/common-default.log" />  
         <param name="Append" value="true" />  
         <param name="encoding" value="GBK" />  
         <param name="threshold" value="all" /> 
         <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />  
         <layout class="org.apache.log4j.PatternLayout">  
        <param name="ConversionPattern" value="%d{ISO8601} 耗时：%r [日志来自：%-40.40c{3} 日志类型: %-5p 日志内容：%m]%n" />  
         </layout>  
       </appender>  
      
         
       <appender name="DEBUG-APPENDER" class="org.apache.log4j.DailyRollingFileAppender">  
         <param name="File" value="${webapp.root}/logs/controller/debug-log.log" />  
         <param name="Append" value="true" />  
         <param name="encoding" value="GBK" />  
         <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />  
         <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="%d{ISO8601} 耗时：%r [日志来自：%-40.40c{3} 日志类型: %-5p 日志内容：%m]%n" />  
         </layout>  
       </appender>  
       
         
       <appender name="INFO-APPENDER"  
    class="org.apache.log4j.DailyRollingFileAppender">  
         <param name="File" value="${webapp.root}/logs/controller/info-log.log" />  
         <param name="Append" value="false" />  
         <param name="encoding" value="GBK" />
         <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />  
         <layout class="org.apache.log4j.PatternLayout">  
        <param name="ConversionPattern" value="%d{ISO8601} 耗时：%r [日志来自：%-40.40c{3} 日志类型: %-5p 日志内容：%m]%n" />  
         </layout> 
         
         <filter class="org.apache.log4j.varia.LevelRangeFilter">     
           <param name="LevelMax" value="info"/>     
           <param name="LevelMin" value="info"/>     
          </filter>   
       </appender>  
    
          
       <appender name="COMPONENT-APPENDER"  
    class="org.apache.log4j.DailyRollingFileAppender">  
         <param name="File" value="${webapp.root}/logs/logistics-component.log" />  
         <param name="Append" value="true" />  
         <param name="encoding" value="GBK" />  
         <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />  
         <layout class="org.apache.log4j.PatternLayout">  
        <param name="ConversionPattern" value="%d{ISO8601} 耗时：%r [日志来自：%-40.40c{3} 日志类型: %-5p 日志内容：%m]%n" />  
         </layout>  
       </appender>  
      
           
         
       <logger name="com.wzw.controller" additivity="true">  
          
          <level value="DEBUG"></level>  
          <appender-ref ref="DEBUG-APPENDER" />  
       </logger>  
       
           
         
       <logger name="com.wzw.controller" additivity="true">  
          <level value="INFO"></level>  
          <appender-ref ref="INFO-APPENDER" />  
          <appender-ref ref="console"/>
       </logger>  
       
         
       
       <root> 
           <level value="ALL"></level>  
           <appender-ref ref="DEFAULT-APPENDER" />  
           <appender-ref ref="console"/>
       </root>  
       
    </log4j:configuration>

![复制代码][copycode.gif]

运行就能看到common-default.log里面有操作日志

自己输出日志：

我controller包下某各类中：

![复制代码][copycode.gif]

package com.wzw.controller;
    import org.apache.logging.log4j.LogManager;
    import org.apache.logging.log4j.Logger;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RequestMapping;
    @Controller
    @RequestMapping("/account")
    public class AccountController {
        private static Logger logger =LoggerFactory.getLogger(AccountController.class);
    @ResponseBody
        @RequestMapping("/login")
        public String login(HttpSession session){
            logger.info("请求登录");
            logger.debug("debug");
            logger.warn("warn");
    }
    }

![复制代码][copycode.gif]

访问这个controller,就会记录日志，因为有log4j中有两个logger配置记录controller包下的日志，所以输出到两个logger下<appender-ref>（输出方式）。

appender选项：

*  AppenderSkeleton
 *  AsyncAppender
 *  ConsoleAppender
 *  DailyRollingFileAppender
 *  ExternallyRolledFileAppender
 *  FileAppender
 *  JDBCAppender
 *  JMSAppender
 *  LF5Appender
 *  NTEventLogAppender
 *  NullAppender
 *  RollingFileAppender
 *  SMTPAppender
 *  SocketAppender
 *  SocketHubAppender
 *  SyslogAppender
 *  TelnetAppender
 *  WriterAppender

layout选项：

*  DateLayout
 *  HTMLLayout
 *  PatternLayout
 *  SimpleLayout
 *  XMLLayout

# #

## 模式转换字符： ##

下表说明了以上模式使用的字符和所有其他字符，可以在自定义模式中使用：

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; border:1px solid silver; word-break:break-word; color:rgb(0,0,0); font-family:Verdana,Arial,Helvetica,sans-serif; font-size:14px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 转换字符</th> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 表示的意思</th> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> c</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出的记录事件的类别。例如，对于类别名称"a.b.c"&nbsp;模式&nbsp;&nbsp;%c{2}&nbsp;会输出&nbsp;"b.c"</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> C</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出呼叫者发出日志请求的完全限定类名。例如，对于类名 "org.apache.xyz.SomeClass", 模式&nbsp;%C{1} 会输出 "SomeClass".</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> d</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出的记录事件的日期。例如， %d{HH:mm:ss,SSS} 或 %d{dd MMM yyyy HH:mm:ss,SSS}.</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> F</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出被发出日志记录请求，其中的文件名</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> l</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于将产生的日志事件调用者输出位置信息</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> L</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出从被发出日志记录请求的行号</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> m</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出使用日志事件相关联的应用程序提供的消息</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> M</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出发出日志请求所在的方法名称</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> n</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 输出平台相关的行分隔符或文字</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> p</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出的记录事件的优先级</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> r</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出毫秒从布局的结构经过直到创建日志记录事件的数目</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> t</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于输出生成的日志记录事件的线程的名称</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> x</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用于与产生该日志事件的线程相关联输出的NDC（嵌套诊断上下文）</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> X</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 在X转换字符后面是键为的MDC。例如&nbsp;&nbsp;X{clientIP}&nbsp;将打印存储在MDC对键clientIP的信息</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 文字百分号&nbsp;%%将打印％标志</td> 
  </tr> 
 </tbody> 
</table>

## 格式修饰符： ##

默认情况下，相关资料原样输出。然而，随着格式修饰符的帮助下，可以改变最小字段宽度，最大字段宽度和对齐。

下表涵盖了各种各样的修饰符的情况：

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; border:1px solid silver; word-break:break-word; color:rgb(0,0,0); font-family:Verdana,Arial,Helvetica,sans-serif; font-size:14px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> Format modifier</th> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> left justify</th> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> minimum width</th> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> maximum width</th> 
   <th style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 注释</th> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %20c</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> false</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 20</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> none</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用空格左垫，如果类别名称少于20个字符长</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %-20c</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> true</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 20</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> none</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用空格右垫，如果类别名称少于20个字符长</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %.30c</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> NA</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> none</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 30</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 从开始截断，如果类别名称超过30个字符长</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %20.30c</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> false</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 20</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 30</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用空格左侧垫，如果类别名称短于20个字符。但是，如果类别名称长度超过30个字符，那么从开始截断。</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> %-20.30c</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> true</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 20</td> 
   <td align="center" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 30</td> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 用空格右侧垫，如果类别名称短于20个字符。但是，如果类别名称长度超过30个字符，那么从开始截断。<br style="margin:0px; padding:0px"> </td> 
  </tr> 
 </tbody> 
</table>

[copycode.gif]: /images/20220611/cff0f49293ad49bdbb30fa7469a5e5d8.png
[HTMLLayout]: http://www.yiibai.com/log4j/log4j_htmllayout.html