首页  >  文章  >  web前端  >  在 Nest.js 中配置环境变量和多环境的最佳方法

在 Nest.js 中配置环境变量和多环境的最佳方法

WBOY
WBOY原创
2024-08-10 06:40:36352浏览

The Best way to configure environment variables and multi environments in Nest.js

我真正喜欢Nest.js的是它是一个强大的完整的node.js框架,为您提供了构建的完整解决方案后端应用程序。

它从一开始就内置了 TypeScript 支持,并结合了 OOP(面向对象编程)、FP(函数式编程)和 FRP(函数响应式编程),正如官网所说。

它从一开始就具有架构,这对于像我这样喜欢处理良好结构化架构项目的人来说是令人惊奇的。

光是文档就让人印象深刻,涵盖了方方面面,包括如何设置环境变量,但对我来说
我不太明白如何设置多个环境。

可能是因为我对node.js和nestjs比较陌生,但是当我在网上查找文章时,他们总是展示一种直接使用dotenv库的方式,而不是原生使用nestjs,后者在引擎盖。

经过几个小时查看文档旁边的文章后,我找到了一个 Nestjs 原生的解决方案,并认为我会分享它。


第一

假设我们的项目需要 2 个环境 'dev''prod'
每个环境我们需要 2 个环境变量:PORTDATABASE_URL.

1- 创建 2 个 .env 文件来存储  PORTDATABASE_URL 并命名文件(.env.dev.env.prod.

PORT=3500

DATABASE_URL="file:./dev.db"`

2- 创建一个名为 NODE_ENV 的环境变量,但这一次我们不是将其存储在 .env 文件中,而是将其注入到 dev 和 prod 的启动脚本中。

设置 NODE_ENV 跨平台(windows、mac 或 Linux)可能会有所不同,因此我们将安装一个 cross-div 包以允许我们跨平台设置环境变量。

使用 npm 安装

$ npm install --save-dev cross-env

或使用 pnpm

$ pnpm install --save-dev cross-env

然后,修改 package.json 脚本以使用跨环境:

"scripts": {
    "start:dev": "cross-env-shell NODE_ENV=dev nest start --watch",
    "start:prod": "cross-env-shell NODE_ENV=prod node dist/main",
}

所以现在当您使用
运行应用程序时

npm run start:dev 


pnpm run start:dev

您拥有NODE_ENV=dev,并且您可以在整个应用程序中使用它。

3-为了让Nestjs读取.env文件,我们必须使用ConfigModule并正确配置它,但首先我们需要安装它。

npm

$ npm i --save @nestjs/config

pnpm

$ pnpm i --save @nestjs/config

4- 使用 ConfigModule :

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: `.env.${process.env.NODE_ENV}`,
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

envFilePath:用于指定 .env 文件的另一个路径。 
或读取与默认 .env 文件不同的文件

.env.${process.env.NODE_ENV} 将转换为 .env.dev
如果我们运行命令

npm run start:prod

.env.${process.env.NODE_ENV} 将翻译为 .env.prod.

5- 如何访问我们的环境变量
要访问环境变量,我们使用 ConfigModule.

我们可以在main.ts
中使用它

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

  const configService = app.get(ConfigService);
  const port = configService.get('PORT');

  await app.listen(port);
}

或者如果我们在其他地方需要它,我们使用注入。
例如

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

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

以上是在 Nest.js 中配置环境变量和多环境的最佳方法的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn