如何使用接口从 Nestjs 中的自定义配置文件中获取值？

Question

我正在尝试在“config.ts”中的一个文件中设置我的所有配置，将其加载到 ConfigService，然后使用配置接口从中获取值。所以这是我的 config.ts，其中包含来自我的 .env 文件和静态变量的 ENV 变量。

import { Config } from './config.interface';

const config: Config = {
  typeorm: {
    type: 'postgres',
    host: process.env.DB_HOST,
    port: +process.env.DB_PORT,
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    synchronize: process.env.NODE_ENV !== 'prod',
    logging: true,
    entities: [User, RefreshToken],
  },
};

export default () => config;

这是我的界面：

export interface Config {
  typeorm: TypeOrmConfig;
}

export interface TypeOrmConfig {
  type: string;
  host: string;
  port: number;
  username: string;
  password: string;
  database: string;
  synchronize: boolean;
  logging: boolean;
  entities: any[];
}

配置加载到 app.module.ts

中的 ConfigModule

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: '.dev.env',
      load: [config],
    }),
}),

例如，我想用这个设置来设置我的 TypeOrmModule。基于 NestJs 文档

TypeOrmModule.forRootAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => {
        const config = configService.get<TypeOrmConfig>('typeorm');
        console.log(config);
        return {
          type: config.type,
          host: config.host,
          port: +config.port,
          username: config.username,
          password: config.password,
          database: config.database,
          synchronize: config.synchronize,
          logging: config.logging,
          entities: config.entities,
        };
      },
      inject: [ConfigService],
    }),

问题来了。配置中的静态值没问题，但我所有的 ENV 变量都未定义。这是 console.log 输出：

{
  type: 'postgres',
  host: undefined,
  port: NaN,
  username: undefined,
  password: undefined,
  database: undefined,
  synchronize: true,
  logging: true,
  entities: [
    [class User extends CoreEntity],
    [class RefreshToken extends CoreEntity]
  ]
}

我不明白未定义的 ENV 变量有什么问题如果有任何解释和帮助，我将不胜感激

Answer 1

简而言之，NestJS 要求您为您尝试在此处访问的自定义配置“typeorm”定义一个命名空间（参见 Configuration Namespace）：

const config = configService.get<TypeOrmConfig>('typeorm');

这意味着您必须使用 registerAs 函数来创建您的命名空间：

import { registerAs } from '@nestjs/config';
import { TypeOrmConfig } from './config.interface';

export default registerAs(
  'typeorm',
  (): TypeOrmConfig => ({
    type: 'postgres',
    host: process.env.DB_HOST,
    port: +process.env.DB_PORT,
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    synchronize: process.env.NODE_ENV !== 'prod',
    logging: true,
    entities: [],
  }),
);

这样就可以了。但是，我们可以对此进行改进。

无需为 TypeORM 配置定义您自己的接口，您可以使用和/或扩展现有接口来减少样板代码（下面我提到 ConnectionOptions 虽然 TypeOrmModuleOptions 可能更多取决于您的配置需要）。我还建议为环境变量提供后备值：

import { registerAs } from '@nestjs/config';
import { ConnectionOptions } from 'typeorm';

const CONNECTION_TYPE = 'postgres';

export default registerAs(
  'typeorm',
  (): ConnectionOptions => ({
    type: CONNECTION_TYPE,
    host: process.env.DB_HOST || 'default_value',
    port: +process.env.DB_PORT || 3000,
    username: process.env.DB_USERNAME || 'default_value',
    password: process.env.DB_PASSWORD || 'default_value',
    database: process.env.DB_NAME || 'default_value',
    synchronize: process.env.NODE_ENV !== 'prod',
    logging: true,
    entities: [],
  }),
);

此外，无需再次显式地将配置值分配给 TypeOrmModule，您可以简单地执行以下操作：

TypeOrmModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) =>
    await configService.get('typeorm'),
  inject: [ConfigService],
}),

作为个人风格，我喜欢创建配置枚举以包含配置名称以防止拼写错误。考虑一下：

export enum ConfigEnum {
  TYPEORM = 'typeorm',
}

TypeOrmModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) =>
    await configService.get<Promise<TypeOrmModuleOptions>>(
      ConfigEnum.TYPEORM,
    ),
  inject: [ConfigService],
})

Async / Await 模式在这里也是多余的，因为我们实际上并没有执行任何异步操作，所以这也可以工作：

TypeOrmModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: (configService: ConfigService) =>
    configService.get<TypeOrmModuleOptions>(ConfigEnum.TYPEORM),
  inject: [ConfigService],
})

欢迎使用 Whosebug！

Ps。我已经提出了拉取请求，请参阅 https://github.com/JustDenP/nest-config/pull/1

如何使用接口从 Nestjs 中的自定义配置文件中获取值？

How to get values from custom configuration file in Nestjs with interface?

node.js

environment-variables

nestjs

nestjs-config