首頁  >  文章  >  web前端  >  在 Nest.js 中配置環境變數和多環境的最佳方法

在 Nest.js 中配置環境變數和多環境的最佳方法

WBOY
WBOY原創
2024-08-10 06:40:36354瀏覽

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