在 NodeJS 中使用 Joi 验证环境变量

想象一下您正处于一个项目的最后阶段，一切都准备就绪，然后繁荣起来！由于环境变量丢失或配置错误，应用程序崩溃。听起来很熟悉吗？如果你去过那里，你就会知道那种挫败感。但不要害怕，因为 Joi 来拯救世界！

在这篇博文中，我们将探讨如何使用 Joi 来验证环境变量并设置默认值，确保您的应用程序在所有环境中顺利运行。

问题

环境变量就像我们应用程序的无名英雄。它们掌握着敏感信息、数据库连接和各种配置设置的密钥。但能力越大，责任越大：

• 缺少变量：“为什么我的应用程序没有连接到数据库？”糟糕，忘记设置 DATABASE_URL。
• 不正确的数据类型：“为什么我的服务器正在监听端口‘三千’？” PORT 变量中的拼写错误。
• 配置不一致：开发工作正常，但生产却是一场噩梦。
• 缺乏默认值：如果未设置某些变量，应用程序将失败。

这些问题可能会导致不眠之夜和疯狂的调试过程。但如果你可以完全避免它们呢？

输入乔伊

Joi 是一个强大的 JavaScript 模式描述和数据验证库。使用 Joi，您可以为环境变量定义架构，确保它们满足特定标准并在必要时设置默认值。

使用 Joi 验证和设置默认值的步骤

1。安装 Joi 和 dotenv
首先，您需要安装Joi。打开终端并运行：

npm install joi dotenv
# dotenv if you are reading env variables from .env file

2。创建配置文件
创建一个名为 config.js 的文件。我们将在这里定义架构并验证环境变量。

const Joi = require('joi');
const dotenv = require('dotenv');

// Load environment variables from .env file
dotenv.config();

// Define the schema
const envSchema = Joi.object({
  NODE_ENV: Joi.string().valid('development', 'production', 'test')
    .default('development'),
  PORT: Joi.number().default(3000),
  DATABASE_URL: Joi.string().uri().required(),
  API_KEY: Joi.string().required(),
  // Add more variables as needed
}).unknown(); // Allow unknown keys

// Validate the environment variables
const { error, value: envVars } = envSchema.validate(process.env, 
  { abortEarly: false }
);

if (error) {
  console.error('Config validation error(s):');
  error.details.forEach(detail => {
    console.error(`- ${detail.message}`);
  });
  throw new Error('Environment variables validation failed.');
}

// Export the validated and normalized environment variables
module.exports = {
  nodeEnv: envVars.NODE_ENV,
  port: envVars.PORT,
  databaseUrl: envVars.DATABASE_URL,
  apiKey: envVars.API_KEY,
  // Add more variables as needed
};

3。在您的应用程序中使用配置

const config = require('./config');

console.log(`Server is running on port ${config.port}`);
// Use config.databaseUrl, config.apiKey, etc.

有错误的示例
假设我们有以下 .env 文件：

NODE_ENV=development
PORT=not_a_number
DATABASE_URL=
API_KEY=my_api_key

当我们运行应用程序时，Joi 将验证这些变量。发生的情况是这样的：

1. PORT 设置为 not_a_number，这不是有效的号码。
2. DATABASE_URL 为空，这是无效的，因为它是必填字段。

当 Joi 验证这些变量时，它会抛出错误。

jaimin:~/joi-validate-env$ node index.js
Config validation error(s):
- "PORT" must be a number
- "DATABASE_URL" is not allowed to be empty
/home/jaimin/joi-validate-env/config.js:27
  throw new Error('Environment variables validation failed.');
  ^

Error: Environment variables validation failed.
    at Object.<anonymous> (/home/jaimin/joi-validate-env/config.js:27:9)
    at Module._compile (node:internal/modules/cjs/loader:1376:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)
    at Module.load (node:internal/modules/cjs/loader:1207:32)
    at Module._load (node:internal/modules/cjs/loader:1023:12)
    at Module.require (node:internal/modules/cjs/loader:1235:19)
    at require (node:internal/modules/helpers:176:18)
    at Object.<anonymous> (/home/jaimin/joi-validate-env/index.js:1:16)
    at Module._compile (node:internal/modules/cjs/loader:1376:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1435:10)

这份详细的错误报告有助于快速识别并修复环境配置中的问题。

为什么使用 Joi？

1。一致性
不再有“在我的机器上运行”的时刻。 Joi 确保设置所有必要的环境变量并在不同环境中具有正确的类型。

2。默认值
为变量设置默认值，降低由于缺少设置而导致运行时错误的风险。

3。早期错误检测
在启动阶段尽早捕获配置错误，防止应用程序以无效设置运行。

4。架构文档
充当环境变量的自记录模式，使新开发人员更容易理解所需的配置。

5。灵活性
允许复杂的验证逻辑，例如值范围、特定格式和自定义验证函数。

结论

使用 Joi 验证环境变量并设置默认值就像为您的应用程序建立了安全网。它确保您的应用程序在所有环境中顺利运行，避免意外崩溃和数小时的调试。

通过采用这种方法，您可以避免与环境变量相关的常见陷阱，并专注于构建为用户增加价值的功能。因此，继续吧，将 Joi 集成到您的项目中，然后您就可以安然入睡了，因为您知道您的环境变量都在良好的掌握之中。

编码愉快！

以上是在 NodeJS 中使用 Joi 验证环境变量的详细内容。更多信息请关注PHP中文网其他相关文章！