[元件] Provider | 研究筆記

provider 會在 module 載入時先實例化並註冊到依賴注入容器，
最後 controller 再透過 token 取得 provider 的實例後， controller 才進行實例化。

useClass

在 module 的元數據寫好的 providers 預設的 token 寫法是 useClass，
而 useClass 可以被縮寫：

@Module({
  //...
  // 預設的 token 寫法就是 useClass，可以縮寫成這樣
  providers: [TodoService],
})
export class TodoModule {}

@Module({
  //...
  // 完整的格式
  providers: [
    {
      provide: TodoService, // token 名稱
      useClass: TodoService, // token 回傳值
    },
  ],
})
export class TodoModule {}

所以可以知道 token 原本就寫在 providers 裡面了。

除了 useClass，還有 3 種自訂的 provider 可以寫入：

useValue
useFactory
useExisting

useValue

可以用字串設定 token 名稱並指定一個任意型別的回傳值：

{
  provide: 'TEST_USE_VALUE',
  useValue: '這是用 useValue 註冊的 provider',
}

自訂 provider 需要在依賴注入時前綴 @Inject 裝飾器並傳入 token 名稱：

@Controller()
export class AppController {
  constructor(
    // 在裝飾器傳入 token 名稱
    @Inject('TEST_USE_VALUE') private readonly testUseValue: string,
  ) {}

  @Get('test-use-value')
  getTestUseValue() {
    return this.testUseValue;
  }
}

useFactory

可以用 callback 的方式產生回傳值，並且提供 inject 這個選項，
可以直接注入某個實例後在 callback 中呼叫其方法：

{
  provide: 'TEST_USE_FACTORY',
  inject: [AppService],
  useFactory: (appService: AppService) => {
    const result = appService.getHello();

    return `這是用 useFactory 註冊的 provider，這是從 AppService 拿到的資料 ${result}`;
  },
},

同樣加入 @Inject 標記就可以使用：

@Controller()
export class AppController {
  constructor(@Inject('TEST_USE_FACTORY') private readonly testUseFactory: string) {}

  @Get('test-use-factory')
  getTestUseFactory() {
    return this.testUseFactory;
  }
}

也支援非同步 callback：

{
  provide: 'TEST_ASYNC_USE_FACTORY',
  inject: [AppService],
  useFactory: async (appService: AppService) => {
    const timeLimit = 1000;
    const result: string = await new Promise((resolve) => {
      setTimeout(() => {
        resolve(appService.getHello());
      }, timeLimit);
    });

    return `這是用 async useFactory 註冊的 provider，這是從 AppService 拿到的資料 ${result}，耗時 ${timeLimit} 毫秒`;
  },
},

useExisting

可以用其他的 token 名稱作為別名，並指定回傳已經存在的 provider 實例：

{
  provide: 'TEST_USE_EXISTING',
  useExisting: AppService,
},

@Controller()
export class AppController {
  constructor(
    // 實際上這個 provider 就是 AppService
    @Inject('TEST_USE_EXISTING') private readonly testUseExisting: AppService,
  ) {}

  @Get('test-use-existing')
  getTestUseExisting() {
    return this.testUseExisting.getHello();
  }
}

匯出

自訂 provider 都是固定的 key-value 格式，所以可以直接宣告成變數，
填入 module 的 exports 匯出：

const testUseValueProvider: Provider = {
  provide: 'TEST_USE_VALUE',
  useValue: '這是用 useValue 註冊的 provider',
};

@Module({
  providers: [testUseValueProvider],
  exports: [testUseValueProvider],
})
export class CustomModule {}

可選注入

依賴注入是在建構函式裡面傳入實例作為參數，那麼參數就有可帶可不帶的問題，
可以使用 @Optional 標注該依賴是可選的，這樣注入時如果找不到相關的 provider 實例，
也還是能順利啟動，但是和一般參數一樣，沒有捕捉到的話就會變 undefined，
所以要記得在存取實例的地方加上防呆：

@Controller()
export class AppController {
  constructor(
    @Optional()
    @Inject('TEST_USE_EXISTING')
    private readonly testUseExisting: AppService,
  ) {}

  @Get('test-use-existing')
  getTestUseExisting() {
    if (!testUseExisting) {
      return '實例不存在';
    }

    return this.testUseExisting.getHello();
  }
}

總結

除了 controller 以外，大部分的功能類別都可以被歸類為 provider，
只是要稍微留意匯入匯出、實例化順序的問題。

到 provider 之後我才開始對 NestJS 基本的運作流程大致了解，
初見時一直套範例或 vibe coding，要去找其他教學除錯的時候，
概念很模糊，不知道什麼設定會影響到哪，也不知道問題點，
所以去看官方文件也無從查起 XDDD

參考資料

Custom providers

目錄