以编程方式加载 Log4j2 配置文件

Question

我想从我的应用程序中以编程方式加载 Log4j2 XML 配置文件。

试过这个：

ConfigurationSource source = new ConfigurationSource();
source.setLocation(logConfigurationFile);
Configurator.initialize(null, source);

还有这个：

ConfigurationSource source = new ConfigurationSource();
source.setLocation(logConfigurationFile);
ConfigurationFactory factory = (ConfigurationFactory) XMLConfigurationFactory.getInstance().getConfiguration(source);
ConfigurationFactory.setConfigurationFactory(factory);

但还没有任何效果。

Answer 1

对于最新版本的 log4j，以下是加载外部 log4j2.xml 的方法：

String log4jConfigFile = System.getProperty("user.dir") + File.separator + "log4j2.xml";
ConfigurationSource source = new ConfigurationSource(new FileInputStream(log4jConfigFile));
Configurator.initialize(null, source);

Answer 2

如果您只有一个主入口点，此代码 sn-p 可能会为您节省一些麻烦。 set 属性调用必须在创建任何记录器之前触发。这种方法适用于类路径中的文件。

public class TestProcess {
    static {
        System.setProperty("log4j.configurationFile", "log4j-alternate.xml");
    }

    private static final Logger log = LoggerFactory.getLogger(TestProcess.class);

}

Answer 3

自己找到了答案。有人可能会觉得它很有用。

ConfigurationSource source = new ConfigurationSource();
source.setLocation(logConfigurationFile);
source.setFile(new File(logConfigurationFile));
source.setInputStream(new FileInputStream(logConfigurationFile));
Configurator.initialize(null, source);

Answer 4

下面为我工作，Log4j2 和 SLF4J 包装器：

解决方案 1：

public class MyClass {

    static {
        try {
            InputStream inputStream = new FileInputStream("C:/path/to/log4j2.xml");
            ConfigurationSource source = new ConfigurationSource(inputStream);
            Configurator.initialize(null, source);
        } catch (Exception ex) {
            // Handle here
        }
    }

    private static final Logger LOGGER = LoggerFactory.getLogger(MyClass.class); // LogManager if not using SLF4J

    public void doSomething() {
        LOGGER.info(...)
    }

}

解决方案 2：

static {
    File log4j2File = new File("C:/path/to/log4j2.xml");
    System.setProperty("log4j2.configurationFile", log4j2File.toURI().toString());
}

需要toURI() 关注File URI Scheme format，否则会抛出MalformedURLException。

来源：

• Proper format for log4j2.xml RollingFile configuration
• https://github.com/jprante/elasticsearch-jdbc/issues/562
• https://www.codeproject.com/Questions/190269/MalformedURLException-unknown-protocol-c-How-to-ha
• https://coderanch.com/t/633544/open-source/java-net-MalformedURLException-initialize-log

Answer 5

如果您使用的是 Servlet 3.0 Web 应用程序，您可以使用 Log4jServletContextListener 并执行以下操作：

编写一个从Log4jServletContextListener 扩展的自定义LogContextListener，在您的web.xml 中设置它并禁用自动初始化：

<listener>
    <listener-class>com.example.LogContextListener</listener-class>
</listener>
<context-param>
    <param-name>isLog4jAutoInitializationDisabled</param-name>
    <param-value>true</param-value>
</context-param>

在您的自定义LogContextListener 中覆盖contextInitialized 并设置配置位置

public void contextInitialized(ServletContextEvent event) { 
    /* Some logic to calculate where the config file is saved. For 
     * example you can read an environment variable.
     */
    String pathToConfigFile = ... + "/log4j2.xml";
    Configurator.initialize(null, pathToConfigFile);
    super.contextInitialized(event);
}

比直接在web.xml 中配置位置的优势在于 您可以根据一些附加信息计算路径并访问 log4j2.xml，即使它在您的类路径之外。

Answer 6

考虑 - https://logging.apache.org/log4j/2.x/log4j-core/apidocs/org/apache/logging/log4j/core/config/Configurator.html

Configurator.initialize(null, "classpath:conf/logger.xml");
or
Configurator.initialize(null, "/full_path/conf/logger.xml");

注意，不要同时使用两者。

Answer 7

final URL log4j = Resources.getResource("log4j2-test.xml");
LoggerContext.getContext(false)
  .start(new XmlConfiguration(new ConfigurationSource(
    Resources.asByteSource(log4j).openStream(),
    log4j)));

Answer 8

如果您使用 .properties 文件进行配置：

String propertiesFile = "./test/Configuration/log4j2.properties";  
ConfigurationSource source = new ConfigurationSource(new FileInputStream(propertiesFile), new File(propertiesFile));
Configurator.initialize(null, source);