32. インジェクションスコープ — Singleton / Request / Transient

プロバイダの既定のスコープはシングルトンで、アプリ起動時に一度だけ生成されたインスタンスを全リクエストで共有します。これを変えたいときは @Injectable({ scope: Scope.REQUEST }) のように指定します。Scope.REQUEST はリクエストごとに新しいインスタンスを作り、Scope.TRANSIENT は注入されるたびに新しいインスタンスを作ります。

実務でシングルトン以外を選ぶのは、リクエスト固有の状態(ログインユーザーやリクエスト ID など)をプロバイダ自身に持たせたい場合です。ただし Scope.REQUEST はリクエストごとに生成コストがかかり、それを注入したコントローラやサービスまで連鎖的にリクエストスコープ化されるため、パフォーマンスに影響します。多くの場合は状態を引数で渡すか、既習の @User() のようなデコレータで取り出すほうが軽量です。

下のコードはシングルトン(同一インスタンスを共有)とトランジェント(毎回新規)の違いを、生成カウンタで再現したものです。つまずきポイントは、シングルトンなプロバイダにリクエスト固有の状態を持たせてしまうことで、状態が全リクエストで共有され、別ユーザーの情報が混ざる危険があります。状態を持たせたいときだけスコープを上げる、と覚えましょう。

▶ サンプルコードを実行してみよう(自由に書き換えてOK)

TypeScript

// Singleton と Transient の違いを生成カウンタで再現
let createdCount = 0; // インスタンスが何個作られたかを数える

class RequestContext {
  readonly instanceNo: number;
  constructor() {
    createdCount += 1;
    this.instanceNo = createdCount;
  }
}

// Singleton: 初回だけ生成し、以後は同じインスタンスを使い回す
class SingletonScope {
  private instance: RequestContext | null = null;
  resolve(): RequestContext {
    if (this.instance === null) this.instance = new RequestContext();
    return this.instance;
  }
}

// Transient: 注入(resolve)されるたびに必ず新規生成
class TransientScope {
  resolve(): RequestContext {
    return new RequestContext();
  }
}

const singleton = new SingletonScope();
const a = singleton.resolve();
const b = singleton.resolve();
console.log("Singleton: a#" + a.instanceNo + " b#" + b.instanceNo);
console.log("  同一インスタンス?: " + (a === b)); // true

const transient = new TransientScope();
const c = transient.resolve();
const d = transient.resolve();
console.log("Transient: c#" + c.instanceNo + " d#" + d.instanceNo);
console.log("  同一インスタンス?: " + (c === d)); // false

// Singleton と Transient の違いを生成カウンタで再現
let createdCount = 0; // インスタンスが何個作られたかを数える

class RequestContext {
  readonly instanceNo: number;
  constructor() {
    createdCount += 1;
    this.instanceNo = createdCount;
  }
}

// Singleton: 初回だけ生成し、以後は同じインスタンスを使い回す
class SingletonScope {
  private instance: RequestContext | null = null;
  resolve(): RequestContext {
    if (this.instance === null) this.instance = new RequestContext();
    return this.instance;
  }
}

// Transient: 注入(resolve)されるたびに必ず新規生成
class TransientScope {
  resolve(): RequestContext {
    return new RequestContext();
  }
}

const singleton = new SingletonScope();
const a = singleton.resolve();
const b = singleton.resolve();
console.log("Singleton: a#" + a.instanceNo + " b#" + b.instanceNo);
console.log("  同一インスタンス?: " + (a === b)); // true

const transient = new TransientScope();
const c = transient.resolve();
const d = transient.resolve();
console.log("Transient: c#" + c.instanceNo + " d#" + d.instanceNo);
console.log("  同一インスタンス?: " + (c === d)); // false

サンプルコードで身につける(5本) →

学んだ概念を、素朴な例から実務寄りの例まで5つの具体例で確認します。

公式ドキュメントで詳しく ↗