给项目引入日志系统log4j.properties->log4j2.xml

缺乏、安全感 2022-01-22 23:59 351阅读 0赞

一般项目都会有日志记录功能，今天学习了下如何引入日志。  
看网上材料，之前好多都是在classpath路径下新建log4j.properties，引入log4j依赖，旧版本的log4j，玩到最后发现在web.xml里配置Log4jConfigListener时，此类已过时，spring建议用log4j2 来替换这个类。之前的log4j.properties写法大概是这样的：

#log4j.rootLogger=ERROR, stdout
    #log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    #log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    #log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
    
    #OFF >FATAL > ERROR > WARN > INFO > DEBUG > ALL
    #通过根日志记录器指定日志级别及输出源
    #日志输出的优先级：  debug < info < warn < error < fatal
    #定义根日志记录器的日志级别(info)及输出源的别名(myStdout,myFile)
    #该定义让日志在控制台和文件输出，并且只输出info级别以上的日志
    log4j.rootLogger=warn,error,fatal,myStdout,myFile
    
    #######配置输出源myStdout的具体实现为控制台输出#######
    #定义输出源别名myStdout（即根日志记录器定义的输出源）
    #的实现类是ConsoleAppender（控制台输出源）
    #指定日志输出格式的格式转换器为PatternLayout实现类
    log4j.appender.myStdout=org.apache.log4j.ConsoleAppender
    log4j.appender.myStdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.myStdout.layout.ConversionPattern=%d %-5p [%c.%M()] - %m%n 
    
    
    #######配置输出源myFile的具体实现为文件输出#######
    #定义输出源别名myFile（即根日志记录器定义的输出源）
    #的实现类是RollingFileAppender（文件输出源）
    #定义日志文件的存储路径
    log4j.appender.myFile=org.apache.log4j.RollingFileAppender
    log4j.appender.myFile.File=${webapp.root}/WEB-INF/logs/esxblog.log
    #定义日志文件的大小
    log4j.appender.myFile.MaxFileSize=102400kb
    #定义日志文件最多生成几个（从0开始算1个，即此处最多3个文件）
    #超过该大小则会覆盖前面生成的文件
    log4j.appender.myFile.MaxBackupIndex=0
    #指定日志输出格式的格式转换器为PatternLayout实现类
    log4j.appender.myFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.myFile.layout.ConversionPattern=%d %-5p [%c.%M()] - %m%n 
    
    #######输出格式解释#######
    #%d: 日志打印的时间点，默认格式为ISO8601，也可以另外指定格式，
    #定义如下：  %d{yyy年MM月dd日 HH时mm分ss秒SSS}，则会输出：
    #2018年01月06日 14时47分45秒590
    #%p: 输出日志级别，即DEBUG，INFO，WARN，ERROR，FATAL
    #%-5p：表示字符小于5位，则字符居左（不加“-”号则字符居右），你可以举一反三
    #%c: 日志所在类的全名
    #%M: 日志所在方法的名字
    #%m: 日志信息
    #%n: 输出一个回车换行符
    #%L: 输出代码中的行号

下面是log4j2替换原先的过期类  
1.首先引入新的依赖

<dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-api</artifactId>
          <version>2.10.0</version>
        </dependency>
        <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-core</artifactId>
          <version>2.10.0</version>
        </dependency>
    
        <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-web</artifactId>
          <version>2.9.1</version>
        </dependency>

2.在web.xml中配置log4j2 监听

<context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:log4j2.xml</param-value>
        
        
      </context-param>
    
      <listener>
        <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
      </listener>
    
      <filter>
        <filter-name>log4jServletFilter</filter-name>
        <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
      </filter>
      <filter-mapping>
        <filter-name>log4jServletFilter</filter-name>
        <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
        <dispatcher>INCLUDE</dispatcher>
        <dispatcher>ERROR</dispatcher>
      </filter-mapping>

3.在src/main/resources下新建log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="OFF" monitorInterval="1800">
        <properties>
            
            <property name="LOG_HOME">E:\localitems\esxblog\extra-temp\logs</property>
            <property name="FILE_NAME">esxlog</property>
        </properties>
    
    
        <Appenders>
            <Console name="Console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            </Console>
    
            <RollingFile name="running-log" fileName="${LOG_HOME}/${FILE_NAME}.log"
                         filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz"
                         immediateFlush="true">
                <PatternLayout
                        pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
                <Policies>
                    <TimeBasedTriggeringPolicy />
                    <SizeBasedTriggeringPolicy size="10 MB" />
                </Policies>
                <DefaultRolloverStrategy max="20" />
            </RollingFile>
        </Appenders>
        <Loggers>
    
            
    
            <Root level="info">
                
                <AppenderRef ref="running-log" />
                
                <AppenderRef ref="Console" />
            </Root>
        </Loggers>
    </Configuration>

4.在controller里测试并使用

package com.esxblog.controller;
    
    import com.esxblog.pojo.User;
    import com.esxblog.service.UserService;
    import org.apache.logging.log4j.LogManager;
    import org.apache.logging.log4j.Logger;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    /**
     * @Author: yicha
     * @Description:
     * @Date: created in 2019/5/17 22:02
     */
    
    @Controller
    public class UserController {
    
        private static final Logger LOGGER = LogManager.getLogger(UserController.class);
    
        @Autowired
        private UserService userService;
    
        @RequestMapping("/test")
        @ResponseBody
        public String test(){
            return "success";
        }
    
        @RequestMapping(value = "/user/login",method = RequestMethod.POST)
        @ResponseBody
        public User login(@RequestBody User u){
    
            LOGGER.info(u.getNickName()+"请求登录博客系统");
    
            return userService.queryByUserNameAndPassword(u);
    
        }
    }

5.验证结果  
![在这里插入图片描述][20190601113703509.png]

[20190601113703509.png]: /images/20220123/0eaf5d8bb8554cdda1bb6b737f473e20.png