如何在YAML配置中正确配置Log4j2 JDBC Appender（含ConnectionFactory）

正确配置示例 #

1. 自定义ConnectionFactory实现类 #

必须遵循Log4j2插件规范编写，确保能被框架识别：

import org.apache.logging.log4j.core.appender.db.jdbc.ConnectionFactory;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

@Plugin(name = "CustomConnectionFactory", category = "Core", elementType = "connectionFactory", printObject = true)
public class CustomConnectionFactory implements ConnectionFactory {

    private final String url;
    private final String username;
    private final String password;

    private CustomConnectionFactory(String url, String username, String password) {
        this.url = url;
        this.username = username;
        this.password = password;
    }

    @PluginFactory
    public static CustomConnectionFactory createFactory(
            @PluginAttribute("url") String url,
            @PluginAttribute("username") String username,
            @PluginAttribute("password") String password) {
        return new CustomConnectionFactory(url, username, password);
    }

    @Override
    public Connection getConnection() throws SQLException {
        return DriverManager.getConnection(url, username, password);
    }
}

2. log4j2.yaml配置文件 #

注意层级结构，ConnectionFactory、ColumnConfigs、tableName必须作为Jdbc节点的直接子元素：

Configuration:
  status: warn
  name: JdbcAppenderConfig
  Appenders:
    Jdbc:
      name: JdbcAppender
      tableName: "sys_log"
      # 关联自定义ConnectionFactory，type值要和@Plugin注解的name一致
      ConnectionFactory:
        type: CustomConnectionFactory
        url: "jdbc:mysql://localhost:3306/test_db"
        username: "root"
        password: "123456"
      # 配置日志字段映射
      ColumnConfigs:
        ColumnConfig:
          - name: log_level
            pattern: "%level"
            isUnicode: false
          - name: log_message
            pattern: "%message"
            isUnicode: false
          - name: log_time
            pattern: "%d{yyyy-MM-dd HH:mm:ss}"
            isUnicode: false
  Loggers:
    Root:
      level: info
      AppenderRef:
        ref: JdbcAppender

问题排查步骤 #

• 检查插件注解规范：自定义类必须添加@Plugin注解，elementType固定为"connectionFactory"，category为"Core"，name要和yaml中ConnectionFactory的type匹配。同时必须提供带@PluginFactory的静态工厂方法，参数用@PluginAttribute绑定配置属性。
• 校验YAML层级：ColumnConfigs、ConnectionFactory不能嵌套错误，必须是Jdbc节点的直接子项，缩进错误会导致Log4j2无法识别这些插件属性。
• 确认依赖完整性：确保项目依赖包含log4j-core、log4j-jdbc-appender，且版本统一，同时添加对应数据库驱动（如mysql-connector-java）。
• 开启调试日志：将配置中status设为debug，启动后查看Log4j2的插件加载日志，确认自定义ConnectionFactory是否被扫描到，以及JdbcAppender初始化时的具体错误细节。
• 验证类路径：确保自定义ConnectionFactory类在项目类路径下，模块化项目需确认对应包已导出。

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