環(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è)問題需要進(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)單的：
|
1
2
|
yarn add dotenv-flowyarn add @types/dotenv-flow -D |
安裝好了直接在 main.ts 使用：
|
1
2
3
4
5
6
7
|
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 變量了，不過這樣使用官方推薦軟件包：@nestjs/config ：
|
1
|
yarn add @nestjs/config |
在 app.module.ts 中的 forRoot 靜態(tài)方法配置環(huán)境變量 .env 解析：
|
1
2
3
4
5
6
7
|
import { Module } from '@nestjs/common'import { ConfigModule } from '@nestjs/config'@Module({ imports: [ConfigModule.forRoot()]})export class AppModule {} |
然后在項(xiàng)目根目錄下新建 .env 文件：
|
1
2
3
4
5
|
DATABASE_USER=DATABASE_PASSWORD=DATABASE_NAME=DATABASE_PORT=DATABASE_HOST= |
自定義 env 路徑
如果 .env 需要細(xì)化生產(chǎn)、測(cè)試和開發(fā)環(huán)境可以按照下面進(jìn)行配置：
|
1
2
3
|
ConfigModule.forRoot({ envFilePath: ['.env.development.local', '.env.development'],}) |
其中排序越前面則優(yōu)先級(jí)最高，但在啟動(dòng)命令中設(shè)置環(huán)境變量則是最高，例如：
|
1
|
export DATABASE_USER=root && nest start |
自定義配置文件
對(duì)于復(fù)雜的項(xiàng)目，需要把用到的可配置變量需要收集起來，比如新建 src/config/configuration.ts ：
|
1
2
3
4
5
6
7
|
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 加載：
|
1
2
3
4
5
6
7
8
9
10
|
import configuration from './config/configuration'@Module({ imports: [ ConfigModule.forRoot({ load: [configuration] }) ]})export class AppModule {} |
讀取配置變量
如果需要讀取相關(guān)的配置變量需要用到 ConfigService ，需要在用到的 *.module.ts 文件引入：
|
1
2
3
4
|
@Module({ imports: [ConfigModule], // ...}) |
如果涉及的很多地方要寫，每個(gè) module 都要引入很煩人，可以在上面的 app.module.ts
添加一個(gè)字段：
|
1
2
3
4
5
6
7
8
9
10
11
|
import configuration from './config/configuration'@Module({ imports: [ ConfigModule.forRoot({ isGlobal: true, load: [configuration] }) ]})export class AppModule {} |
然后在構(gòu)造函數(shù)注入使用：
|
1
2
3
|
import { ConfigService } from '@nestjs/config'constructor(private configService: ConfigService) {} |
獲取配置變量例如：
|
1
2
|
const dbUser = this.configService.get<string>('DATABASE_USER')const dbHost = this.configService.get<string>('database.host') |
序列化
序列化指的是程序在網(wǎng)絡(luò)響應(yīng)中返回對(duì)象發(fā)送之前的過程，將提供的信息要進(jìn)行轉(zhuǎn)換和清理才能發(fā)給客戶端：比如查詢某個(gè)用戶，一般來說可以返回當(dāng)前用戶實(shí)體信息，但里面的密碼信息是不可以發(fā)送給客戶端的，所以這邊要做一些轉(zhuǎn)換。
還好 Nest 提供一個(gè) class-transformer 相當(dāng)好用的軟件包：
|
1
|
yarn add class-transformer |
比如在下列的用戶實(shí)體信息排除密碼信息：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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); }} |
然后在控制器處理查詢用戶方法：
|
1
2
3
4
5
|
@UseInterceptors(ClassSerializerInterceptor)@Get(':id')findOne(@Param('id') id: string): Promise<UserEntity> { return this.userService.findOne(id)} |
最終查詢會(huì)忽略密碼顯示。
總結(jié)
到此這篇關(guān)于Nest.js環(huán)境變量配置與序列化的文章就介紹到這了,更多相關(guān)Nest.js環(huán)境變量配置內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家！
原文鏈接：https://iiong.com/nest-js-environment-variable-configuration-and-serialization/
