如何同时使用Knex与Rollup？解决仅用MySQL却打包全量依赖问题

问题根源 #

Knex为兼容多数据库，代码中包含了对mysql、tedious、pg等驱动的条件require语句，但Rollup默认无法静态分析这些动态分支逻辑，会把所有驱动的引入都保留在最终打包产物里，即便你只用到其中一种。

具体解决方案 #

方案1：用rollup-plugin-ignore直接忽略未使用的驱动 #

先安装插件：

npm install rollup-plugin-ignore --save-dev

在rollup.config.js中添加配置：

import ignore from 'rollup-plugin-ignore';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';

export default {
  // 其他基础配置（入口、输出等）
  plugins: [
    // 列出所有你不需要的数据库驱动
    ignore(['pg', 'tedious', 'sqlite3', 'oracledb']),
    // 必须配合commonjs和resolve插件处理Knex的CommonJS模块
    commonjs(),
    resolve()
  ]
};

方案2：通过external配置排除未使用的驱动 #

如果你的应用在Node环境运行，允许依赖单独安装而不打包进产物，可以直接把不需要的驱动设为外部依赖：

import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';

export default {
  // 其他基础配置
  external: ['pg', 'tedious', 'sqlite3', 'oracledb'],
  plugins: [commonjs(), resolve()]
};

方案3：让Rollup识别Knex的条件分支（推荐） #

利用@rollup/plugin-replace注入客户端类型，帮助Rollup静态分析并剔除无用代码分支：

先安装插件：

npm install @rollup/plugin-replace --save-dev

配置rollup.config.js：

import replace from '@rollup/plugin-replace';
import commonjs from '@rollup/plugin-commonjs';
import resolve from '@rollup/plugin-node-resolve';

export default {
  // 其他基础配置
  plugins: [
    replace({
      preventAssignment: true,
      // 注入你实际使用的客户端类型，比如'mysql'
      'process.env.KNEX_CLIENT': JSON.stringify('mysql')
    }),
    commonjs({
      // 配合忽略未使用的驱动
      ignore: ['pg', 'tedious', 'sqlite3']
    }),
    resolve()
  ]
};

同时确保你的Knex初始化代码明确指定客户端：

const knex = require('knex')({
  client: 'mysql',
  // 数据库连接配置...
});

这样Rollup就能识别出只有mysql相关代码会被执行，自动剔除其他驱动的引入逻辑。

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