如何以可复用方式组织存在依赖关系的模块？

我明白你现在遇到的问题——Auth模块和User模块耦合太紧了，不仅复用的时候得同时引入两者，User模块一挪位置，Auth里的导入路径还得跟着改，确实挺影响开发效率和模块复用性的。这里有几个NestJS生态里常用的解耦方案，你可以根据自己的场景选择：

1. 基于接口的依赖注入解耦 #

核心思路是让Auth模块依赖抽象接口而非具体的User模块实现，这样只要任何模块实现了这个接口，都能给Auth模块提供服务。

步骤： #

• 首先定义一个Auth模块需要的用户操作接口：

// src/auth/interfaces/user-service.interface.ts
export interface UserServiceInterface {
  createUser(userDto: any): Promise<any>;
  findUserByEmail(email: string): Promise<any>;
  // 其他Auth需要的用户操作方法
}

• 让User模块的UserService实现这个接口：

// src/user/user.service.ts
import { Injectable } from '@nestjs/common';
import { UserServiceInterface } from '../auth/interfaces/user-service.interface';

@Injectable()
export class UserService implements UserServiceInterface {
  async createUser(userDto: any) {
    // 原有的创建用户逻辑
  }

  async findUserByEmail(email: string) {
    // 原有的根据邮箱查找用户逻辑
  }
}

• 在Auth模块中，通过@Inject()注入这个接口，而不是直接导入User模块：

// src/auth/auth.service.ts
import { Injectable, Inject } from '@nestjs/common';
import { UserServiceInterface } from './interfaces/user-service.interface';

@Injectable()
export class LoginService {
  constructor(
    @Inject('UserServiceInterface') 
    private readonly userService: UserServiceInterface
  ) {}

  // 登录/注册逻辑中使用userService
}

• 最后在根模块（比如AppModule）中，把具体的UserService绑定到接口上：

// src/app.module.ts
import { Module } from '@nestjs/common';
import { AuthModule } from './auth/auth.module';
import { UserModule } from './user/user.module';
import { UserService } from './user/user.service';
import { UserServiceInterface } from './auth/interfaces/user-service.interface';

@Module({
  imports: [AuthModule, UserModule],
  providers: [
    {
      provide: 'UserServiceInterface',
      useClass: UserService,
    },
  ],
})
export class AppModule {}

这样Auth模块就不再直接依赖User模块，复用的时候只要提供实现了UserServiceInterface的服务即可。

2. 抽取共享模块 #

如果Auth只需要User模块中的部分功能，可以把这些公共功能抽成一个共享模块，让Auth模块依赖这个轻量的共享模块，而非整个User模块。

步骤： #

• 创建UserSharedModule，导出Auth需要的服务：

// src/user/shared/user-shared.module.ts
import { Module } from '@nestjs/common';
import { UserService } from '../user.service';

@Module({
  providers: [UserService],
  exports: [UserService], // 导出Auth需要的服务
})
export class UserSharedModule {}

• 在User模块中导入这个共享模块（如果需要复用的话），然后Auth模块只需要导入UserSharedModule：

// src/auth/auth.module.ts
@Module({
  imports: [UserSharedModule], // 替换原来的UserModule
  components: [JwtStrategy, GithubStrategy, TokenService, LoginService],
  controllers: [AuthController],
})
export class AuthModule {}

以后即使User模块的位置变动，只要UserSharedModule的路径不变，Auth模块就不需要修改导入路径，而且复用Auth的时候，只需要引入UserSharedModule即可（如果需要默认实现的话）。

3. 使用动态模块灵活配置 #

把Auth模块改成动态模块，允许外部传入它需要的用户相关依赖，这样Auth模块可以完全独立，复用的时候可以灵活传入不同的用户服务实现。

步骤： #

• 修改Auth模块为动态模块：

// src/auth/auth.module.ts
import { Module, DynamicModule } from '@nestjs/common';
import { JwtStrategy, GithubStrategy, TokenService, LoginService } from './services';
import { AuthController } from './auth.controller';

@Module({})
export class AuthModule {
  static forRoot(options: { userService: any }): DynamicModule {
    return {
      module: AuthModule,
      imports: [],
      providers: [
        JwtStrategy,
        GithubStrategy,
        TokenService,
        LoginService,
        {
          provide: 'USER_SERVICE',
          useValue: options.userService,
        },
      ],
      controllers: [AuthController],
      exports: [AuthModule],
    };
  }
}

• 在LoginService中注入配置的用户服务：

// src/auth/services/login.service.ts
import { Injectable, Inject } from '@nestjs/common';

@Injectable()
export class LoginService {
  constructor(
    @Inject('USER_SERVICE') 
    private readonly userService: any
  ) {}

  // 业务逻辑使用userService
}

• 在根模块中初始化Auth模块时传入UserService：

// src/app.module.ts
import { Module } from '@nestjs/common';
import { AuthModule } from './auth/auth.module';
import { UserModule } from './user/user.module';
import { UserService } from './user/user.service';

@Module({
  imports: [
    UserModule,
    AuthModule.forRoot({ userService: UserService }),
  ],
})
export class AppModule {}

这种方式让Auth模块的复用性达到最高，甚至可以在不同项目中传入完全不同的用户服务实现，完全摆脱对原User模块的依赖。

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