Decorator パターンを例でわかりやすく解説

目的

オブジェクトに追加の責務を動的に付加します。Decorator パターンは、機能を拡張するためのサブクラス化に代わる柔軟な方法を提供します。Gang of Four（GoF）の書籍にある7つの構造パターンの1つで、同書ではWrapperとも呼ばれています。

解決する問題

get(key) を持つデータストアを想像してください。呼び出し側によって、ログを取りたい、メモリ内キャッシュが欲しい、両方欲しい、遅いネットワークのバックエンドに対してリトライが欲しい、と要望はさまざまです。継承では、LoggingStore、CachingStore、LoggingCachingStore、RetryingCachingStore などを書くことになります。組み合わせごとに1つのサブクラスが必要で、組み合わせもコンパイル時に固定されます。

Decorator パターンは、各機能を小さなラッパークラスにします。必要な組み合わせは、1つのオブジェクトを別のオブジェクトでラップすることで、実行時に組み立てます。ストアを使うコードは、何層重なっていても同じインターフェイスしか見ません。

構造と登場要素

TypeScriptでの実装

interface Store {
  get(key: string): string;
}

class SlowStore implements Store {
  get(key: string): string { console.log(`  (database read: ${key})`); return key.toUpperCase(); }
}

// Base decorator: forwards everything to the wrapped store.
abstract class StoreDecorator implements Store {
  constructor(protected inner: Store) {}
  get(key: string): string { return this.inner.get(key); }
}

class LoggingStore extends StoreDecorator {
  get(key: string): string {
    console.log(`get ${key}`);
    return super.get(key);
  }
}

class CachingStore extends StoreDecorator {
  private cache = new Map<string, string>();
  get(key: string): string {
    if (!this.cache.has(key)) this.cache.set(key, super.get(key));
    return this.cache.get(key)!;
  }
}

// Stack features in any order at run time.
const store: Store = new LoggingStore(new CachingStore(new SlowStore()));
console.log(store.get("ada"));
console.log(store.get("ada"));
// get ada
//   (database read: ada)
// ADA
// get ada
// ADA

2回目の呼び出しはログに記録されますが、キャッシュから応答されるため、データベースは再び読み込まれません。順序を入れ替えて new CachingStore(new LoggingStore(...)) にすると、キャッシュミスだけがログに記録されます。デコレーターの順序によって振る舞いが変わるのは、機能でもあり、混乱のよくある原因でもあります。

TypeScriptの関数デコレーター

コンポーネントが単一の関数の場合、デコレーターは高階関数にできます。関数を受け取り、同じシグネチャで追加の振る舞いを持つ新しい関数を返します。

function withTiming<A extends unknown[], R>(name: string, fn: (...args: A) => R) {
  return (...args: A): R => {
    const start = performance.now();
    try {
      return fn(...args);
    } finally {
      console.log(`${name} took ${(performance.now() - start).toFixed(1)} ms`);
    }
  };
}

const slowSquare = (n: number) => { for (let i = 0; i < 1e6; i++); return n * n; };
const timedSquare = withTiming("square", slowSquare);
console.log(timedSquare(12)); // square took ... ms, then 144

使うべきとき、使わないとき

次の場合はDecorator パターンを使います。

• 同じクラスの他のオブジェクトに影響を与えずに、個々のオブジェクトに、ログ出力、キャッシュ、リトライ、検証、圧縮、アクセスチェックなどの機能を追加したい場合。
• 機能を自由に組み合わせる必要があり、サブクラス化だと組み合わせごとにクラスができてしまう場合。
• ライブラリ由来であるなどの理由で、元のクラスを変更できない、または変更すべきでない場合。

次の場合は避けます。

• 必要な追加の振る舞いが固定の1つだけの場合。直接追加するか、1つのサブクラスを使うほうが簡単です。
• コードがオブジェクトの同一性や具象クラスに依存している場合。デコレートされたオブジェクトは別のオブジェクトなので、instanceof SlowStore のようなチェックや === の比較は失敗します。
• 小さな層が多いとデバッグが難しくなる場合。ラッパーが深く積み重なると、コールスタックが長くなり、どの層が何をしたのかが分かりにくくなります。

ExpressやKoaなどのWebフレームワークのミドルウェアは関連する考え方です。各層がリクエストを受け取り、必要なら処理して、次に渡します。

実際の利用例

• JavaのI/O：new BufferedInputStream(new FileInputStream("data.bin")) は、ストリームを、バッファリングを追加する別のストリームでラップしており、どちらも InputStream インターフェイスを持っています。GoFの書籍自身も、典型的な例としてストリームを取り上げています。
• Javaのコレクション：Collections.unmodifiableList(list) と Collections.synchronizedList(list) は、既存のリストの周りに、読み取り専用の振る舞いやロックを追加するラッパーを返します。
• Python：functools.lru_cache のような関数デコレーターは関数をラップしてキャッシュを追加し、functools.wraps は、ラッパーがラップされた関数の名前とdocstringを保つのを助けます。

関連するパターン