裝飾者模式詳解與範例

意圖

動態地為物件附加額外的職責。對於擴充功能，裝飾者提供了比繼承子類別更有彈性的替代方案。裝飾者是《設計模式》（Gang of Four，簡稱 GoF）一書中七種結構型模式之一，在書中也稱為 Wrapper。

它解決的問題

想像一個提供 get(key) 的資料儲存。有些呼叫端想要記錄，有些想要記憶體內快取，有些兩者都要，還有些想要在速度慢的網路後端上重試。如果用繼承，你會寫出 LoggingStore、CachingStore、LoggingCachingStore、RetryingCachingStore 等等：每一種組合就是一個子類別，而且這些組合在編譯時期就固定了。

裝飾者把每項功能變成一個小型的包裝類別。你可以在執行時期，把一個物件包進另一個物件裡，組合出需要的樣子，而使用這個儲存的程式碼，無論有幾層，看到的都是同一個介面。

結構與參與者

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

第二次呼叫雖然會被記錄，但是由快取回應，所以不會再次讀取資料庫。如果你對調順序，寫成 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

何時使用、何時不該用

在以下情況使用裝飾者：

• 你想為個別物件新增記錄、快取、重試、驗證、壓縮或存取檢查這類功能，同時不影響同一個類別的其他物件。
• 功能必須能自由組合，而繼承子類別會讓每一種組合都產生一個類別。
• 你無法或不該更動原始類別，例如因為它來自某個函式庫。

在以下情況應避免使用：

• 你只需要一種固定的額外行為。直接加進去，或是用一個子類別會更簡單。
• 程式碼依賴物件的身分或具體類別。被裝飾過的物件是不同的物件，所以像 instanceof SlowStore 或 === 比較這類檢查會失敗。
• 許多小層次會讓除錯變得困難。層層堆疊的包裝器會產生很長的呼叫堆疊，也讓人搞不清楚是哪一層做了什麼。

網頁框架（如 Express 或 Koa）中的中介軟體（middleware）是相關的概念：每一層接收請求、可能對它採取動作，然後再傳下去。

實際應用

• Java I/O：new BufferedInputStream(new FileInputStream("data.bin")) 把一個串流包進另一個加上緩衝功能的串流，而且兩者都具有 InputStream 介面。GoF 一書本身就把串流當作典型的例子來討論。
• Java 集合：Collections.unmodifiableList(list) 和 Collections.synchronizedList(list) 會回傳包裝器，在現有的清單外加上唯讀行為或鎖定機制。
• Python：像 functools.lru_cache 這類函式裝飾器會包裝一個函式並加上快取，而 functools.wraps 則能幫助包裝器保留被包裝函式的名稱與文件字串。

相關模式