动态模块：register、forRoot、forFeature 分别怎么用
动态模块。在看一些第三方库的文档时，经常会看到类似 TypeOrmModule.forRoot()、ConfigModule.register() 这样的写法。为什么这些模块不直接导入，还要调用一个方法呢？这就是动态模块的典型应用场景。
简单来说，动态模块就是带参数的模块。普通模块在定义时，它的配置是固定的；而动态模块允许我们在导入的时候传入配置，从而让模块的行为可以根据不同的场景变化。这就好比一个“模板”，你给它不同的参数，它就生成不同配置的模块实例。
为什么需要动态模块？
举个例子，假设我们有一个数据库模块 DatabaseModule，它需要数据库连接信息（比如主机、端口、用户名、密码）。如果这个模块是静态的，那这些信息只能硬编码在模块内部，或者通过全局变量传递，非常不灵活。而有了动态模块，我们就可以在导入时传入配置，比如 DatabaseModule.forRoot({ host: 'localhost', port: 3306 })，这样同一个模块就能在不同环境下使用不同的配置。
动态模块的另一个好处是解耦。它可以把依赖的配置作为参数传入，而不是直接依赖其他服务，从而避免循环依赖。
动态模块的实现方式
动态模块本质上是一个静态方法，它返回一个 DynamicModule 对象。这个对象的结构和普通模块的 @Module() 装饰器里传的对象基本一样，包含 imports、controllers、providers、exports 等属性。
比如我们来实现一个简单的 ConfigModule，它允许传入一个配置对象：
import { DynamicModule, Module } from '@nestjs/common';
@Module({})
export class ConfigModule {
static register(options: Record<string, any>): DynamicModule {
return {
module: ConfigModule,
providers: [
{
provide: 'CONFIG_OPTIONS',
useValue: options,
},
ConfigService, // 假设有一个 ConfigService 需要使用 options
],
exports: [ConfigService],
};
}
}然后在另一个模块中导入时，就可以这样写：
@Module({
imports: [ConfigModule.register({ folder: './config' })],
})
export class AppModule {}这就是动态模块最基本的形式。
register、forRoot、forFeature 的区别
在实际的 NestJS 生态中，我们经常看到三种命名规范：register、forRoot、forFeature。它们其实都是为了表达动态模块的不同用途，虽然没有硬性规定，但社区已经形成了一些约定俗成的语义。
1. register
register 表示“每次导入都重新注册”。也就是说，你每次调用 BbbModule.register(xxx)，都会生成一个独立的模块实例，并且可以传入不同的配置。这种模式适用于那些需要在不同地方使用不同配置的模块。
比如文件里举的例子：BbbModule.register({aaa:1}) 和 BbbModule.register({aaa:2})，就是两次不同的调用，配置不同，模块也各自独立。这有点像“每次用的时候都给你一个新的”。
2. forRoot
forRoot 通常用来表示“只配置一次，全局生效”。它一般只在根模块（比如 AppModule）中调用一次，然后整个应用都共享同一个模块实例和配置。比如数据库连接模块，整个应用通常只需要一个数据库连接池，所以适合用 forRoot。
典型用法：TypeOrmModule.forRoot({...}) 或者 XxxModule.forRoot({})，配置一次之后，其他地方直接导入 XxxModule 就可以使用它提供的服务，不需要再传配置。
文件里也说了：forRoot 是“配置一次模块用多次，一般在 AppModule 里 import”。
3. forFeature
forFeature 是在 forRoot 的基础上，为某个特定功能模块提供额外的配置。比如我们用了 TypeOrmModule.forRoot() 配置了全局的数据库连接，然后每个具体的业务模块需要指定它要用到哪些实体（Entity），这时就可以用 TypeOrmModule.forFeature([UserEntity])。
文件里的解释很形象：“用了 forRoot 固定了整体模块，用于局部的时候，可能需要再传一些配置，比如用 forRoot 指定了数据库链接信息，再用 forFeature 指定某个模块访问哪个数据库和表。”
所以 forFeature 通常依赖于 forRoot 已经建立的全局环境，它只补充一些局部的配置。
实际例子：结合文件内容
假设我们有一个 DatabaseModule，它需要全局数据库连接，同时又希望每个子模块可以指定要操作的实体。我们可以这样设计：
- 用
forRoot传入连接配置，创建连接池。 - 用
forFeature传入实体列表，注册对应的 Repository。
// database.module.ts
@Module({})
export class DatabaseModule {
static forRoot(dbConfig: DbConfig): DynamicModule {
const connectionProvider = {
provide: 'CONNECTION',
useFactory: async () => createConnection(dbConfig),
};
return {
module: DatabaseModule,
providers: [connectionProvider],
exports: [connectionProvider],
};
}
static forFeature(entities: Entity[]): DynamicModule {
return {
module: DatabaseModule,
providers: entities.map(entity => ({
provide: `${entity.name}_REPOSITORY`,
useFactory: (connection) => connection.getRepository(entity),
inject: ['CONNECTION'],
})),
exports: entities.map(entity => `${entity.name}_REPOSITORY`),
};
}
}然后在 AppModule 里：
@Module({
imports: [DatabaseModule.forRoot({ host: 'localhost', port: 3306 })],
})
export class AppModule {}在 UserModule 里：
@Module({
imports: [DatabaseModule.forFeature([UserEntity])],
providers: [UserService],
})
export class UserModule {}这样，UserService 就可以注入 UserEntity 的 Repository 了，而连接配置是在根模块统一管理的。
总结
动态模块是 NestJS 提供的一种非常灵活的扩展机制。通过 register、forRoot、forFeature 这些命名约定，我们可以清晰地表达模块的使用意图：
- register：每次导入都独立配置，适用于可复用的、可配置的模块。
- forRoot：全局配置一次，适用于需要单例的模块，比如数据库连接、配置中心。
- forFeature：在全局配置基础上补充局部配置，适用于业务模块注册自己的资源。
理解并善用动态模块，能让你的 NestJS 应用更加模块化、可配置和可维护。下次看到第三方库的 forRoot 时，你就知道它是在初始化全局配置了！
Comments | NOTHING