Adapter Design Pattern

Posted on

适配器模式的原理与实现

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

适配器模式有两种实现方式：类适配器和对象适配器。其中，类适配器使用继承关系来实现，对象适配器使用组合关系来实现。具体的代码实现如下所示。其中，ITarget 表示要转化成的接口定义。Adaptee 是一组不兼容 ITarget 接口定义的接口，Adaptor 将 Adaptee 转化成一组符合 ITarget 接口定义的接口：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// 类适配器: 基于继承
public interface ITarget 
{
    void f1();
    void f2();
    void fc();
}

public class Adaptee 
{
    public void fa() 
    { 
        //... 
    }
    public void fb() 
    {   
        //... 
    }
    public void fc() 
    { 
        //... 
    }
}

public class Adaptor extends Adaptee implements ITarget 
{
    public void f1() 
    {
        super.fa();
    }
    
    public void f2() 
    {
        //...重新实现 f2()...
    }
    
    // 这里 fc() 不需要实现，直接继承自 Adaptee，这是跟对象适配器最大的不同点
}

// 对象适配器：基于组合
public interface ITarget 
{
    void f1();
    void f2();
    void fc();
}

public class Adaptee 
{
    public void fa() 
    { 
        //... 
    }
    public void fb() 
    { 
        //... 
    }
    public void fc() 
    { 
        //... 
    }
}

public class Adaptor implements ITarget 
{
    private Adaptee adaptee;
    
    public Adaptor(Adaptee adaptee) 
    {
        this.adaptee = adaptee;
    }
    
    public void f1() 
    {
        adaptee.fa(); // 委托给 Adaptee
    }
    
    public void f2() 
    {
        //...重新实现 f2()...
    }
    
    public void fc() 
    {
        adaptee.fc();
    }
}

针对这两种实现方式，选择的标准主要有两个，一个是 Adaptee 接口的个数，另一个是 Adaptee 和 ITarget 的契合程度：

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

适配器模式应用场景总结

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

封装有缺陷的接口设计

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
public class CD 
{ 
    // 这个类来自外部 SDK，我们无权修改它的代码
    //...
    public static void staticFunction1() 
    { 
        //... 
    }
    
    public void uglyNamingFunction2() 
    { 
        //...
    }

    public void tooManyParamsFunction3(int paramA, int paramB, ...) 
    { 
        //... 
    }
    
    public void lowPerformanceFunction4() 
    { 
        //... 
    }
}

// 使用适配器模式进行重构
public interface ITarget 
{
    void function1();
    void function2();
    void function3(ParamsWrapperDefinition paramsWrapper);
    void function4();
    //...
}
// 注意：适配器类的命名不一定非得末尾带 Adaptor
public class CDAdaptor extends CD implements ITarget 
{
    //...
    public void function1() 
    {
        super.staticFunction1();
    }
    
    public void function2() 
    {
        super.uglyNamingFunction2();
    }
    
    public void function3(ParamsWrapperDefinition paramsWrapper) 
    {
        super.tooManyParamsFunction3(paramsWrapper.getParamA(), ...);
    }
    
    public void function4() 
    {
        //...replacement it...
    }
}

统一多个类的接口设计

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
public class ASensitiveWordsFilter 
{ 
    // A 敏感词过滤系统提供的接口
    // text 是原始文本，函数输出用 *** 替换敏感词之后的文本
    public String filterSexyWords(String text) 
    {
        // ...
    }
    
    public String filterPoliticalWords(String text) 
    {
        // ...
    } 
}

public class BSensitiveWordsFilter  
{ 
    // B 敏感词过滤系统提供的接口
    public String filter(String text) 
    {
        //...
    }
}

public class CSensitiveWordsFilter 
{ 
    // C 敏感词过滤系统提供的接口
    public String filter(String text, String mask) 
    {
        //...
    }
}

// 未使用适配器模式之前的代码：代码的可测试性、扩展性不好
public class RiskManagement 
{
    private ASensitiveWordsFilter aFilter = new ASensitiveWordsFilter();
    private BSensitiveWordsFilter bFilter = new BSensitiveWordsFilter();
    private CSensitiveWordsFilter cFilter = new CSensitiveWordsFilter();
    
    public String filterSensitiveWords(String text) 
    {
        String maskedText = aFilter.filterSexyWords(text);
        maskedText = aFilter.filterPoliticalWords(maskedText);
        maskedText = bFilter.filter(maskedText);
        maskedText = cFilter.filter(maskedText, "***");
        return maskedText;
    }
}

// 使用适配器模式进行改造
public interface ISensitiveWordsFilter 
{ 
    // 统一接口定义
    String filter(String text);
}

public class ASensitiveWordsFilterAdaptor implements ISensitiveWordsFilter 
{
    private ASensitiveWordsFilter aFilter;
    public String filter(String text) 
    {
        String maskedText = aFilter.filterSexyWords(text);
        maskedText = aFilter.filterPoliticalWords(maskedText);
        return maskedText;
    }
}
//...省略 BSensitiveWordsFilterAdaptor、CSensitiveWordsFilterAdaptor...

// 扩展性更好，更加符合开闭原则，如果添加一个新的敏感词过滤系统，
// 这个类完全不需要改动；而且基于接口而非实现编程，代码的可测试性更好
public class RiskManagement 
{ 
    private List<ISensitiveWordsFilter> filters = new ArrayList<>();
    
    public void addSensitiveWordsFilter(ISensitiveWordsFilter filter) 
    {
        filters.add(filter);
    }
    
    public String filterSensitiveWords(String text) 
    {
        String maskedText = text;
        for (ISensitiveWordsFilter filter : filters) 
        {
            maskedText = filter.filter(maskedText);
        }
        return maskedText;
    }
}

替换依赖的外部系统

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// 外部系统 A
public interface IA 
{
    //...
    void fa();
}
public class A implements IA 
{
    //...
    public void fa() 
    { 
        //... 
    }
}
// 在我们的项目中，外部系统 A 的使用示例
public class Demo 
{
    private IA a;
    public Demo(IA a) 
    {
        this.a = a;
    }
    //...
}
Demo d = new Demo(new A());

// 将外部系统 A 替换成外部系统 B
public class BAdaptor implements IA 
{
    private B b;
    public BAdaptor(B b) 
    {
        this.b= b;
    }
    public void fa() 
    {
        //...
        b.fb();
    }
}
// 借助 BAdaptor，Demo 的代码中，调用 IA 接口的地方都无需改动，
// 只需要将 BAdaptor 如下注入到 Demo 即可
Demo d = new Demo(new BAdaptor(new B()));

兼容老版本接口

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

JDK1.0 中包含一个遍历集合容器的类 Enumeration。JDK2.0 对这个类进行了重构，将它改名为 Iterator 类，并且对它的代码实现做了优化。但是考虑到如果将 Enumeration 直接从 JDK2.0 中删除，那使用 JDK1.0 的项目如果切换到 JDK2.0，代码就会编译不通过。这就是我们经常所说的不兼容升级。为了做到兼容使用低版本 JDK 的老代码，我们可以暂时保留 Enumeration 类，并将其实现替换为直接调用 Iterator：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class Collections 
{
    public static Enumeration enumeration(final Collection c) 
    {
        return new Enumeration() 
        {
            Iterator i = c.iterator();
            
            public boolean hasMoreElements() 
            {
                return i.hashNext();
            }
            
            public Object nextElement() 
            {
                return i.next():
            }
        }
    }
}

适配不同格式的数据

前面我们讲到，适配器模式主要用于接口的适配，实际上，它还可以用在不同格式的数据之间的适配。比如，把从不同征信系统拉取的不同格式的征信数据，统一为相同的格式，以方便存储和使用。再比如，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) 等。

如果你是做 Java 开发的，那 SLF4J 这个日志框架你肯定不陌生，它相当于 JDBC 规范，提供了一套打印日志的统一接口规范。不过，它只定义了接口，并没有提供具体的实现，需要配合其他日志框架来使用。

不仅如此，SLF4J 的出现晚于 JUL、JCL、Log4j 等日志框架，所以，这些日志框架也不可能牺牲掉版本兼容性，将接口改造成符合 SLF4J 接口规范。SLF4J 也事先考虑到了这个问题，所以，它不仅仅提供了统一的接口定义，还提供了针对不同日志框架的适配器。对不同日志框架的接口进行二次封装，适配成统一的 SLF4J 接口定义：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// SLF4J 统一的接口定义
package org.slf4j;
public interface Logger 
{
    public boolean isTraceEnabled();
    public void trace(String msg);
    public void trace(String format, Object arg);
    public void trace(String format, Object arg1, Object arg2);
    public void trace(String format, Object[] argArray);
    public void trace(String msg, Throwable t);
    
    public boolean isDebugEnabled();
    public void debug(String msg);
    public void debug(String format, Object arg);
    public void debug(String format, Object arg1, Object arg2)
    public void debug(String format, Object[] argArray)
    public void debug(String msg, Throwable t);

    //...省略 info、warn、error 等一堆接口
}

// Log4j 日志框架的适配器
// Log4jLoggerAdapter 实现了 LocationAwareLogger 接口，
// 其中 LocationAwareLogger 继承自 Logger 接口，
// 也就相当于 Log4jLoggerAdapter 实现了 Logger 接口
package org.slf4j.impl;
public final class Log4jLoggerAdapter extends MarkerIgnoringBase implements LocationAwareLogger, Serializable 
{
    final transient org.apache.log4j.Logger logger; // Log4j
    
    public boolean isDebugEnabled() 
    {
        return logger.isDebugEnabled();
    }
    
    public void debug(String msg) 
    {
        logger.log(FQCN, Level.DEBUG, msg, null);
    }
    
    public void debug(String format, Object arg) 
    {
        if (logger.isDebugEnabled()) 
        {
            FormattingTuple ft = MessageFormatter.format(format, arg);
            logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
        }
    }
    
    public void debug(String format, Object arg1, Object arg2) 
    {
        if (logger.isDebugEnabled()) 
        {
            FormattingTuple ft = MessageFormatter.format(format, arg1, arg2);
            logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
        }
    }
    
    public void debug(String format, Object[] argArray) 
    {
        if (logger.isDebugEnabled()) 
        {
            FormattingTuple ft = MessageFormatter.arrayFormat(format, argArray);
            logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable());
        }
    }
    
    public void debug(String msg, Throwable t) 
    {
        logger.log(FQCN, Level.DEBUG, msg, t);
    }
    //...省略一堆接口的实现...
}

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

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

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

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