如何避免npm包重复编译？CI流程缓存优化问询

针对你遇到的pg-native、node-rdkafka这类需要本地编译的npm包，在npm ci时重复编译拖慢速度的问题，以下是几个可行的解决思路：

1. 缓存npm核心缓存目录 #

npm会将下载过的包（包括预编译的二进制版本）存在专属缓存目录里，只要缓存这个目录，npm ci时就会优先从缓存读取，避免重新编译：

• 先通过npm config get cache获取CI环境中npm缓存的具体路径
• 在CI配置（如GitHub Actions、GitLab CI等）里，将这个目录设为缓存对象，缓存key建议结合package-lock.json的哈希值、Node.js版本、操作系统类型生成，确保只有当依赖或环境变化时才重新缓存
• 示例（GitHub Actions）：

  - name: Cache npm dependencies
    uses: actions/cache@v3
    with:
      path: |
        ${{ steps.npm-cache-dir.outputs.dir }}
        ~/.node-gyp
      key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
      restore-keys: |
        ${{ runner.os }}-node-${{ matrix.node-version }}-
  

2. 强制使用预编译二进制包 #

很多需要编译的npm包会提供对应不同系统、Node版本的预编译二进制包，可通过环境变量强制npm优先下载这些包，跳过本地编译：

• 执行npm ci前设置环境变量：

  export npm_config_build_from_source=false
  

  这个变量会告诉npm：除非找不到对应环境的预编译包，否则不进行本地编译。

3. 缓存node-gyp的编译缓存 #

node-gyp是npm编译原生模块的工具，它会缓存编译过程中的中间文件，缓存这个目录能进一步减少重复编译时间：

• node-gyp的缓存目录通常是~/.node-gyp（Linux/macOS）或%USERPROFILE%\.node-gyp（Windows），将这个目录加入CI的缓存配置即可。

为什么之前的方法失效？ #

• 全局安装pg-native：npm ci严格按照项目的package-lock.json安装本地依赖，全局包不会被项目引用，因此项目仍会重新安装并编译本地版本。
• peerDependencies方案：npm 7及以后会自动安装peer依赖，不再需要手动处理，所以这个临时方案自然失效。

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