ファクトリー

new Ctor(...deps) 以上のことが構築に必要な場合 — 複数の値を読み取る、サードパーティのクライアントを適応させる、設定オブジェクトを生成する、プロミスを返す — には registerFactory を使用します。

const container = new Container()
  .registerValue('config', { dsn: 'postgres://localhost/app', poolSize: 10 })
  .registerFactory('pgPool', (c) => {
    const { dsn, poolSize } = c.get('config')
    return new Pool({ connectionString: dsn, max: poolSize })
  })
  .registerClass('users', UserRepo, ['pgPool'])

ファクトリーの戻り値が、そのキーの解決後の型になります。

ホットな transient グラフ

transient サービスには registerClass を標準として使います。プロファイリングでコンストラクター呼び出しがホットパスの有意な割合を占めた場合だけ変更してください。

V8 では、同じ依存数を持つ異なる transient クラスを一つのグラフが繰り返し解決する場合に遅くなることがあります。プロファイリングとアプリケーションのビルド成果物でこの hotspot を確認したら、そのサービスだけをファクトリーで登録します。

const container = new Container()
  .registerClass('context', RequestContext, [], 'scoped')
  .registerClass('schema', Schema, [])
  .registerFactory(
    'parseRequest',
    (c) => new ParseRequest(c.get('context'), c.get('schema')),
    'transient',
  )

各ファクトリーには独自の new Service(...) 呼び出しを置いてください。この最適化が必要なら、複数のサービスを共通の構築ヘルパーへ渡してはいけません。ファクトリーは依存関係の記述を繰り返すため、計測済みの hotspot に限定します。

ファクトリーのライフタイム

ファクトリーは、クラスと同じライフタイムモデルを使用します:

const root = new Container()
  .registerFactory('cache', () => new Cache(), 'singleton')
  .registerFactory('request', () => new RequestState(), 'scoped')

シングルトンのファクトリー内では、c パラメーターはシングルトンセーフな依存関係に絞り込まれます。スコープドおよびトランジェントなキーはオートコンプリートされず、TypeScript によって拒否されます。

省略可能な第4引数 lazyKey を渡すと、registerClass と同じくライフタイムを保持する Lazy<V> コンパニオンが登録されます:

const root = new Container()
  .registerFactory('cache', () => new Cache(), 'singleton', 'cacheLazy')

root.get('cacheLazy').get() // Cache

デフォルトのシングルトンライフタイムを使う場合は、コンパニオンキーの前に undefined を渡します: registerFactory('cache', factory, undefined, 'cacheLazy')。

インターフェースのバインド

TypeScript のインターフェースはコンパイル時に消去され、コンストラクターとして渡すランタイム上の値を持ちません。代わりに、明示的なファクトリー型を通じて、インターフェースをその実装にバインドしてください:

interface Mailer {
  send(message: string): void
}

class SendGridMailer implements Mailer {
  send(message: string) {}
}

const container = new Container()
  .registerFactory<'mailer', Mailer>('mailer', () => new SendGridMailer())

'mailer' の利用者は、具象クラスではなく Mailer という抽象を見ることになります。

非同期ファクトリー

ファクトリーはプロミスを返すことができます。プロミス自体がキャッシュされるため、並行する呼び出し元は初期化を共有します:

const c = new Container()
  .registerValue('dsn', 'postgres://localhost/app')
  .registerFactory('db', async (c) => {
    const pool = new Pool({ connectionString: c.get('dsn') })
    await pool.connect()
    return pool
  })

const [a, b] = await Promise.all([c.get('db'), c.get('db')])
await c.dispose()

.get() は同期的なままです。登録が非同期である場合、呼び出し元は返された値を await します。

循環ガードとライフタイムガードが追跡するのは、ファクトリーの同期コールスタックだけです。await の後も通常の型付きコードは AllowedDeps で保護されますが、as キャストやキャプチャした外部コンテナはランタイムガードのコンテキスト外になります。依存関係は最初の await より前の同期部分で読み取ってください。