适配器模式的原理与实现

适配器模式的英文翻译是 Adapter Design Pattern。顾名思义，这个模式就是用来做适配的，它将不兼容的接口转换为可兼容的接口，让原本由于接口不兼容而不能一起工作的类可以一起工作。对于这个模式，有一个经常被拿来解释它的例子，就是 USB 转接头充当适配器，把两种不兼容的接口，通过转接变得可以一起工作。

我们再来看下它的实现。适配器模式有两种实现方式：类适配器和对象适配器。其中，类适配器使用继承关系来实现，对象适配器使用组合关系来实现。具体的 UML 如下所示。其中，Target 表示要转化成的接口定义。Adaptee 是一组不兼容 Target 接口定义的接口，Adaptor 将 Adaptee 转化成一组符合 Target 接口定义的接口。
未命名文件 (2).jpg
代码实现如下：

  1. public interface Target {
  2.     void request();
  3.     void f1();
  4.     void f2();
  5. }
  7. public class Adaptee {
  8.     public void specificRequest() { //... }
  9.     public void fa() { //... }
  10.     public void fb() { //... }
  11. }
  13. // 类适配器: 基于继承
  14. public class Adaptor extends Adaptee implements Target {
  15.     // 适配
  16.     public void request() {
  17.       super.specificRequest();
  18.     }
  20.     // 这里fa、fb不需要实现，直接继承自Adaptee，这是跟对象适配器最大的不同点
  21. }
  23. // 对象适配器: 基于组合
  24. public class Adaptor implements Target {
  26.     private Adaptee adaptee;
  28.     public Adaptor(Adaptee adaptee) {
  29.       this.adaptee = adaptee;
  30.     }
  32.     // 适配
  33.     public void request() {
  34.       adaptee.specificRequest();
  35.     }
  36.     // fa、fb方法还要再实现一下
  37.     public void fa() {
  38.         adaptee.fa();
  39.     }
  40.     public void fb() {
  41.         adaptee.fb();
  42.     }
  43. }

针对这两种实现方式，在实际的开发中，到底该如何选择使用哪一种呢？判断的标准主要有两个，一个是 Adaptee 接口的个数，另一个是 Adaptee 和 Target 的契合程度。

  • 如果 Adaptee 接口并不多，那两种实现方式都可以。
  • 如果 Adaptee 接口很多，而且 Adaptee 和 Target 接口定义大部分都相同，那我们推荐使用类适配器，因为 Adaptor 复用父类 Adaptee 的接口，比起对象适配器的实现方式，Adaptor 的代码量要少一些。
  • 如果 Adaptee 接口很多，而且 Adaptee 和 Target 接口定义大部分都不相同，那我们推荐使用对象适配器，因为组合结构相对于继承更加灵活。

适配器模式的应用场景

一般来说，适配器模式可以看作一种“补偿模式”，用来补救设计上的缺陷。应用这种模式算是“无奈之举”。如果在设计初期，我们就能协调规避接口不兼容的问题，那这种模式就没有应用的机会了。

1. 封装有缺陷的接口设计

假设我们依赖的外部系统在接口设计方面有缺陷（比如包含大量静态方法），引入之后会影响到我们自身代码的可测试性。为了隔离设计上的缺陷，我们希望对外部系统提供的接口进行二次封装，抽象出更好的接口设计，这个时候就可以使用适配器模式了。

2. 统一多个类的接口设计

某个功能的实现依赖多个外部系统（或者说类）。通过适配器模式，将它们的接口适配为统一的接口定义，然后我们就可以使用多态的特性来复用代码逻辑。举个例子来解释一下。

假设我们的系统要对用户输入的文本内容做敏感词过滤，为了提高过滤的召回率，我们引入了多款第三方敏感词过滤系统，依次对用户输入的内容进行过滤，过滤掉尽可能多的敏感词。但是，每个系统提供的过滤接口都是不同的。这就意味着我们没法复用一套逻辑来调用各个系统。这个时候，我们就可以使用适配器模式，将所有系统的接口适配为统一的接口定义，这样我们可以复用调用敏感词过滤的代码。具体代码示例如下：

  1. // A敏感词过滤系统提供的接口
  2. public class ASensitiveWordsFilter { 
  3.     public String filterSexyWords(String text) { // ... }
  4. }
  6. // B敏感词过滤系统提供的接口
  7. public class BSensitiveWordsFilter  { 
  8.     public String filter(String text) { //... }
  9. }
  11. // C敏感词过滤系统提供的接口    
  12. public class CSensitiveWordsFilter {
  13.     public String filter(String text, String mask) { //... }
  14. }
  16. // 未使用适配器模式之前的代码：代码的可测试性、扩展性不好
  17. public class RiskManagement {
  19.     private ASensitiveWordsFilter aFilter = new ASensitiveWordsFilter();
  20.     private BSensitiveWordsFilter bFilter = new BSensitiveWordsFilter();
  21.     private CSensitiveWordsFilter cFilter = new CSensitiveWordsFilter();
  23.     public String filterSensitiveWords(String text) {
  24.         String maskedText = aFilter.filterSexyWords(text);
  25.         maskedText = aFilter.filterPoliticalWords(maskedText);
  26.         maskedText = bFilter.filter(maskedText);
  27.         maskedText = cFilter.filter(maskedText, "***");
  28.         return maskedText;
  29.     }
  30. }
  32. // 使用适配器模式进行改造
  33. public interface ISensitiveWordsFilter {
  34.     // 统一接口定义
  35.     String filter(String text);
  36. }
  38. public class ASensitiveWordsFilterAdaptor implements ISensitiveWordsFilter {
  39.     private ASensitiveWordsFilter aFilter;
  40.     public String filter(String text) {
  41.         String maskedText = aFilter.filterSexyWords(text);
  42.         maskedText = aFilter.filterPoliticalWords(maskedText);
  43.         return maskedText;
  44.     }
  45. }
  46. // ...省略BSensitiveWordsFilterAdaptor、CSensitiveWordsFilterAdaptor...
  48. // 扩展性更好，更加符合开闭原则，如果添加一个新的敏感词过滤系统，这个类完全不需要改动；而且基于接口而非实现编程，代码的可测试性更好。
  49. public class RiskManagement { 
  51.     private List<ISensitiveWordsFilter> filters = new ArrayList<>();
  53.     public void addSensitiveWordsFilter(ISensitiveWordsFilter filter) {
  54.         filters.add(filter);
  55.     }
  57.     public String filterSensitiveWords(String text) {
  58.         String maskedText = text;
  59.         for (ISensitiveWordsFilter filter : filters) {
  60.             maskedText = filter.filter(maskedText);
  61.         }
  62.         return maskedText;
  63.     }
  64. }

3. 替换依赖的外部系统

当我们把项目中依赖的一个外部系统替换为另一个外部系统的时候，利用适配器模式可以减少对代码的改动。

4. 兼容老版本接口

在做版本升级的时候，对于一些要废弃的接口，我们不直接将其删除，而是暂时保留，并且标注为 Deprecated，并将内部实现逻辑委托为新的接口实现。这样做的好处是，让使用它的项目有个过渡期，而不是强制进行代码修改。这也可以粗略地看作适配器模式的一个应用场景。

比如，JDK1.0 中包含一个遍历集合容器的类 Enumeration。JDK2.0 对这个类进行了重构，将它改名为 Iterator 类并对它的代码实现做了优化。但考虑到如果将 Enumeration 直接从 JDK2.0 中删除，那使用 JDK1.0 的项目如果切换到 JDK2.0，代码就会编译不通过。为了避免这种情况的发生，我们必须把项目中所有使用到 Enumeration 的地方，都修改为使用 Iterator 才行。由于使用 Java 开发的项目太多了，一次 JDK 升级导致所有的项目不做代码修改就会编译报错，这显然是不合理的。这就是我们常说的不兼容升级。为了做到兼容使用低版本 JDK 的老代码，我们可以暂时保留 Enumeration 类，并将其实现替换为直接调用 Itertor。

  1. public class Collections {
  2.     public static Emueration emumeration(final Collection c) {
  3.         return new Enumeration() {
  4.             Iterator i = c.iterator();
  6.             public boolean hasMoreElments() {
  7.                 return i.hashNext();
  8.             }
  9.             public Object nextElement() {
  10.                 return i.next():
  11.             }
  12.         }
  13.     }
  14. }

5. 适配不同格式的数据

前面我们讲到，适配器模式主要用于接口的适配，实际上，它还可以用在不同格式的数据之间的适配。比如，把从不同征信系统拉取的不同格式的征信数据，统一为相同的格式，以方便存储和使用。再比如，Java 中的 Arrays.asList() 也可以看作一种数据适配器，将数组类型的数据转化为集合容器类型。

代理、装饰器、适配器模式的区别

代理、装饰器、适配器，这三种模式是比较常用的结构型设计模式。它们的代码结构非常相似。笼统来说，它们都可以称为 Wrapper 模式，也就是通过 Wrapper 类二次封装原始类。尽管代码结构相似，但这三种设计模式的用意完全不同，也就是说要解决的问题、应用场景不同，这也是它们的主要区别。

  • 代理模式：代理模式在不改变原始类接口的条件下，为原始类定义一个代理类，主要目的是控制访问，而非加强功能，这是它跟装饰器模式最大的不同。
  • 装饰器模式：装饰者模式在不改变原始类接口的情况下，对原始类功能进行增强，并且支持多个装饰器的嵌套使用。
  • 适配器模式：适配器模式是一种事后的补救策略。适配器提供跟原始类不同的接口，而代理模式、装饰器模式提供的都是跟原始类相同的接口。

适配器模式使用案例

1. Java 日志框架

Java 中有很多日志框架，在项目开发中，我们常常用它们来打印日志信息。其中，比较常用的有 log4j、logback，以及 JDK 提供的 JUL(java.util.logging) 和 Apache 的 JCL(Jakarta Commons Logging) 等。大部分日志框架都提供了相似的功能，比如按照不同级别（debug、info、warn、erro……）打印日志等，但它们却并没有实现统一的接口。这主要可能是历史原因。

如果我们只是开发一个自己用的项目，那用什么日志框架都可以。但是，如果我们开发的是一个集成到其他系统的组件、框架、类库等，那日志框架的选择就没那么随意了。比如，项目中用到的某个组件使用 log4j 来打印日志，而我们项目本身使用的是 logback。将组件引入到项目之后，我们的项目就相当于有了两套日志打印框架。每种日志框架都有自己特有的配置方式。所以，我们要针对每种日志框架编写不同的配置文件。如果引入多个组件，每个组件使用的日志框架都不一样，那日志本身的管理工作就变得非常复杂。所以，为了解决这个问题，我们需要统一日志打印框架。

为此，Slf4j 应运而生，它提供了一套打印日志的统一接口规范。不过，它只定义了接口，并没有提供具体的实现，因此需要配合其他日志框架（log4j、logback……）来使用。不仅如此，由于 Slf4j 的出现晚于 JUL、JCL、log4j 等日志框架，所以，这些日志框架也不可能牺牲掉版本兼容性，将接口改造成符合 Slf4j 接口规范。Slf4j 也事先考虑到了这个问题，所以，它不仅仅提供了统一的接口定义，还提供了针对不同日志框架的适配器。对不同日志框架的接口进行二次封装，适配成统一的 Slf4j 接口定义。具体的代码示例如下：

  1. // slf4j统一的接口定义
  2. package org.slf4j;
  3. public interface Logger {
  4.     public boolean isTraceEnabled();
  5.     public void trace(String msg);
  6.     public void trace(String format, Object arg);
  7.     public void trace(String format, Object arg1, Object arg2);
  8.     public void trace(String format, Object[] argArray);
  9.     public void trace(String msg, Throwable t);
  10.     public boolean isDebugEnabled();
  11.     public void debug(String msg);
  12.     public void debug(String format, Object arg);
  13.     public void debug(String format, Object arg1, Object arg2)
  14.     public void debug(String format, Object[] argArray)
  15.     public void debug(String msg, Throwable t);
  16.     //...
  17. }
  19. // log4j日志框架的适配器
  20. // LocationAwareLogger继承自Logger接口，也就相当于Log4jLoggerAdapter实现了Logger接口。
  21. package org.slf4j.impl;
  22. public final class Log4jLoggerAdapter extends MarkerIgnoringBase implements LocationAwareLogger, Serializable {
  24.     final transient org.apache.log4j.Logger logger; // log4j
  26.     public boolean isDebugEnabled() {
  27.         return logger.isDebugEnabled();
  28.     }
  30.     public void debug(String msg) {
  31.         logger.log(FQCN, Level.DEBUG, msg, null);
  32.     }
  34.     public void debug(String format, Object arg) {
  35.         if (logger.isDebugEnabled()) {
  36.             FormattingTuple ft = MessageFormatter.format(format, arg);
  37.             logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
  38.         }
  39.     }
  40.     //...
  41. }

所以，在开发业务系统或者开发框架、组件的时候，我们统一使用 Slf4j 提供的接口来编写打印日志的代码，具体使用哪种日志框架实现（log4j、logback……），是可以动态地指定的（借助 Java 的 SPI 技术），只需要将相应的依赖导入到项目中即可。

不过，你可能会说，如果一些老的项目没有使用 Slf4j，而是直接使用比如 JCL 来打印日志，那如果想要替换成其他日志框架，比如 log4j，该怎么办呢？实际上，Slf4j 不仅仅提供了从其他日志框架到 Slf4j 的适配器，还提供了反向适配器，也就是从 Slf4j 到其他日志框架的适配。我们可以先将 JCL 切换为 Slf4j，然后再将 Slf4j 切换为 log4j。经过两次适配器的转换，我们就能成功将 JCL 切换为了 log4j。

2. Spring MVC HandlerAdapter

在 Spring MVC 中，定义一个 Controller 最常用的方式是，通过 @Controller 注解来标记某个类是 Controller 类，通过 @RequesMapping 注解来标记函数对应的 URL。此外，我们还可以通过让类实现 Controller 接口或者 Servlet 接口来定义一个 Controller。这三种定义方式的示例代码，如下所示：

  1. // 方法一：通过@Controller、@RequestMapping来定义
  2. @Controller
  3. public class DemoController {
  4.     @RequestMapping("/employname")
  5.     public ModelAndView getEmployeeName() {
  6.         // ...
  7.     }  
  8. }
  10. // 方法二：实现Controller接口 + xml配置文件:配置DemoController与URL的对应关系
  11. public class DemoController implements Controller {
  12.     @Override
  13.     public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception {
  14.         // ...
  15.     }
  16. }
  18. // 方法三：实现Servlet接口 + xml配置文件:配置DemoController类与URL的对应关系
  19. public class DemoServlet extends HttpServlet {
  20.     @Override
  21.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  22.         // ...
  23.     }
  24.     @Override
  25.     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  26.         // ...
  27.     }
  28. }

在应用启动的时候，Spring 容器会加载这些 Controller 类，并且解析出 URL 对应的处理函数，封装成 Handler 对象，存储到 HandlerMapping 对象中。当有请求到来的时候，DispatcherServlet 从 HanderMapping 中，查找请求 URL 对应的 Handler，然后调用 Handler 对应的函数代码，最后将执行结果返回给客户端。

但是，不同方式定义的 Controller，其函数的定义（函数名、入参、返回值等）是不统一的。如上示例代码所示，方法一中的函数的定义很随意、不固定，方法二中的函数定义是 handleRequest()、方法三中的函数定义是 service()（实际上 DispatcherServlet 调用的是父类 Servlet 中的 service() 方法）。DispatcherServlet 需要根据不同类型的 Controller，调用不同的函数。下面是具体的伪代码：

  1. Handler handler = handlerMapping.get(URL);
  2. if (handler instanceof Controller) {
  3.   ((Controller)handler).handleRequest(...);
  4. } else if (handler instanceof Servlet) {
  5.   ((Servlet)handler).service(...);
  6. } else if (hanlder 对应通过注解来定义的Controller) {
  7.   反射调用方法...
  8. }

从代码中可以看到，这种实现方式会有很多 if-else 分支判断，而且，如果要增加一个新的 Controller 的定义方法，我们就要修改 DispatcherServlet 类中的这段 if 逻辑。这显然不符合开闭原则。

实际上，我们可以利用适配器模式对代码进行改造，让其满足开闭原则，能更好地支持扩展。利用适配器模式，我们将不同方式定义的 Controller 类中的函数，适配为统一的函数定义。这样，我们就能在 DispatcherServlet 类代码中，移除掉 if-else 分支判断逻辑，调用统一的函数。我们具体看下 Spring 的代码实现。

Spring 定义了统一的接口 HandlerAdapter，并且对每种 Controller 定义了对应的适配器类。这些适配器类包括：AnnotationMethodHandlerAdapter、SimpleControllerHandlerAdapter、SimpleServletHandlerAdapter 等。

  1. public interface HandlerAdapter {
  2.     boolean supports(Object var1);
  3.     ModelAndView handle(HttpServletRequest var1, HttpServletResponse var2, Object var3) throws Exception;
  4.     long getLastModified(HttpServletRequest var1, Object var2);
  5. }
  7. // 对应实现Controller接口的Controller
  8. public class SimpleControllerHandlerAdapter implements HandlerAdapter {
  9.     public boolean supports(Object handler) {
  10.         return handler instanceof Controller;
  11.     }
  12.     public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  13.         return ((Controller)handler).handleRequest(request, response);
  14.     }
  15.     public long getLastModified(HttpServletRequest request, Object handler) {
  16.         return handler instanceof LastModified ? ((LastModified)handler).getLastModified(request) : -1L;
  17.     }
  18. }
  20. // 对应实现Servlet接口的Controller
  21. public class SimpleServletHandlerAdapter implements HandlerAdapter {
  22.     public boolean supports(Object handler) {
  23.         return handler instanceof Servlet;
  24.     }
  25.     public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  26.         ((Servlet)handler).service(request, response);
  27.         return null;
  28.     }
  29.     public long getLastModified(HttpServletRequest request, Object handler) {
  30.         return -1L;
  31.     }
  32. }
  34. // ...AnnotationMethodHandlerAdapter对应通过注解实现的Controller

这样，在 DispatcherServlet 类中，我们就不需要区分对待不同的 Controller 对象了，直接统一调用 HandlerAdapter 的 handle() 函数就可以了。

  1. HandlerAdapter handlerAdapter = handlerMapping.get(URL);
  2. handlerAdapter.handle(...);