Express+Sequelize+MySQL项目如何配置记录ORM执行的SQL查询日志

实现思路 #

Sequelize ORM本身内置了完整的日志拦截能力，不需要引入额外第三方依赖，仅通过初始化参数配置，就能完整捕获所有ORM构造、执行的SQL语句，完全支持自定义留存、导出逻辑。

最小改造代码示例 #

在你现有的index.js初始化代码里，补充两个核心配置项即可接管全量SQL捕获：

• 给logging传入自定义回调函数：所有执行的SQL语句、单条查询的执行耗时，都会作为参数传入这个回调，你可以在回调内自定义任意留存逻辑（追加写本地文件、推送日志平台、存入业务数据库都可以）
• 开启logQueryParameters配置：默认情况下Sequelize捕获到的SQL只会显示带?占位符的模板，开启后可以拿到SQL绑定的实际参数值，导出的SQL可以直接复制到MySQL客户端执行

改造后的代码参考：

const Sequelize = require('sequelize');
const sequelize = new Sequelize({
  host: 'localhost',
  dialect: 'mysql',
  // 自定义SQL捕获回调
  logging: (sql, costMs) => {
    // 这里可以按需替换成自己的留存逻辑，比如追加写入本地日志文件
    const logLine = `${new Date().toLocaleString()} | 查询耗时${costMs}ms | 完整SQL：${sql}`;
    require('fs').appendFileSync('./exported-sql.log', logLine + '\n');
  },
  logQueryParameters: true // *必开配置*，否则只能拿到占位符SQL，看不到实际入参
});

可配置化适配技巧 #

为了适配不同环境的项目需求，可以把SQL日志的能力做成可动态调整的配置，避免硬编码：

• 把日志开关、输出路径、慢SQL阈值抽到独立的项目配置文件：本地开发环境可以默认开启全量SQL捕获，同时同步打印到控制台；生产环境可以按需关闭全量SQL日志，或者只留存执行耗时超过阈值的慢SQL
• 扩展日志关联上下文：在捕获SQL的时候，同步关联当前的请求路径、用户ID、请求Trace ID，让导出的SQL可以和触发它的业务操作一一对应，后续排查问题时效率更高
• 自定义导出格式：如果需要CSV、JSON等结构化的导出文件，直接在logging回调里把捕获的字段整理成对应格式写入即可，不需要额外适配ORM插件

常见注意事项 #

• 不要把logging参数设置为false，该配置会直接关闭所有SQL日志捕获能力，等于完全放弃SQL记录
• 做好敏感信息过滤：如果SQL里包含密码、手机号、身份证号这类敏感数据，在写入日志前要做正则替换脱敏，不要明文存储到日志文件里
• 做好日志文件管理：不要把SQL日志文件放在项目源码目录下，避免被误提交到代码仓库，同时要定期清理过期的SQL日志文件，避免占用过多磁盘空间

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