10、Nest.js 中的全局模块和动态模块
前面有提到过，数据库的用户、密码或者 API 的 Key 和 Secret 等等，这类信息在实际项目中不应该硬编码。给不同的环境使用不同的配置文件是比较通用的做法。一些非常敏感的信息连配置文件都不要写，应当直接使用环境变量去设置。
前段时间某酒店的开房数据泄露，就是因为程序员把数据库密码上传到了 Github ，所以如果你的商业项目却使用了公共的 Git 仓库，千万不要把重要的信息提交哦，别有用心的人一定会去查你项目的 Git Log。
言归正传，我们来看看 Nest 中如何使用配置文件。还是秉承一切皆模块的原则，新建一个 Config 模块。
src/config/config.module
import { Module, Global } from '@nestjs/common';
import { ConfigService } from './config.service';
@Global()
@Module({
providers: [
{
provide: ConfigService,
useValue: new ConfigService(`env/${ process.env.NODE_ENV }.env`),
}
],
exports: [ConfigService],
})
export class ConfigModule { }
ConfigModule 使用 @Global 装饰器修饰，表示它是一个全局模块，我们只需要在根模块导入 ConfigModule，然后在其它所有模块中，都可以直接使用这个全局模块中导出的提供者。
这里我们只导出了 ConfigService，也就是说我们在 AppModule 中导入 ConfigModule 这个全局模块，就可以在所有其它挂载在 AppModule 上的模块中使用 ConfigService 而不用指定提供者。
在为 ConfigService 指定提供者的时候 ，我们想根据环境变量读取不同的 .env 文件，所以这里使用自定义提供者为 ConfigService 传递了动态的配置文件路径。
image.png
根目录有一个 env 文件夹，专门用来存放不同环境的配置文件。
看一下 dev.env 的内容：
env/dev.env
NODE_ENV=development // 开发环境
PORT=8088 // 程序运行的端口号
ORM_LOADING_PATH=src // TypeOrm 加载文件的根路径
DATABASE_TYPE=mysql // 数据库类型
DATABASE_HOST=127.0.0.1 // 数据库主机地址
DATABASE_PORT=3306 // 数据库端口号
DATABASE_USER=root // 数据库用户
DATABASE_PWD=123456 // 数据库密码
DATABASE_DB=demo // 数据库名称
DATABASE_SYNCHRONIZE=true // 是否同步数据库表结构
DATABASE_DROPSCHEMA=true // 每次启动是否删除数据库表重新创建
src/config/config.service.ts
import * as dotenv from 'dotenv';
import * as fs from 'fs';
import * as Joi from 'joi';
export interface EnvConfig {
[prop: string]: string;
}
export class ConfigService {
private readonly envConfig: EnvConfig;
constructor(filePath: string) {
const config = dotenv.parse(fs.readFileSync(filePath));
this.envConfig = this.validateInput(config);
}
private validateInput(envConfig: EnvConfig): EnvConfig {
const envVarsSchema: Joi.ObjectSchema = Joi.object({
NODE_ENV: Joi.string()
.valid(['development', 'production', 'test', 'provision'])
.default('development'),
PORT: Joi.number().default(8088),
ORM_LOADING_PATH: Joi.string().required(),
DATABASE_TYPE: Joi.string().default('mysql'),
DATABASE_HOST: Joi.string().default('localhost'),
DATABASE_PORT: Joi.number().default(3306),
DATABASE_USER: Joi.string().default('root'),
DATABASE_PWD: Joi.string(),
DATABASE_DB: Joi.string().required(),
DATABASE_SYNCHRONIZE: Joi.boolean().default(false),
DATABASE_DROPSCHEMA: Joi.boolean().default(false),
});
const { error, value: validatedEnvConfig } = Joi.validate(
envConfig,
envVarsSchema,
);
if (error) {
throw new Error(`Config validation error: ${error.message}`);
}
return validatedEnvConfig;
}
get env(): string {
return this.envConfig.NODE_ENV;
}
get port(): number {
return Number(this.envConfig.PORT);
}
get ormLoadingPath(): string {
return this.envConfig.ORM_LOADING_PATH;
}
get databaseType(): string {
return this.envConfig.DATABASE_TYPE;
}
get databaseHost(): string {
return this.envConfig.DATABASE_HOST;
}
get databasePort(): number {
return Number(this.envConfig.DATABASE_PORT);
}
get databaseUserName(): string {
return this.envConfig.DATABASE_USER;
}
get databasePassword(): string {
return this.envConfig.DATABASE_PWD;
}
get databaseName(): string {
return this.envConfig.DATABASE_DB;
}
get databaseSynchronize(): boolean {
return Boolean(this.envConfig.DATABASE_SYNCHRONIZE);
}
get databaseDropSchema(): boolean {
return Boolean(this.envConfig.DATABASE_DROPSCHEMA);
}
}
ConfigService 的实现参考了官方文档，使用 dotenv 这个库来加载 .env 文件，然后使用 joi 来验证 env 文件的每一项。还使用了 TypeScript 的 Get Set 语法糖。使用起来很简单，只需要在构造函数中声明需要用到 ConfigService。
constructor( private readonly config: ConfigService) {
console.log(this.config.port)
}
顺便提一句在 Nest 中依赖注入的提供者实例都是单例模式的，也就是说多次引用 ConfigService 也只会创建一个实例。
现在我们已经知道什么是全局模块以及怎么使用全局模块了，那么动态模块又是什么呢？
如果我们要为一个模块动态的去注册提供者，这个时候就要用到动态模块了，以 DatabaseModule 为例。
我们需要动态的为它导入要加载的实体，还需要为每一个实体注入数据库连接对象。
const DataBaseModule = (entities = [], options?): DynamicModule => {
const providers = entities.map( entity => {
return {
provide: getRepositoryToken(entity),
useFactory: (config: ConfigService) => {
return new DatabaseConnection({
type: config.databaseType,
host: config.databaseHost,
port: config.databasePort,
......
});
},
inject: [ConfigService],
}
});
return {
module: DatabaseModule,
providers: providers,
exports: providers,
};
}
@Module({
imports: [
ConfigModule,
DataBaseModule(),
]
})
export class AppModule { }
}
幸好 Nest 为我们准备了现成的数据库模块 - TypeOrmModule。
首先需要安装相关依赖，这里以 MySql 为例：
$ npm install --save @nestjs/typeorm typeorm mysql
import { DynamicModule, Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as Path from 'path';
import { ConfigModule } from './config/config.module';
import { ConfigService } from './config/config.service';
const Orm = (): DynamicModule => {
const config = new ConfigService(`env/${process.env.NODE_ENV}.env`);
return TypeOrmModule.forRoot({
type: 'mysql',
host: config.databaseHost,
port: config.databasePort,
username: config.databaseUserName,
password: config.databasePassword,
database: config.databaseName,
entities: [Path.resolve(__dirname, `../${ config.ormLoadingPath }/**/*.entity{.ts,.js}`)],
subscribers: [Path.resolve(__dirname, `../${ config.ormLoadingPath }/**/*.entity{.ts,.js}`)],
synchronize: config.databaseSynchronize,
dropSchema: config.databaseDropSchema
});
}
@Module({
imports: [
ConfigModule,
Orm(),
]
})
export class AppModule { }
这里的 entities 和 subscribers 的加载路径，需要根据环境的不同来动态设置，应为 TypeOrm 是动态加载这些文件的，TypeScript 编译后输出到 dist 目录，所以生产环境需要让 TypeOrm 到 dist 目录下去寻找这些文件。
如果这些 TypeOrm 的配置项和用法不清楚的，可以移步 TypeOrm 的官方文档。或者如果您觉得笔者写的实战教程，能让您比看文档更快的弄懂这些知识，可以在文章下面留言，我会继续写有关 TypeOrm、TypeDI 等技术的实战教程。
