この記事は NestJS アドベントカレンダー 2019 10 日目の記事です。
寝込んでいたため遅くなり申し訳ありません。
はじめに
この記事ではいつの間にか生まれがちな循環参照の原因と回避策について説明します。
サンプルコードのリポジトリは以下になります。
https://github.com/nestjs-jp/advent-calendar-2019/tree/master/day10-resolve-circular-reference
なお、環境は執筆時点での Node.js の LTS である v12.13.x を前提とします。
循環参照を観測する
循環参照が発生する例として、以下のようなサンプルコードを用意しました。
なお、循環参照を小さい規模で意図的に起こしているため、あまり良い設計ではないです。
import{Module}from'@nestjs/common';import{UsersService}from'./users.service';import{AuthService}from'../auth/auth.service';import{AuthModule}from'../auth/auth.module';@Module({imports:[AuthModule],providers:[UsersService],exports:[AuthService],})exportclassUsersModule{}import{Injectable}from'@nestjs/common';import{AuthService}from'../auth/auth.service';import{User}from'../types';@Injectable()exportclassUsersService{constructor(privatereadonlyauthService:AuthService){}findUserById(_id:string):User{// ...return{id:'foo',hashedPassword:'bar'};}getUserConfig(sessionToken:string){constuser=this.authService.getUser(sessionToken);returnthis.getConfig(user);}privategetConfig(_user:User){// ...return{name:'alice'};}}import{Module}from'@nestjs/common';import{AuthService}from'./auth.service';import{UsersModule}from'../users/users.module';@Module({imports:[UsersModule],providers:[AuthService],exports:[AuthService],})exportclassAuthModule{}import{Injectable}from'@nestjs/common';import{UsersService}from'../users/users.service';import{User}from'../types';@Injectable()exportclassAuthService{constructor(privatereadonlyusersService:UsersService){}getUser(_sessionToken:string):User{// ...return{id:'foo',hashedPassword:'bar'};}login(userId,password){constuser=this.usersService.findUserById(userId);returnthis.authenticateUser(user,password);}privateauthenticateUser(_user:User,_password:string):string{// ...return'hoge4js'}}さすがにここまで直接的ではなくとも、似たような依存関係になってしまうことはあるかと思います。
この状態でアプリケーションを起動すると、以下のようなエラーが出ます。
[Nest] 61340 - 12/16/2019, 5:56:10 PM [NestFactory] Starting Nest application...
[Nest] 61340 - 12/16/2019, 5:56:10 PM [ExceptionHandler] Nest cannot create the module instance. Often, this is because of a circular dependency between modules. Use forwardRef() to avoid it.
(Read more: https://docs.nestjs.com/fundamentals/circular-dependency)
Scope [AppModule -> UsersModule -> AuthModule]
+5ms
Error: Nest cannot create the module instance. Often, this is because of a circular dependency between modules. Use forwardRef() to avoid it.
(Read more: https://docs.nestjs.com/fundamentals/circular-dependency)
Scope [AppModule -> UsersModule -> AuthModule]
NestJS の場合は循環参照が発生している場合、まず起動できません。
なぜ起動できなくなるか
NestJS は bootstrap 時に Module の Provider であり @Injectable()なものをインスタンス生成し、 DI コンテナを生成します。
この時、 A には B が、 B には C が、と依存している場合、依存を解決し、 C -> B -> A という順で初期化しています。
このとき、循環参照があると依存が解決できず、 Provider のインスタンス生成が失敗します。例えば、 A には B の インスタンスが必要であり、 B には A の インスタンスが必要であるので、どちらかが先にインスタンス生成されていないといけないのです。
forwardRef を使用し依存を解消する
NestJS ではこのような循環参照を回避する方法として、 @Inject()と forwardRef(() => { ... })が用意されています。
forwardRef では、依存先をまだインスタンス生成されていないものに対して未来に依存することを約束し、型のみ合わせて初期化を進めます。
まずは Module の循環参照を解決します。
@Module({imports:[forwardRef(()=>AuthModule)],providers:[UsersService],exports:[AuthService],})exportclassUsersModule{}@Module({imports:[forwardRef(()=>UsersModule)],providers:[AuthService],exports:[AuthService],})exportclassAuthModule{}理屈上は片方のみの循環参照の解決で良いのですが、後述する Service 間の依存に影響が出てしまうため、双方ともに forwardRef するのが良いでしょう。
次に、 Service の循環参照を解決します。
import{forwardRef,Inject,Injectable}from'@nestjs/common';import{AuthService}from'../auth/auth.service';import{User}from'../types';@Injectable()exportclassUsersService{constructor(@Inject(forwardRef(()=>AuthService))privatereadonlyauthService:AuthService,){}findUserById(_id:string):User{// ...return{id:'foo',hashedPassword:'bar'};}getUserConfig(sessionToken:string){constuser=this.authService.getUser(sessionToken);returnthis.getConfig(user);}privategetConfig(_user:User){// ...return{name:'alice'};}}import{forwardRef,Inject,Injectable}from'@nestjs/common';import{UsersService}from'../users/users.service';import{User}from'../types';@Injectable()exportclassAuthService{constructor(@Inject(forwardRef(()=>UsersService))privatereadonlyusersService:UsersService,){}getUser(_sessionToken:string):User{// ...return{id:'foo',hashedPassword:'bar'};}login(userId,password){constuser=this.usersService.findUserById(userId);returnthis.authenticateUser(user,password);}privateauthenticateUser(_user:User,_password:string):string{// ...return'hoge4js'}}修正を加えた状態でアプリケーションを起動するとうまく動きます。
正しく動くことを確認するために、 AppController に以下の変更を加えて動作させてみます。
@Controller()exportclassAppController{constructor(privatereadonlyusersService:UsersService,privatereadonlyauthService:AuthService,){}@Get('config')getConfig(){returnthis.usersService.getUserConfig('hoge4js');}@Get('login')login(){returnthis.authService.login('foo','baz')}}$ curl localhost:3000/login
hoge4js
$ curl localhost:3000/config
{"name":"alice"}無事アプリケーションも動いています。
おわりに
この記事ではいつの間にか生まれがちな循環参照の原因と回避策について説明しました。
特に Service <-> Service では複雑な依存が生まれがちなので、気をつけるようにしてください。
forwardRef 自体に副作用や危険な要素があるわけではないようなので、起動時間をチューニングする必要がない環境では極力定義しておくと良いのではないでしょうか。
明日は @ci7lusさんの NestJS Response ヘッダー 変え方です(確定した未来)。