如何在NestJS中实现通用功能的可插拔模块化封装

NestJS本身的动态模块机制就是为了实现这种可配置、可复用的通用功能封装，核心实现步骤如下：

核心基础：使用DynamicModule封装动态模块 #

静态模块的配置是固定的，无法适配不同项目的差异化需求，要实现可插拔的通用功能，必须基于Nest的DynamicModule能力，支持导入时传入自定义配置参数。

封装示例1：鉴权授权模块 #

可以将JWT校验、角色权限校验、登录验证等逻辑全部封装到独立的Auth模块中：

1. 模块内部预置AuthService（封装登录、token生成逻辑）、JwtAuthGuard（登录态校验守卫）、RolesGuard（角色权限校验守卫）等核心能力
2. 暴露register静态方法接收自定义配置，示例代码如下：

export interface AuthModuleOptions {
  jwtSecret: string;
  expiresIn?: string;
  isGlobal?: boolean;
}

@Module({})
export class AuthModule {
  static register(options: AuthModuleOptions): DynamicModule {
    return {
      module: AuthModule,
      imports: [
        JwtModule.register({
          secret: options.jwtSecret,
          signOptions: { expiresIn: options.expiresIn || '24h' },
        }),
        PassportModule,
      ],
      providers: [AuthService, JwtAuthGuard, RolesGuard],
      exports: [AuthService, JwtAuthGuard, RolesGuard],
      global: options.isGlobal ?? false, // 可选设为全局，无需重复导入
    };
  }
}

3. 业务项目使用时，只需在根模块导入即可直接使用所有能力：

@Module({
  imports: [
    AuthModule.register({
      jwtSecret: process.env.JWT_SECRET,
      isGlobal: true,
    }),
  ],
})
export class AppModule {}

业务代码中无需重复开发鉴权逻辑，直接用@UseGuards(JwtAuthGuard, RolesGuard)装饰接口，或者注入AuthService调用登录验证方法即可。

封装示例2：文件上传模块 #

和鉴权模块逻辑一致，把文件上传、删除、格式校验等逻辑封装到独立模块，支持传入存储类型（本地/云OSS）、大小限制、允许的MIME类型、存储路径等配置：

export interface FileUploadOptions {
  storageType: 'local' | 'oss';
  maxSize?: number;
  allowedMimeTypes?: string[];
  localConfig?: { uploadPath: string };
  ossConfig?: { accessKey: string; secretKey: string; bucket: string };
  isGlobal?: boolean;
}

@Module({})
export class FileUploadModule {
  static register(options: FileUploadOptions): DynamicModule {
    return {
      module: FileUploadModule,
      providers: [
        { provide: 'FILE_UPLOAD_OPTIONS', useValue: options },
        FileUploadService,
      ],
      exports: [FileUploadService],
      global: options.isGlobal ?? false,
    };
  }
}

使用时导入模块传入对应配置，业务代码直接注入FileUploadService调用上传、删除方法即可，无需关心底层存储实现。

进阶优化 #

• 增加registerAsync方法，支持异步加载配置，比如从ConfigService读取参数，适配配置中心等场景
• 预置默认配置，用户未传对应参数时自动使用默认值，降低配置成本
• 多项目复用的场景下，可以将封装好的模块发布到私有npm仓库，新项目直接安装导入即可，无需拷贝代码

内容的提问来源于stack exchange，提问作者ArcadeHero