NodeJS에서 Joi를 사용하여 환경 변수 유효성 검사-JS 튜토리얼-php.cn

NodeJS에서 Joi를 사용하여 환경 변수 유효성 검사

WBOY

풀어 주다： 2024-07-26 11:46:30

원래의

489명이 탐색했습니다.

프로젝트의 마지막 단계에 있고 모든 것이 실행될 예정이라고 상상해 보세요. 환경 변수가 없거나 잘못 구성되어 앱이 충돌합니다. 익숙한 것 같나요? 가보신 분이라면 그 좌절감을 아실 겁니다. 하지만 두려워하지 마세요. Joi가 세상을 구하기 위해 여기 있으니까요!

Image description

이 블로그 게시물에서는 Joi를 사용하여 환경 변수를 검증하고 기본값을 설정하여 애플리케이션이 모든 환경에서 원활하게 실행되도록 하는 방법을 살펴보겠습니다.

문제

환경 변수는 애플리케이션의 알려지지 않은 영웅과 같습니다. 민감한 정보, 데이터베이스 연결 및 다양한 구성 설정에 대한 키를 보유합니다. 하지만 큰 힘에는 큰 책임이 따릅니다.

변수 누락: "내 앱이 데이터베이스에 연결되지 않는 이유는 무엇인가요?" 이런, DATABASE_URL을 설정하는 것을 잊었습니다.
잘못된 데이터 유형: "왜 내 서버가 '3천' 포트에서 수신 대기하고 있나요?" 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가 이러한 변수를 검증합니다. 일어나는 일은 다음과 같습니다.

PORT가 not_a_number로 설정되어 있으며 이는 유효한 숫자가 아닙니다.
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)

로그인 후 복사

이 상세한 오류 보고서는 환경 구성의 문제를 신속하게 식별하고 해결하는 데 도움이 됩니다.