如何通过ServiceLoader服务动态设置Log4J2日志目录？

已知的常规动态设置方式 #

通常我们可以通过以下方式动态指定Log4j2的日志目录：

• 在代码中设置系统属性：

System.setProperty("logDirectory", getLogDirectoryDynamically());

• 在Log4j2的XML配置文件中引用该属性：

<File name="File" fileName="${sys:logDirectory:-.}/my.log" append="false">
    <!-- 其他配置 -->
</File>

问题场景 #

当没有可调用System.setProperty("logDirectory", ...)的中心入口（例如无主类main方法）时，能否通过java.util.ServiceLoader注册服务，实现org.apache.logging.log4j.util.PropertySource接口来添加logDirectory属性，让Log4j2在首次调用LogManager.getLogger(...)时自动加载这个自定义属性源？

可行的解决方案：自定义PropertySource并通过ServiceLoader注册 #

完全可以通过这种方式实现，具体步骤如下：

1. 实现PropertySource接口 #

创建自定义类实现org.apache.logging.log4j.util.PropertySource，在其中提供动态生成的日志目录值：

import org.apache.logging.log4j.util.PropertySource;
import java.util.Map;

public class CustomLogDirPropertySource implements PropertySource {
    // 设置优先级：数值越高优先级越高，系统属性的优先级为300，这里设为200（低于系统属性，高于默认值）
    @Override
    public int getPriority() {
        return 200;
    }

    @Override
    public void copyProperties(Map<String, String> dest) {
        // 动态获取日志目录并注入属性映射
        String dynamicLogDir = getDynamicLogDirectory();
        dest.put("logDirectory", dynamicLogDir);
    }

    // 自定义动态获取日志目录的逻辑
    private String getDynamicLogDirectory() {
        // 这里替换为你的实际动态逻辑，比如从环境变量、配置文件等获取
        return "/var/app/dynamic-logs";
    }
}

2. 注册ServiceLoader服务 #

在项目的src/main/resources/META-INF/services/目录下创建一个名为org.apache.logging.log4j.util.PropertySource的文件，文件内容写入自定义类的全限定类名：

com.yourpackage.CustomLogDirPropertySource

（注意替换为你实际的包路径和类名）

3. 修改Log4j2配置引用属性 #

配置文件中直接引用自定义属性即可（无需sys:前缀，因为属性来自自定义PropertySource）：

<File name="File" fileName="${logDirectory:-.}/my.log" append="false">
    <!-- 其他配置 -->
</File>

生效逻辑 #

当首次调用LogManager.getLogger(...)触发Log4j2初始化时，ServiceLoader会自动扫描并加载所有注册的PropertySource实现类，你的自定义类会被实例化并执行copyProperties方法，将动态生成的logDirectory属性注入到Log4j2的属性系统中，供配置文件使用。

内容的提问来源于stack exchange，提问作者Natasha