Переменные окружения — это динамические именованные значения, которые могут влиять на поведение программной системы. Они часто используются для хранения конфиденциальной информации, такой как учетные данные базы данных, API-ключи и другие настройки, которые могут изменяться в зависимости от среды, в которой работает приложение (например, разработка, тестирование или производство).

В NestJS, как и в других современных фреймворках, использование переменных окружения помогает изолировать настройки конфигурации от кода и обеспечить более безопасный и гибкий процесс развертывания.

Как использовать переменные окружения в NestJS?

NestJS предоставляет встроенную поддержку для работы с переменными окружения через пакет @nestjs/config. Вот пошаговое руководство по настройке и использованию переменных окружения в вашем приложении.

Установка зависимостей:
Сначала необходимо установить пакет @nestjs/config. Сделайте это с помощью команды:

npm install @nestjs/config

Создание файла .env:
Создайте файл .env в корне вашего проекта. В этом файле вы можете определить свои переменные окружения:

DATABASE_URL=postgres://user:password@localhost:5432/mydatabase
JWT_SECRET=my_super_secret_key
NODE_ENV=development

Импортирование модуля конфигурации:
В вашем основном модуле приложения (обычно в app.module.ts), импортируйте и настройте модуль ConfigModule:

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // Делаем ConfigModule глобальным
    }),
    // другие модули вашего приложения
  ],
})
export class AppModule {}

Использование переменных окружения:
Теперь вы можете использовать переменные окружения в ваших сервисах и контроллерах. Для этого вам нужно инжектировать ConfigService:

import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';

@Injectable()
export class AppService {
  constructor(private configService: ConfigService) {}

  getDatabaseUrl(): string {
    return this.configService.get<string>('DATABASE_URL');
  }

  getJwtSecret(): string {
    return this.configService.get<string>('JWT_SECRET');
  }
}

Запуск приложения:
Убедитесь, что ваш файл .env находится в корне проекта, и запустите приложение. Переменные окружения будут загружены автоматически, и вы сможете получить к ним доступ в любом сервисе или контроллере.

Преимущества использования переменных окружения

Безопасность: Конфиденциальные данные, такие как пароли и токены, не должны быть жестко закодированы в приложении.
Гибкость: Легко менять настройки для разных сред (разработка, тестирование, производство) без изменения кода.
Удобство: Упрощает управление конфигурацией, особенно в больших приложениях или командах.

Заключение

Использование переменных окружения в NestJS — это простой и эффективный способ управления конфигурациями вашего приложения. С их помощью вы можете обеспечить безопасность и гибкость, что крайне важно в современном программировании. Не забывайте, что переменные окружения могут быть загружены из различных источников, таких как Docker, CI/CD системы и другие, что делает их особенно полезными в рамках DevOps практик.

Предыдущий вопрос

Какой файл является входным в приложении NestJS?

Следующий вопрос

Какова цель ExecutionContext в NestJS?

Содержание:

Преимущества использования переменных окружения

Заключение

Редактировать