适配器模式详解与示例

意图

将一个类的接口转换成客户端期望的另一个接口。适配器使原本因接口不兼容而无法一起工作的类可以协同工作。它是《设计模式》（四人组，GoF）一书中七种结构型模式之一。

它要解决的问题

你的商城代码使用一个很小的 PaymentGateway 接口：charge(amountCents, currency) 返回包含 ok 标志和交易 ID 的结果。现在公司和一家支付服务商签了合同，它的 SDK 完全是另一种风格：金额是十进制字符串，币种属于请求对象的一部分，错误则以数字状态码返回。

你改不了这个 SDK，也不想把每个调用方都改成新的形式。如果 SDK 的风格渗透到结账、退款和报表中，以后更换服务商的代价就会很高。适配器把这种转换集中在一个类里。

结构与参与者

TypeScript 实现

// Target: what our code expects.
interface PaymentGateway {
  charge(amountCents: number, currency: string): { ok: boolean; id: string };
}

// Adaptee: a third-party SDK we cannot change.
class LegacyPayClient {
  makePayment(req: { amount: string; curr: string }): { status: number; ref: string } {
    return { status: req.curr === "USD" ? 200 : 422, ref: `TX-${req.amount}` };
  }
}

// Adapter: implements the Target by translating to the Adaptee.
class LegacyPayAdapter implements PaymentGateway {
  constructor(private client: LegacyPayClient) {}

  charge(amountCents: number, currency: string) {
    const res = this.client.makePayment({
      amount: (amountCents / 100).toFixed(2),
      curr: currency.toUpperCase(),
    });
    return { ok: res.status === 200, id: res.ref };
  }
}

// Client code knows nothing about LegacyPayClient.
function checkout(gateway: PaymentGateway, totalCents: number): string {
  const result = gateway.charge(totalCents, "usd");
  return result.ok ? `paid ${result.id}` : "payment failed";
}

console.log(checkout(new LegacyPayAdapter(new LegacyPayClient()), 1250)); // paid TX-12.50

以后换用其他服务商，只需再写一个适配器。checkout 和其他所有调用方都保持不变，测试时也可以传入一个假的 PaymentGateway。

对象适配器与类适配器

GoF 一书描述了两种形式：

在 TypeScript 和 JavaScript 中，适配一个函数往往就够了。Node.js 自带了一个这类小适配器：util.promisify() 能把回调风格的函数转换成返回 promise 的函数。

import { promisify } from "node:util";

// Adaptee: old callback style (error first, then result).
function readConfig(name: string, cb: (err: Error | null, value?: string) => void): void {
  setTimeout(() => cb(null, `config for ${name}`), 10);
}

// Adapted: the same function, now with a promise-based interface.
const readConfigAsync = promisify(readConfig);
console.log(await readConfigAsync("app")); // config for app

何时使用，何时不用

以下情况适合使用适配器：

• 你想使用一个现有的类，但它的接口与你的代码所需要的不匹配。
• 你要集成第三方库或遗留系统，并希望把它们的 API 限制在程序的边缘。
• 你希望把多个不同的实现（比如两家支付服务商）放在同一个接口之后。

以下情况应避免使用：

• 两边的代码都归你管。修改其中一个接口，通常比增加一层转换更简单。
• 适配器要伪造被适配者其实无法支持的大部分目标接口。这样只是掩盖了真正的不匹配，而不是解决它。

实际应用

• Node.js：util.promisify() 把基于回调的函数适配成 promise。
• Java：Arrays.asList() 让数组可以通过 List 接口来使用，InputStreamReader 让基于字节的 InputStream 可以当作基于字符的 Reader 来读取。
• 数据库库和 ORM 为每种数据库使用一个适配器或驱动，使同一套查询 API 能用于 PostgreSQL、MySQL 或 SQLite。
• 前端代码出于同样的原因，常常把浏览器 API 或统计 SDK 包装在项目自己定义的小接口后面。

相关模式