QuickFixJ 2.2.0数据库日志自定义方案咨询

核心思路 #

通过继承默认JdbcLog类并重写关键日志写入方法，扩展所需的自定义字段，再通过配置替换默认实现，即可满足在事件/消息表中添加更多信息的需求。

1. 编写自定义JdbcLog子类 #

创建继承自默认JdbcLog的自定义类，重写日志插入方法，添加你需要的额外字段（比如用户ID、请求链路ID、业务模块标识等）：

public class CustomJdbcLog extends JdbcLog {
    // 重写事件日志插入方法，补充自定义字段
    @Override
    protected void logEvent(Connection conn, Event event) {
        // 构造包含自定义字段的插入SQL
        String insertSql = "INSERT INTO event_table (id, type, detail, user_id, trace_id) VALUES (?, ?, ?, ?, ?)";
        
        try (PreparedStatement stmt = conn.prepareStatement(insertSql)) {
            // 填充原有日志字段
            stmt.setString(1, event.getId());
            stmt.setString(2, event.getType());
            stmt.setString(3, event.getDetail());
            // 填充自定义字段（根据实际场景获取，比如从上下文ThreadLocal中取值）
            stmt.setString(4, UserContext.getCurrentUserId());
            stmt.setString(5, TraceContext.getCurrentTraceId());
            
            stmt.executeUpdate();
        } catch (SQLException e) {
            // 异常隔离，避免日志逻辑阻塞主业务
            log.error("Event log insert failed", e);
        }
    }

    // 同理重写消息日志插入方法
    @Override
    protected void logMessage(Connection conn, Message message) {
        String insertSql = "INSERT INTO message_table (id, content, sender, receiver, business_module) VALUES (?, ?, ?, ?, ?)";
        try (PreparedStatement stmt = conn.prepareStatement(insertSql)) {
            stmt.setString(1, message.getId());
            stmt.setString(2, message.getContent());
            stmt.setString(3, message.getSender());
            stmt.setString(4, message.getReceiver());
            stmt.setString(5, BusinessContext.getCurrentModule()); // 自定义业务模块字段
            
            stmt.executeUpdate();
        } catch (SQLException e) {
            log.error("Message log insert failed", e);
        }
    }
}

2. 替换默认实现 #

根据你使用的框架环境，通过代码或配置文件指定自定义类：

• Spring环境（代码注册Bean）：
  在配置类中注册自定义JdbcLog实例，覆盖默认Bean：

  @Configuration
  public class LogConfig {
      @Bean
      public JdbcLog jdbcLog() {
          return new CustomJdbcLog();
      }
  }
  

• 配置文件方式：
  如果框架支持通过配置指定日志类，在配置文件（如application.properties）中设置：

  # 替换为你的自定义类全路径
  framework.jdbc.log.implementation=com.yourcompany.yourproject.log.CustomJdbcLog
  

3. 关键注意事项 #

• 确保重写的方法签名与父类完全一致，避免框架调用时出现方法找不到的错误。
• 日志逻辑要做好异常隔离，不能因为日志写入失败导致主业务流程中断。
• 如果父类有初始化逻辑，记得在自定义类的构造方法中调用super()完成父类初始化。
• 测试阶段要验证：原有日志字段是否正常写入，自定义字段是否正确填充，异常场景下是否不影响主业务。

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