快捷導(dǎo)航

Nest.js環(huán)境變量配置與序列化詳解

更新時(shí)間：2021年02月21日 10:25:18 作者：Jaxson Wang

這篇文章主要給大家介紹了關(guān)于Nest.js環(huán)境變量配置與序列化的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

環(huán)境變量配置簡(jiǎn)述

程序在不同的環(huán)境下需要不同的環(huán)境變量，例如生產(chǎn)環(huán)境、測(cè)試環(huán)境以及開發(fā)環(huán)境所需要不同的數(shù)據(jù)庫(kù)信息：鏈接地址、鏈接端口號(hào)、登錄用戶名和密碼相關(guān)信息。為了解決這個(gè)問(wèn)題需要進(jìn)行相關(guān)操作。

在 Nest 中最佳方案創(chuàng)建一個(gè) ConfigModule，該 ConfigModule 公開一個(gè) ConfigService ，在 ConfigService 加載特有環(huán)境的 .env 文件。 Nest 提供了 @nestjs/config 開箱即用的依賴包。

配置

npm 生態(tài)有很多相關(guān)的依賴包，比如最簡(jiǎn)單的：

yarn add dotenv-flow
yarn add @types/dotenv-flow -D

安裝好了直接在 main.ts 使用：

import * as dotenv from 'dotenv-flow'

/**
 * 導(dǎo)入 .env 環(huán)境
 * https://www.npmjs.com/package/dotenv-flow
 */
dotenv.config()

就可以使用對(duì)應(yīng)的環(huán)境 .env 變量了，不過(guò)這樣使用官方推薦軟件包：@nestjs/config ：

yarn add @nestjs/config

在 app.module.ts 中的 forRoot 靜態(tài)方法配置環(huán)境變量 .env 解析：

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

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

然后在項(xiàng)目根目錄下新建 .env 文件：

DATABASE_USER=
DATABASE_PASSWORD=
DATABASE_NAME=
DATABASE_PORT=
DATABASE_HOST=

自定義 env 路徑

如果 .env 需要細(xì)化生產(chǎn)、測(cè)試和開發(fā)環(huán)境可以按照下面進(jìn)行配置：

ConfigModule.forRoot({
 envFilePath: ['.env.development.local', '.env.development'],
})

其中排序越前面則優(yōu)先級(jí)最高，但在啟動(dòng)命令中設(shè)置環(huán)境變量則是最高，例如：

export DATABASE_USER=root && nest start

自定義配置文件

對(duì)于復(fù)雜的項(xiàng)目，需要把用到的可配置變量需要收集起來(lái)，比如新建 src/config/configuration.ts ：

export default () => ({
 port: parseInt(process.env.PORT, 10) || 3000,
 database: {
  host: process.env.DATABASE_HOST || 'localhost',
  port: parseInt(process.env.DATABASE_PORT, 10) || 3306
 }
})

然后在 ConfigModule.forRoot 加載：

import configuration from './config/configuration'

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

讀取配置變量

如果需要讀取相關(guān)的配置變量需要用到 ConfigService ，需要在用到的 *.module.ts 文件引入：

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

如果涉及的很多地方要寫，每個(gè) module 都要引入很煩人，可以在上面的 app.module.ts

添加一個(gè)字段：

import configuration from './config/configuration'

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

然后在構(gòu)造函數(shù)注入使用：

import { ConfigService } from '@nestjs/config'

constructor(private configService: ConfigService) {}

獲取配置變量例如：

const dbUser = this.configService.get<string>('DATABASE_USER')
const dbHost = this.configService.get<string>('database.host')

序列化

序列化指的是程序在網(wǎng)絡(luò)響應(yīng)中返回對(duì)象發(fā)送之前的過(guò)程，將提供的信息要進(jìn)行轉(zhuǎn)換和清理才能發(fā)給客戶端：比如查詢某個(gè)用戶，一般來(lái)說(shuō)可以返回當(dāng)前用戶實(shí)體信息，但里面的密碼信息是不可以發(fā)送給客戶端的，所以這邊要做一些轉(zhuǎn)換。

還好 Nest 提供一個(gè) class-transformer 相當(dāng)好用的軟件包：

yarn add class-transformer

比如在下列的用戶實(shí)體信息排除密碼信息：

import { Exclude } from 'class-transformer'

export class UserEntity {
 id: number
 firstName: string;
 lastName: string;

 @Exclude()
 password: string;

 constructor(partial: Partial<UserEntity>) {
  Object.assign(this, partial);
 }
}

然后在控制器處理查詢用戶方法：

@UseInterceptors(ClassSerializerInterceptor)
@Get(':id')
findOne(@Param('id') id: string): Promise<UserEntity> {
 return this.userService.findOne(id)
}

最終查詢會(huì)忽略密碼顯示。