Робота з ConfigService · fullstack.org.ua

Початковий11 хв· Fullstack Team

Робота з ConfigService

Навчитеся отримувати типізовані значення конфігурації через ConfigService у модулях і сервісах.

Навіщо потрібен `ConfigService`

Конфігурація застосунку часто залежить від середовища, у якому він запускається:

порт HTTP-сервера;
назва застосунку;
адреса бази даних;
секретні ключі;
режими development або production.

Такі значення зручно зберігати у змінних середовища, наприклад у файлі .env, а отримувати в коді через ConfigService.

Пакет @nestjs/config надає:

ConfigModule — модуль для підключення конфігурації;
ConfigService — сервіс для читання значень конфігурації.

Встановлення пакета

Якщо пакет ще не встановлено, додайте його до проєкту:

bash

npm install @nestjs/config

typescript

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AppService } from './app.service';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
  providers: [AppService],
})
export class AppModule {}

typescript

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

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

  getApplicationInfo() {
    const appName = this.configService.get<string>(
      'APP_NAME',
      'Невідома назва',
    );

    const nodeEnv = this.configService.get<string>(
      'NODE_ENV',
      'development',
    );

    const port = Number(
      this.configService.get<string>('PORT', '3000'),
    );

    return {
      appName,
      nodeEnv,
      port,
    };
  }
}

typescript

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { AppService } from './app.service';

export interface AppOptions {
  name: string;
  port: number;
}

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
  providers: [
    AppService,
    {
      provide: 'APP_OPTIONS',
      inject: [ConfigService],
      useFactory: (configService: ConfigService): AppOptions => {
        const name = configService.get<string>(
          'APP_NAME',
          'NestJS застосунок',
        );

        const port = Number(
          configService.get<string>('PORT', '3000'),
        );

        return {
          name,
          port,
        };
      },
    },
  ],
  exports: ['APP_OPTIONS'],
})
export class AppModule {}

typescript

import { Inject, Injectable } from '@nestjs/common';
import { AppOptions } from './app.module';

@Injectable()
export class AppInfoService {
  constructor(
    @Inject('APP_OPTIONS')
    private readonly options: AppOptions,
  ) {}

  getInfo() {
    return this.options;
  }
}

typescript

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AppService } from './app.service';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
    }),
  ],
  providers: [AppService],
  exports: [AppService],
})
export class AppModule {}

typescript

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

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

  getAppName(): string {
    return this.configService.get<string>(
      'APP_NAME',
      'NestJS застосунок',
    );
  }

  getEnvironment(): string {
    return this.configService.get<string>(
      'NODE_ENV',
      'development',
    );
  }

  getPort(): number {
    const port = Number(
      this.configService.get<string>('PORT', '3000'),
    );

    if (Number.isNaN(port)) {
      throw new Error('Значення PORT має бути числом');
    }

    return port;
  }
}

typescript

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { AppService } from './app.service';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const appService = app.get(AppService);

  const port = appService.getPort();

  await app.listen(port);

  console.log(
    `${appService.getAppName()} запущено в режимі ${appService.getEnvironment()}`,
  );
  console.log(`Порт: ${port}`);
}

bootstrap();

typescript

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { UsersModule } from './users/users.module';

@Module({
  imports: [
    ConfigModule.forRoot(),
    UsersModule,
  ],
})
export class AppModule {}

typescript

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { UsersService } from './users.service';

@Module({
  imports: [ConfigModule],
  providers: [UsersService],
})
export class UsersModule {}

typescript

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

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

  getUsersEndpoint(): string {
    const apiUrl = this.configService.get<string>(
      'USERS_API_URL',
      'http://localhost:3001',
    );

    return `${apiUrl}/users`;
  }
}

Робота з ConfigService

Навіщо потрібен `ConfigService`

Встановлення пакета

Підключення `ConfigModule`

Файл `.env`

Файл `app.module.ts`

Отримання конфігурації в сервісі

Типізація значень

Значення за замовчуванням