前面几节课我们学习了代理模式、桥接模式、装饰器模式,今天,我们再来学习一个比较常用的结构型模式:适配器模式。这个模式相对来说还是比较简单、好理解的,应用场景也很具体,总体上来讲比较好掌握。


关于适配器模式,今天我们主要学习它的两种实现方式,类适配器和对象适配器,以及 5 种常见的应用场景。同时,我还会通过剖析 slf4j 日志框架,来给你展示这个模式在真实项目中的应用。
除此之外,在文章的最后,我还对代理、桥接、装饰器、适配器,这 4 种代码结构非常相似的设计模式做简单的对比,对这几节内容做一个简单的总结。
话不多说,让我们正式开始今天的学习吧!

适配器模式的原理与实现

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


原理很简单,我们再来看下适配器模式的代码实现。
适配器模式有两种实现方式:类适配器和对象适配器。
其中,类适配器使用继承关系来实现,对象适配器使用组合关系来实现。
具体的代码实现如下所示。

  • ITarget 表示要转化成的接口定义;
  • Adaptee 是一组不兼容 ITarget 接口定义的接口;
  • Adaptor 将 Adaptee 转化成一组符合 ITarget 接口定义的接口。 ```java // 类适配器: 基于继承 public interface ITarget { void f1();

    void f2();

    void fc(); }

public class Adaptee { public void fa() { //… }

  1. public void fb() {
  2. //...
  3. }
  4. public void fc() {
  5. //...
  6. }

}

public class Adaptor extends Adaptee implements ITarget { public void f1() { super.fa(); }

  1. public void f2() {
  2. //...重新实现f2()...
  3. }
  4. // 这里fc()不需要实现,直接继承自Adaptee,这是跟对象适配器最大的不同点

}

// 对象适配器:基于组合 public interface ITarget { void f1();

  1. void f2();
  2. void fc();

}

public class Adaptee { public void fa() { //… }

  1. public void fb() {
  2. //...
  3. }
  4. public void fc() {
  5. //...
  6. }

}

public class Adaptor implements ITarget { private Adaptee adaptee;

  1. public Adaptor(Adaptee adaptee) {
  2. this.adaptee = adaptee;
  3. }
  4. public void f1() {
  5. adaptee.fa(); //委托给Adaptee
  6. }
  7. public void f2() {
  8. //...重新实现f2()...
  9. }
  10. public void fc() {
  11. adaptee.fc();
  12. }

}

  1. 针对这两种实现方式,在实际的开发中,到底该如何选择使用哪一种呢?<br />判断的标准主要有两个:
  2. - 一个是 Adaptee 接口的个数;
  3. - 另一个是 Adaptee ITarget 的契合程度。
  4. 如果 Adaptee 接口并不多,那两种实现方式都可以。<br />如果 Adaptee 接口很多,而且 Adaptee ITarget 接口定义大部分都相同,那我们推荐使用类适配器,因为 Adaptor 复用父类 Adaptee 的接口,比起对象适配器的实现方式,Adaptor 的代码量要少一些。<br />如果 Adaptee 接口很多,而且 Adaptee ITarget 接口定义大部分都不相同,那我们推荐使用对象适配器,因为组合结构相对于继承更加灵活。
  5. <a name="UpYsR"></a>
  6. ## 适配器模式应用场景总结
  7. 原理和实现讲完了,都不复杂。我们再来看,到底什么时候会用到适配器模式呢?<br />一般来说,适配器模式可以看作一种“补偿模式”,用来补救设计上的缺陷。应用这种模式算是“无奈之举”。如果在设计初期,我们就能协调规避接口不兼容的问题,那这种模式就没有应用的机会了。
  8. ---
  9. 前面我们反复提到,适配器模式的应用场景是“接口不兼容”。<br />那在实际的开发中,什么情况下才会出现接口不兼容呢?<br />我建议你先自己思考一下这个问题,然后再来看我下面的总结
  10. <a name="SZiJw"></a>
  11. ### 1. 封装有缺陷的接口设计
  12. 假设我们依赖的外部系统在接口设计方面有缺陷(比如包含大量静态方法),引入之后会影响到我们自身代码的可测试性。为了隔离设计上的缺陷,我们希望对外部系统提供的接口进行二次封装,抽象出更好的接口设计,这个时候就可以使用适配器模式了。<br />具体我还是举个例子来解释一下,你直接看代码应该会更清晰。<br />具体代码如下所示:
  13. ```java
  14. public class CD { //这个类来自外部sdk,我们无权修改它的代码
  15. //...
  16. public static void staticFunction1() {
  17. //...
  18. }
  19. public void uglyNamingFunction2() {
  20. //...
  21. }
  22. public void tooManyParamsFunction3(int paramA, int paramB, ...) {
  23. //...
  24. }
  25. public void lowPerformanceFunction4() {
  26. //...
  27. }
  28. }
  29. // 使用适配器模式进行重构
  30. public class ITarget {
  31. void function1();
  32. void function2();
  33. void fucntion3(ParamsWrapperDefinition paramsWrapper);
  34. void function4();
  35. //...
  36. }
  37. // 注意:适配器类的命名不一定非得末尾带Adaptor
  38. public class CDAdaptor extends CD implements ITarget {
  39. //...
  40. public void function1() {
  41. super.staticFunction1();
  42. }
  43. public void function2() {
  44. super.uglyNamingFucntion2();
  45. }
  46. public void function3(ParamsWrapperDefinition paramsWrapper) {
  47. super.tooManyParamsFunction3(paramsWrapper.getParamA(), ...);
  48. }
  49. public void function4() {
  50. //...reimplement it...
  51. }
  52. }

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

某个功能的实现依赖多个外部系统(或者说类)。
通过适配器模式,将它们的接口适配为统一的接口定义,然后我们就可以使用多态的特性来复用代码逻辑。
具体我还是举个例子来解释一下。
假设我们的系统要对用户输入的文本内容做敏感词过滤,为了提高过滤的召回率,我们引入了多款第三方敏感词过滤系统,依次对用户输入的内容进行过滤,过滤掉尽可能多的敏感词。但是,每个系统提供的过滤接口都是不同的。这就意味着我们没法复用一套逻辑来调用各个系统。
这个时候,我们就可以使用适配器模式,将所有系统的接口适配为统一的接口定义,这样我们可以复用调用敏感词过滤的代码。
你可以配合着下面的代码示例,来理解我刚才举的这个例子。

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

3. 替换依赖的外部系统

当我们把项目中依赖的一个外部系统替换为另一个外部系统的时候,利用适配器模式,可以减少对代码的改动。
具体的代码示例如下所示:

  1. // 外部系统A
  2. public interface IA {
  3. //...
  4. void fa();
  5. }
  6. public class A implements IA {
  7. //...
  8. public void fa() {
  9. //...
  10. }
  11. }
  12. // 在我们的项目中,外部系统A的使用示例
  13. public class Demo {
  14. private IA a;
  15. public Demo(IA a) {
  16. this.a = a;
  17. }
  18. //...
  19. }
  20. Demo d = new Demo(new A());
  21. // 将外部系统A替换成外部系统B
  22. public class BAdaptor implemnts IA {
  23. private B b;
  24. public BAdaptor(B b) {
  25. this.b = b;
  26. }
  27. public void fa() {
  28. //...
  29. b.fb();
  30. }
  31. }
  32. // 借助BAdaptor,Demo的代码中,调用IA接口的地方都无需改动,
  33. // 只需要将BAdaptor如下注入到Demo即可。
  34. Demo d = new Demo(new BAdaptor(new B()));

4. 兼容老版本接口

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


同样,我还是通过一个例子,来进一步解释一下。
JDK1.0 中包含一个遍历集合容器的类 Enumeration。
JDK2.0 对这个类进行了重构,将它改名为 Iterator 类,并且对它的代码实现做了优化。
但是考虑到如果将 Enumeration 直接从 JDK2.0 中删除,那使用 JDK1.0 的项目如果切换到 JDK2.0,代码就会编译不通过。为了避免这种情况的发生,我们必须把项目中所有使用到 Enumeration 的地方,都修改为使用 Iterator 才行。
单独一个项目做 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();
  5. public boolean hasMoreElments() {
  6. return i.hashNext();
  7. }
  8. public Object nextElement() {
  9. return i.next():
  10. }
  11. }
  12. }
  13. }

5. 适配不同格式的数据

前面我们讲到,适配器模式主要用于接口的适配,实际上,它还可以用在不同格式的数据之间的适配。

  • 比如,把从不同征信系统拉取的不同格式的征信数据,统一为相同的格式,以方便存储和使用。
  • 再比如,Java 中的 Arrays.asList() 也可以看作一种数据适配器,将数组类型的数据转化为集合容器类型。
    1. List<String> stooges = Arrays.asList("Larry", "Moe", "Curly");

    剖析适配器模式在 Java 日志中的应用

    Java 中有很多日志框架,在项目开发中,我们常常用它们来打印日志信息。
    其中,比较常用的有 log4j、logback,以及 JDK 提供的 JUL(java.util.logging) 和 Apache 的 JCL(Jakarta Commons Logging) 等。
    大部分日志框架都提供了相似的功能,比如按照不同级别(debug、info、warn、erro……)打印日志等,但这些日志框架却并没有实现统一的接口。这主要可能是历史的原因,它不像 JDBC 那样,一开始就制定了数据库操作的接口规范。
    如果我们只是开发一个自己用的项目,那用什么日志框架都可以,log4j、logback 随便选一个就好。但是,如果我们开发的是一个集成到其他系统的组件、框架、类库等,那日志框架的选择就没那么随意了。

比如,项目中用到的某个组件使用 log4j 来打印日志,而我们项目本身使用的是 logback。将组件引入到项目之后,我们的项目就相当于有了两套日志打印框架。每种日志框架都有自己特有的配置方式。所以,我们要针对每种日志框架编写不同的配置文件(比如,日志存储的文件地址、打印日志的格式)。
如果引入多个组件,每个组件使用的日志框架都不一样,那日志本身的管理工作就变得非常复杂。所以,为了解决这个问题,我们需要统一日志打印框架。
如果你是做 Java 开发的,那 Slf4j 这个日志框架你肯定不陌生,它相当于 JDBC 规范,提供了一套打印日志的统一接口规范。不过,它只定义了接口,并没有提供具体的实现,需要配合其他日志框架(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. //...省略info、warn、error等一堆接口
  17. }
  18. // log4j日志框架的适配器
  19. // Log4jLoggerAdapter实现了LocationAwareLogger接口,
  20. // 其中LocationAwareLogger继承自Logger接口,
  21. // 也就相当于Log4jLoggerAdapter实现了Logger接口。
  22. package org.slf4j.impl;
  23. public final class Log4jLoggerAdapter extends MarkerIgnoringBase implements LocationAwareLogger, Serializable {
  24. final transient org.apache.log4j.Logger logger; // log4j
  25. public boolean isDebugEnabled() {
  26. return logger.isDebugEnabled();
  27. }
  28. public void debug(String msg) {
  29. logger.log(FQCN, Level.DEBUG, msg, null);
  30. }
  31. public void debug(String format, Object arg) {
  32. if (logger.isDebugEnabled()) {
  33. FormattingTuple ft = MessageFormatter.format(format, arg);
  34. logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
  35. }
  36. }
  37. public void debug(String format, Object arg1, Object arg2) {
  38. if (logger.isDebugEnabled()) {
  39. FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
  40. logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
  41. }
  42. }
  43. public void debug(String format, Object[] argArray) {
  44. if (logger.isDebugEnabled()) {
  45. FormattingTuple ft = MessageFormatter.arrayFormat(format, argArray);
  46. logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
  47. }
  48. }
  49. public void debug(String msg, Throwable t) {
  50. logger.log(FQCN, Level.DEBUG, msg, t);
  51. }
  52. //...省略一堆接口的实现...
  53. }

所以,在开发业务系统或者开发框架、组件的时候,我们统一使用 Slf4j 提供的接口来编写打印日志的代码,具体使用哪种日志框架实现(log4j、logback……),是可以动态地指定的(使用 Java 的 SPI 技术,这里我不多解释,你自行研究吧),只需要将相应的 SDK 导入到项目中即可。


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

代理、桥接、装饰器、适配器 4 种设计模式的区别

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


代理模式:代理模式在不改变原始类接口的条件下,为原始类定义一个代理类,主要目的是控制访问,而非加强功能,这是它跟装饰器模式最大的不同。
桥接模式:桥接模式的目的是将接口部分和实现部分分离,从而让它们可以较为容易、也相对独立地加以改变。
装饰器模式:装饰者模式在不改变原始类接口的情况下,对原始类功能进行增强,并且支持多个装饰器的嵌套使用。
适配器模式:适配器模式是一种事后的补救策略。适配器提供跟原始类不同的接口,而代理模式、装饰器模式提供的都是跟原始类相同的接口。

重点回顾

好了,今天的内容到此就讲完了。让我们一块来总结回顾一下,你需要重点掌握的内容。
适配器模式是用来做适配,它将不兼容的接口转换为可兼容的接口,让原本由于接口不兼容而不能一起工作的类可以一起工作。
适配器模式有两种实现方式:类适配器和对象适配器。
其中,类适配器使用继承关系来实现,对象适配器使用组合关系来实现。
一般来说,适配器模式可以看作一种“补偿模式”,用来补救设计上的缺陷。应用这种模式算是“无奈之举”,如果在设计初期,我们就能协调规避接口不兼容的问题,那这种模式就没有应用的机会了。


那在实际的开发中,什么情况下才会出现接口不兼容呢?我总结下了下面这样 5 种场景:

  • 封装有缺陷的接口设计
  • 统一多个类的接口设计
  • 替换依赖的外部系统
  • 兼容老版本接口
  • 适配不同格式的数据

    课堂讨论

    今天我们讲到,适配器有两种实现方式:类适配器、对象适配器。
    那我们之前讲到的代理模式、装饰器模式,是否也同样可以有两种实现方式(类代理模式、对象代理模式,以及类装饰器模式、对象装饰器模式)呢?