Node.js / 系统课时

区分生产与开发依赖

区分生产与开发依赖

把依赖放错位置,最常见的结果不是立刻报错,而是生产镜像被塞进测试工具,或部署时缺少运行库。本课用一个最小 npm 项目演示如何判断、写入并验证两类依赖,并说明生产安装时如何真正排除开发依赖。

学习目标

  • 能按“运行时是否必须存在”判断 dependencies 与 devDependencies
  • 能用 npm 命令把包写入正确字段并检查 package.json
  • 能在生产安装中明确排除开发依赖,并识别常见错分

用运行阶段判断依赖归属

最实用的判断方法是:把构建、测试、格式化都做完后,只保留要部署的程序;如果删掉某个包会让程序无法启动或无法处理请求,它通常属于 dependencies。 反之,只在开发、测试、构建阶段使用的工具通常放进 devDependencies。

包或用途 推荐位置 判断依据
express、pg、jsonwebtoken dependencies 服务运行时会直接加载
eslint、prettier devDependencies 只做检查或格式化
typescript devDependencies 已在部署前编译为 JavaScript 时,生产运行不需要编译器
@types/node devDependencies 只参与类型检查,不参与运行

一个常见边界是“构建工具”。例如前端项目用 Vite 构建静态资源,如果服务器只部署 dist 目录,那么 Vite 是开发依赖;如果生产进程启动时还要现场调用某个构建器,它就成了运行依赖,不过这种部署方式通常应先重新设计。

用 npm 写入并核对两类依赖

下面示例假设当前目录已经创建好这个最小 package.json。固定版本只是为了让练习可复现;真实项目是否允许自动升级,应另行决定版本范围。

json
{
  "name": "dep-demo",
  "version": "1.0.0",
  "private": true
}

在该目录执行以下命令。--save-exact 会让示例直接写入精确版本,避免本机 npm 的 save-prefix 配置影响结果。

bash
npm install --silent --save-exact lodash@4.17.21
npm install --silent --save-dev --save-exact prettier@3.3.3
node -e "const p=require('./package.json'); console.log(p.dependencies.lodash); console.log(p.devDependencies.prettier)"

预期输出:

text
4.17.21
3.3.3

执行后,lodash 位于 dependencies,prettier 位于 devDependencies。不需要手工移动 JSON 字段;如果装错了,可以重新执行 npm install --save-prod 包名 或 npm install --save-dev 包名,npm 会更新声明。

生产安装要显式省略开发依赖

生产服务器或容器已有 package-lock.json 时,优先使用 npm ci --omit=dev。它会按锁文件安装确定的依赖图,同时不把开发依赖放进 node_modules;devDependencies 仍保留在 package.json 和锁文件里,方便后续开发与审计。

本地开发则直接使用 npm ci,让测试器、类型检查器和格式化工具都可用。不要把“是否安装开发依赖”完全寄托在 NODE_ENV 上:NODE_ENV 主要描述应用运行环境,安装策略用 --omit=dev 写在 CI 或 Docker 构建命令中更明确。

常见错分怎么修正

第一类错误是把“代码里没有直接 require”当成开发依赖判断标准。数据库驱动、日志库、模板引擎即使只被间接模块调用,只要生产进程需要它们,就必须确保它们出现在可安装的生产依赖图中。

第二类错误是把测试框架、Linter、类型声明全部塞进 dependencies。这通常不会让程序坏掉,却会增加镜像体积、安装时间和供应链暴露面。修正时先查看 package.json,再按“部署后的进程是否需要”逐项归类,最后用干净目录执行一次 npm ci --omit=dev 并启动应用,确认没有 MODULE_NOT_FOUND 等缺包错误。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

区分生产与开发依赖

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通