NodeJS+TypeScript项目中.env变量缺失的错误检查实现方案

我来帮你搞定这个问题！你的当前实现无效，主要是因为配置初始化时的逻辑抵消了后续的错误检查，咱们一步步拆解并修复：

问题根源分析 #

1. 带默认值的变量永远不会触发错误：比如serverPort: +process.env.SERVER_PORT || 4000，当SERVER_PORT未设置时，process.env.SERVER_PORT是undefined，转成数字后是NaN，NaN || 4000会直接返回4000，导致后续!config.serverPort的判断永远为假，不会抛出错误。
2. 字符串变量的检查存在隐患：虽然serverUrl如果未设置会是undefined，!config.serverUrl理论上会触发错误，但如果你的.env文件路径不正确（dotenv没加载到），或者变量被设置为空字符串，当前的检查逻辑也会失效，且整体代码重复冗余。

正确实现方案 #

最佳实践是在获取环境变量时就进行校验，而不是先赋值再检查。我们可以封装一个工具函数，统一处理变量的获取、转换和校验，这样代码更简洁，错误提示也更精准。

完整修复后的代码 #

import dotenv = require('dotenv');

// 确保dotenv加载.env文件，若.env不在根目录，可指定path参数：dotenv.config({ path: './config/.env' })
dotenv.config();

export interface Config {
  // Server settings
  serverPort: number;
  serverUrl: string;
  // Database settings
  dbPort: number;
  dbHost: string;
  dbUsername: string;
  dbPassword: string;
  database: string;
}

/**
 * 获取环境变量，若变量缺失则抛出明确错误
 * @param key 环境变量名称
 * @param transform 可选的转换函数（比如将字符串转为数字）
 */
function getEnv<T = string>(key: string, transform?: (value: string) => T): T {
  const value = process.env[key];
  // 若变量未定义或为空字符串，抛出错误
  if (!value) {
    throw new Error(`Environment variable "${key}" is not defined or empty`);
  }
  // 若有转换函数，执行转换后返回，否则直接返回原字符串
  return transform ? transform(value) : (value as unknown as T);
}

const config: Config = {
  // Server
  serverPort: getEnv('SERVER_PORT', (val) => parseInt(val, 10)),
  serverUrl: getEnv('SERVER_URL'),
  // Database
  dbPort: getEnv('DB_PORT', (val) => parseInt(val, 10)),
  dbHost: getEnv('DB_HOST'),
  dbUsername: getEnv('DB_USERNAME'),
  dbPassword: getEnv('DB_PASSWORD'),
  database: getEnv('DB_DATABASE'),
};

export { config };

错误展示位置 #

当某个环境变量缺失时，错误会在应用启动时的控制台直接抛出，应用会终止运行，并显示清晰的错误信息（比如Error: Environment variable "SERVER_URL" is not defined or empty）以及错误栈，方便你快速定位问题。

可选优化：支持带默认值的非必填变量 #

如果某些变量是可选的（允许缺失时使用默认值），可以单独处理：

// 示例：serverPort可选，默认值4000
serverPort: process.env.SERVER_PORT ? parseInt(process.env.SERVER_PORT, 10) : 4000,

注意事项 #

• 确保.env文件放置在项目根目录（或通过dotenv.config的path参数指定正确路径），否则dotenv无法加载变量。
• 转换数字时务必指定基数10（parseInt(val, 10)），避免将以0开头的字符串解析为八进制数。
• 如果允许空字符串作为变量的有效值，可修改getEnv中的判断逻辑为if (value === undefined)，这样空字符串不会触发错误。

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