多Dockerfile与单package.json场景下子应用精简依赖方案问询

核心思路 #

通过在构建阶段（或CI预构建阶段），基于子应用目录下的dependencies.json规则，从根目录的package.json中过滤出子应用实际需要的依赖，生成专属的精简版package.json，从而减少Docker镜像中安装的依赖体积。

方案1：Docker构建时动态生成精简package.json #

步骤1：编写依赖过滤脚本 #

在项目根目录创建filter-deps.js脚本，用来处理依赖过滤逻辑：

const fs = require('fs');
const path = require('path');

// 接收子应用目录作为参数
const appDir = process.argv[2];
// 读取根package.json和子应用的依赖配置
const rootPkg = require(path.join(__dirname, 'package.json'));
const appDepsConfig = require(path.join(appDir, 'dependencies.json'));

let filteredDeps = {...rootPkg.dependencies};

// 按配置过滤依赖
if (appDepsConfig.dependencies) {
  // 仅保留指定依赖
  filteredDeps = Object.fromEntries(
    Object.entries(filteredDeps).filter(([name]) => appDepsConfig.dependencies.includes(name))
  );
} else if (appDepsConfig.antiDependencies) {
  // 排除指定依赖
  appDepsConfig.antiDependencies.forEach(name => delete filteredDeps[name]);
}

// 生成精简版package.json（清空devDependencies，按需调整）
const trimmedPkg = {
  ...rootPkg,
  dependencies: filteredDeps,
  devDependencies: {}
};

fs.writeFileSync(path.join(appDir, 'package.json'), JSON.stringify(trimmedPkg, null, 2));

步骤2：修改子应用Dockerfile #

以app1为例，在其Dockerfile中加入脚本调用逻辑：

FROM node:18-alpine

# 复制根目录的核心文件
COPY package.json /app/
COPY filter-deps.js /app/

# 复制子应用的代码和依赖配置
COPY app1/ /app/app1/

# 进入子应用目录，生成精简package.json
WORKDIR /app/app1
RUN node ../filter-deps.js .

# 仅安装生产依赖
RUN npm install --only=production

# 后续构建/启动步骤
...

方案2：CI/CD预构建阶段生成精简package.json #

如果希望Docker构建环节更简洁，可以在CI流水线中提前生成好各子应用的精简package.json：

1. 在CI步骤中，遍历所有子应用目录，执行node filter-deps.js ./app1、node filter-deps.js ./app2等命令，生成对应目录的精简package.json
2. 将生成的文件纳入构建上下文，Dockerfile直接复制该文件并执行npm install即可

辅助优化：精准识别依赖 #

如果不确定子应用实际用到哪些依赖，可以用工具辅助分析：

• 用depcheck扫描子应用代码，自动识别未使用的依赖，直接生成antiDependencies列表
• 用webpack-bundle-analyzer分析子应用的打包产物，明确实际加载的依赖，整理成dependencies列表

注意事项 #

• 嵌套依赖无需手动处理：npm install会自动安装目标依赖的嵌套依赖，不需要在dependencies.json中额外声明
• 若根package.json包含peerDependencies，需根据子应用的运行环境判断是否保留
• 必须验证精简后的依赖是否能正常运行，避免漏删核心依赖

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