NestJS - 如何在主应用程序模块文件中使用 .env 变量进行数据库连接

NestJS - How to use .env variables in main app module file for database connection

我正在开发我的第一个 NestJS 应用程序,它在 app.module.ts.

中与硬编码数据库连接字符串一起工作正常

但是根据我们的要求,我不得不从环境文件中选择数据库配置值。为此,我遵循了 nestjs 文档网站上的配置文档 - https://docs.nestjs.com/techniques/configuration

但问题是我需要在同一个文件中使用 .env 变量进行数据库连接,这是失败的。

这是我运行良好的原始代码:

@Module({
  imports: [
    MongooseModule.forRoot(`mongodb+srv://myusername:mypassword@myhost.net?retryWrites=true&w=majority&db=dbname`, { useNewUrlParser: true, dbName: 'dbname' }),
    ProductModule,
    CategoryModule,
  ],
  controllers: [
    AppController,
    HealthCheckController,
  ],
  providers: [AppService, CustomLogger],
})

现在,我想根据环境从 .env 文件中选择那些数据库值,例如 local.envdev.env 等。现在,我的这段代码不起作用:

@Module({
  imports: [
    ConfigModule.forRoot({ envFilePath: `${process.env.NODE_ENV}.env` }),
    MongooseModule.forRoot(`mongodb+srv://${ConfigModule.get('DB_USER')}:${ConfigModule.get('DB_PASS')}@myhost.net?retryWrites=true&w=majority&db=dbname`, { useNewUrlParser: true, dbName: 'dbname' }),
    ProductModule,
    CategoryModule,
  ],
  controllers: [
    AppController,
    HealthCheckController,
  ],
  providers: [AppService, CustomLogger],
})

您需要使用 MongooseModule.forRootAsync(() => {...}) 而不是 MongooseModule.forRoot(...)

这使得 MongooseModule 等待其 IOC 依赖项。

参见:https://docs.nestjs.com/techniques/mongodb#async-configuration

1.继续使用 ConfigModule

你需要在npm scripts中设置NODE_ENV,这样才能根据env加载一个env文件。

"scripts": {
  "start:local": "NODE_ENV=local npm run start"
  "start:dev": "NODE_ENV=dev npm run start"
}

现在您可以使用 ConfigModule:

@Module({
  imports: [
    ConfigModule.forRoot({ envFilePath: `${process.env.NODE_ENV}.env` }), 
MongooseModule.forRoot(`mongodb+srv://${process.env.DB_USER}:${process.env.DB_PASS}@myhost.net?retryWrites=true&w=majority&db=dbname`, { useNewUrlParser: true, dbName: 'dbname' })
    ...
})

2。使用 dotenv

npm install dotenv

将一些脚本添加到您的 package.json 以设置您所在的环境。

"scripts": {
  ...
  "start:local": "NODE_ENV=local npm run start"
  "start:dev": "NODE_ENV=dev npm run start"
}

main.ts 文件中导入 dotenv。确保在文件顶部执行此操作。

require('dotenv').config({ path: `../${process.env.NODE_ENV}.env` });

3。使用 env-cmd

您可以使用 env-cmd npm 包。

npm install env-cmd

并在package.json中添加一些针对不同环境的命令,例如:

"scripts": {
  ...
  "start:local": "env-cmd -f local.env npm run start"
  "start:dev": "env-cmd -f dev.env npm run start"
}
...

现在您可以使用环境变量,例如:

MongooseModule.forRoot(`mongodb+srv://${process.env.DB_USER}:${process.env.DB_PASS}@myhost.net?retryWrites=true&w=majority&db=dbname`, { useNewUrlParser: true, dbName: 'dbname' })

process.env.MONGO_CONNECTION_STRING

来自此处的 Nestjs 文档 - https://docs.nestjs.com/techniques/configuration

这些步骤适用于 MySQL 和 TypeORM。

  1. 安装 Nestjs 配置模块 - npm i --save @nestjs/config。它依赖于 dotenv

  2. 在您的根文件夹中创建一个 .env 文件并添加您的 key/value 对,例如DATABASE_USER=myusername

  3. 打开app.module.ts并导入配置模块

    import { ConfigModule } from '@nestjs/config';
  1. 将下行添加到 app.module.ts 的导入部分。我将它添加为第一次导入。它会自动加载 .env 文件的内容。
    ConfigModule.forRoot(),
  1. 然后您可以开始使用环境变量,按照通常的 process.env. 在数据库配置部分,例如
    process.env.DATABASE_USER

ConfigModule的更多配置,见上文link。您可以使用自定义 file/path 并将模块设置为全局可见。

通过使用 nestjs/config 包:

npm install @nestjs/config

安装包后,在应用程序模块(app.module.ts 文件)中:

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

@Module({
  imports: [ConfigModule.forRoot()],
})

export class AppModule {}

之后.env 文件可以在整个应用程序中访问。 假设您的 .env 文件如下所示。

DB_USER=mohit

访问 DB_USER 变量使用 process.env.DB_USER

MongooseModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    uri: configService.get<string>('MONGODB_URI'),
  }),
  inject: [ConfigService],
});