NodeJS API生产环境依赖问题及最佳实践咨询

问题背景 #

我是NodeJS新手，正在开发NodeJS API并部署到Render平台，设置node_env为生产环境，但云环境报错：

"Error: Cannot find module 'morgan'"

猜测是开发依赖未安装，将原构建命令npm install改为npm install --dev后恢复正常。现提出两个问题：

1. 当前代码通过if语句在生产环境禁用开发逻辑，但部署时仍需安装开发依赖，NodeJS API的开发与生产环境管理最佳实践是什么？
2. 是否存在生产环境无需安装开发依赖的实现方式？

项目配置与代码示例 #

package.json

{
  "name": "bnndirect_api",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "nodemon server"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "cors": "^2.8.5",
    "dotenv": "^16.3.1",
    "express": "^4.18.2",
    "express-mongo-sanitize": "^2.2.0",
    "express-rate-limit": "^7.1.5",
    "helmet": "^7.1.0",
    "hpp": "^0.2.3",
    "perfect-express-sanitizer": "^1.0.13"
  },
  "devDependencies": {
    "morgan": "^1.10.0",
    "nodemon": "^3.0.2"
  }
}

server.js中开发依赖使用代码

const morgan = require("morgan");
// DEV LOGGING MIDDLEWARE
if (process.env.NODE_ENV === "development") {
  app.use(morgan("dev"));
}

问题解答 #

1. NodeJS API开发与生产环境管理最佳实践 #

• 严格区分依赖类型：将仅用于开发阶段的工具（如nodemon、morgan）放在devDependencies，生产环境必需的核心库（express、cors等）放在dependencies，减少生产环境冗余依赖，降低部署体积和安全风险。
• 标准化脚本命令：在package.json的scripts中明确区分开发、生产命令，示例：

  "scripts": {
    "dev": "nodemon server.js",
    "start": "node server.js",
    "build": "npm install --production"
  }
  

  部署时执行npm run build仅安装生产依赖，再用npm start启动服务。
• 环境配置分离：用dotenv加载不同环境的配置文件（如.env.development、.env.production），避免开发配置泄露到生产环境。
• 环境变量控制逻辑：保持用process.env.NODE_ENV区分环境的写法，但要确保生产环境代码完全不触发开发依赖的加载逻辑。

2. 生产环境无需安装开发依赖的实现方式 #

核心是让生产环境代码完全不引用开发依赖，你的当前写法问题在于无论环境如何都会先执行require('morgan')，NodeJS会尝试加载模块，导致报错。可以通过以下方式修改：

方法1：将require放在环境判断分支内

// DEV LOGGING MIDDLEWARE
if (process.env.NODE_ENV === "development") {
  const morgan = require("morgan");
  app.use(morgan("dev"));
}

生产环境下不会执行require('morgan')，自然不会触发模块找不到的错误。

方法2：使用ES Modules动态导入

如果项目启用ES Modules（在package.json中添加"type": "module"），可以用动态导入：

// DEV LOGGING MIDDLEWARE
if (process.env.NODE_ENV === "development") {
  import("morgan").then(({ default: morgan }) => {
    app.use(morgan("dev"));
  });
}

方法3：拆分中间件配置文件

创建config/middleware.js统一管理不同环境的中间件：

const express = require('express');
const cors = require('cors');

// 生产环境通用中间件
const productionMiddleware = [
  cors(),
  // 其他生产必需中间件...
];

// 开发环境追加中间件
const developmentMiddleware = [
  ...productionMiddleware,
  require('morgan')('dev')
];

module.exports = process.env.NODE_ENV === 'development' ? developmentMiddleware : productionMiddleware;

在server.js中引入使用：

const middleware = require('./config/middleware');
middleware.forEach(mw => app.use(mw));

修改后，部署时使用npm install --production（Render平台默认会执行此命令，除非自定义），仅安装dependencies内的包，无需加载devDependencies即可正常运行。

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