使用log4j2自定义配置文件位置和文件名(附log4j2.xml配置实例)

log4j2自定义配置文件位置和文件名

我们使用log4j2一般做法是将log4j2.xml文件放在资源文件夹根目录。对于有强迫症的开发者来说,我更喜欢在资源文件夹下新建包或文件夹,然后把配置文件放在里面。本博客将介绍如何自定义log4j2.xml文件的位置和文件名。

web.xml配置

    
    
        edu.example.holder.system.Log4j2ConfigListener
    
    
        日志配置文件的路径
        log4j.configurationFile
        log4j/log4j2.xml
    

Log4j2ConfigListener类是自定义的类,实现ServletContextListener接口,这样tomcat启动时可以更改日志配置文件的默认路径和文件名。

生效配置文件

package edu.example.holder.system;
import java.util.Enumeration;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import org.apache.logging.log4j.core.config.Configurator;
public class Log4j2ConfigListener implements ServletContextListener
{
    private static final String KEY = "log4j.configurationFile";
    @Override
    public void contextDestroyed(ServletContextEvent arg0)
    {
    }
    @Override
    public void contextInitialized(ServletContextEvent arg0)
    {
        String fileName = getContextParam(arg0);
        Configurator.initialize("Log4j2", "classpath:" + fileName);
    }
    @SuppressWarnings("unchecked")
    private String getContextParam(ServletContextEvent event) {
        Enumeration names = event.getServletContext().getInitParameterNames();
        while (names.hasMoreElements())
        {
            String name = names.nextElement();
            String value = event.getServletContext().getInitParameter(name);
            if(name.trim().equals(KEY))
            {
                return value;
            }
        }
        return null;
    }
}

日志配置文件实例




    
        
        ${sys:catalina.home}/WebAppLogs/SSHExample
    
    
        
        
            
              
            
            
        
        
        
            
            
            
            
        
        
        
        
            
                %5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n
            
            
                
                
            
            
                
                  
                 
            
        
        
        
        
            
                %5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n
            
            
                
                
                

            
            
                
                  
                 
            
        
        
        
            
                %5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n
            
            
                
            
            
                  
                 
            
        
        
        
            
                %5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n
            
            
                
            
            
                  
                 
              
        
        
        
            
                %5p [%t] %d{yyyy-MM-dd HH:mm:ss} (%F:%L) %m%n
            
            
                
            
            
                
              
        
    
    
        
        
            
            
            
            
            
            
            
        
        
        
        
        
        
        
        
    

log4j2.xml配置及例子

1.使用log4j2需要下载包

如下:

2.配置文件可以有三种格式

(文件名必须规范,否则系统无法找到配置文件):

  • classpath下名为 log4j-test.json 或者log4j-test.jsn文件
  • classpath下名为 log4j2-test.xml
  • classpath下名为 log4j.json 或者log4j.jsn文件
  • classpath下名为 log4j2.xml

3.日志记录有两种方法

static Logger logger = LogManager.getLogger(MyApplication.class.getName());
private static Logger logger = LogManager.getLogger("MyApplication"); 

4.我用的xml的配置

所以介绍一下xml配置:

1.首先要配几个要用到的appender,这些appender功能不一样,比如有常规输出,重大异常输出,你可能需要他们输出形式或者输出的文件不同,这些都可以在appender中配置

2.appender里面的一些配置说明:

  • name:appender的名称
  • fileName:输出文件和名称
  • append:是否追加,true表示追加内容到所在的日志,false表示每次都覆盖
  • filePattern:表示当日志到达指定的大小或者时间,产生新日志时,旧日志的命名路径
  • PatternLayout:指定输出日志的格式,具体代表的意思见前面的博客中
  • Policies:策略,表示日志什么时候应该产生新日志,可以有时间策略和大小策略等
  • ThresholdFilter :过滤器,log4j2中有很多的filter

3.接下来配置logger

指定哪些类进行何种输出,这个比较简单,可以直接看栗子:



    
        e:/log
        %d %-5p %t (%c:%L) - %m%n
    
    
    <--此处使用了两种类型的appender,RollingFile为滚动类型,满足策略条件后会新建文件夹记录 -->
    
        
            SYSTEM_OUT
            
        
        
            
                
                
            
            
                GBK
                ${log.layout}
            
        
        
            
                
                
            
            
                GBK
                ${log.layout}
            
        
    
    
        
            
        
        
            
            
        
        
        
    

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

你可能感兴趣的:(使用log4j2自定义配置文件位置和文件名(附log4j2.xml配置实例))