当前位置:   article > 正文

设计模式之适配器模式:如何处理不同 API 接口的兼容性?_api适配器是什么

api适配器是什么

在前面的五讲中,我们一起学习了创建型的设计模式。从今天开始,我们就开始学习另外一组设计模式——结构型模式。如果说创建型设计模式的关注重点在于一个对象内部结构的话(常常是接口与实现的组合),那么结构性设计模式的关注重点就在于多个对象之间的组合方式

结构型设计模式一共包括七种:适配器模式、桥接模式、组合模式、装饰模式、门面模式、享元模式和代理模式。今天这一讲,我们主要讲解最常用到的适配器模式。

那么,话不多说,让我们开始今天的学习吧!

模式原理分析

适配器模式的原始定义是:将类的接口转换为客户期望的另一个接口,适配器可以让不兼容的两个类一起协同工作。

该定义中明确说明了适配器模式的关键点就在于转换,而转换时要在已有的接口基础上做好兼容

这里我们还是直接来看看适配器模式的 UML 图,如下所示:

image.png

从 UML 图中,我们可以看出适配器模式中包含三个关键角色:

  • 目标类, 适配器类即将要进行适配的抽象类或接口;

  • 适配器类, 可以是类或接口,是作为具体适配者类的中间类来使用;

  • 具体适配者类, 可以是内部的类或服务,也可以是外部对象或服务。

我们再来看看 UML 图对应的代码实现,如下所示:

public abstract class TargetAbstraction {

    public abstract String filter(String str);

}

public class TargetAbstractionImpl extends TargetAbstraction {

    @Override

    public String filter(String str) {

        return str.replaceAll("a","A");

    }

}

public class Adapter extends TargetAbstraction {

    private OtherClass otherClass;

    public Adapter() {

        otherClass = new OtherClass();

    }

    @Override

    public String filter(String str) {

        otherClass.preCheck(str);

        return otherClass.replace(str);

    }

}

public class OtherClass {

    public OtherClass() {

    }

    public String replace(String str){

            return str.replaceAll("<","[");

    }

    public void preCheck(String str){

    }

}

  • 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

你会发现,代码实现中的 Adapter 类充当了一个中间者的角色,Adapter 类继承目标类TargetAbstraction 并实现接口 filter,同时在 fliter 中加入新的扩展功能,扩展功能使用具体适配者类 OtherClass 来实现,这样在保留原有 filter 功能的同时,也增加了新的功能。

事实上,适配器模式封装了三个重要事实:

  • 具体适配者类可以有不同的接口;

  • 用户在使用适配器类时实际上使用了多个接口;

  • 适配器类和具体适配者类引入了变化。

如下简图所示,适配器模式的类实际上是作为中间者来封装变化的。

image (1).png

所以说,适配器模式的核心原理就是在原有的接口或类的外层封装一个新的适配器层,以实现扩展对象结构的效果,并且这种扩展可以无限扩展下去

使用场景分析

适配器模式一般常用的使用场景有:

  • 原有接口无法修改时;

  • 原有接口功能太老旧时;

  • 统一多个类的接口设计时;

  • 需要过渡升级旧接口时;

  • 需要依赖外部系统时;

  • 适配不同数据格式时;

  • 不同接口协议转换时。

总结起来,适配器模式的使用场景主要有这两大类:第一类就是原有接口功能不满足现有要求,需要在兼容老接口的同时做适当的扩展;第二类是有相似性的多个不同接口之间做功能的统一

比如,Mac 笔记本电脑使用 Type-C 接口,但通过一个扩展坞就可以转换为 HDMI 视频输出接口、USB 接口等,这样就能很方便地连接外部的 USB 键盘、鼠标、显示器等。再比如,到不同国家去,我们都会随身携带电源转换适配器,以便于将不同国家使用的电源电流标准转化为适合我们自己电器的标准。这些例子本质上都是适配器模式在现实工作和生活中的应用。

同样,各种类库和框架中也都在大量地使用适配器模式。为了帮助你更好地理解适配器的使用,这里我们还是通过一个简单的例子来进一步说明一下。例如,我们想要通过命令行来输入一段字符串,具体代码如下:

BufferedReader br = new BufferedReader(new InputStreamReader(System.in));

System.out.print("Enter String");

String s = br.readLine();

System.out.print("Enter input: " + s);

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

代码的大致逻辑是:我们希望使用 BufferedReader 读取用户从命令行(System.in 提供窗口输入)输入的字符并打印。你会发现,System.in 需要的接口类型是 InputStream,而 BufferedReader 的接口类型却是 Reader 类型,这明显属于期望的接口与实际接口不相符的情况,也对应上面我们所说的“原有接口无法修改时”的场景。这时就是使用适配器模式最好的时机。

代码中的 InputStreamReader 实际上就是充当了适配器的角色,这里我们看一下 InputStreamReader 构造函数的源码:

    public InputStreamReader(InputStream in) {

        super(in);  //适配了原始的Reader接口类型

        try {

            sd = StreamDecoder.forInputStreamReader(in, this, (String)null); // ## check lock object

        } catch (UnsupportedEncodingException e) {

            // The default encoding should always be available

            throw new Error(e);

        }

    }

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

当我们使用 new 关键字来创建 InputStreamReader(System.in) 对象时,实际上最终生成了能够让 BufferedReader 进行读取的 Reader 输入流,这样便实现了适配器模式。

因此,可以这么说,适配器模式的使用场景侧重于将不适用的功能转换到期望可用的功能。

为什么要使用适配器模式?

通过上面的分析,我们还可以总结出选择适配器模式主要有以下三个原因。

第一,原有接口无法修改但又必须快速兼容部分新功能。 有时某些接口会因为一些因素而无法修改,比如,已交接的系统、跨团队、外部公用接口等,但这种情况下又需要适当扩展现有接口的功能,该怎么办呢?能想到的第一个办法就是使用适配器模式进行扩展。适配器模式也被称为“最好用打补丁模式”,就是因为只要是一个接口,都可以用它来进行适配。不过,要注意的是适配的新接口和目标接口差异不大时,扩展才更有效,不要被“适配器就是万能接口”的思维所误导,这就像你非要适配 10 年前的软盘接口一样不现实,也没有必要。

第二,需要使用外部组件组合成新组件来提供功能,而又不想重复开发部分功能。 比如,构建自然语言识别功能时,你不想从零开始训练庞大的中文语义模型来实现 NLP 接口,这时你就可以选择使用外部第三方公共平台提供的 NLP 接口,然后组合实现你自己的 NLP 接口,形成新的组件。虽然这样效率很高,但是依赖外部系统的风险同样突出(如果外部功能变更或下线,则组件可能不可用),只是作为短期的过渡方案,适配器模式可以说是绝佳选择。

第三,不同数据格式、不同协议需要转换。 比如,API 网关中经常需要对 iOS、安卓、H5 等不同的客户端进行数据和通信协议上的适配转换,这时网关就是一个是适配器,适配客户端的同时适配服务端。

收益什么?损失什么?

使用适配器模式主要有以下五个大的优点。

  • 将目标类和具体适配者类解耦。 通过引入一个适配器类来兼容现有的目标类,重用原有类功能的同时扩展新功能,而无须修改原有目标类代码,这样很好地避免了具体适配者类和目标类的直接耦合。

  • 增加了类的透明性。 具体的适配者类中新增功能只影响适配者类,而对于使用目标类的客户端类来说是透明的(使用目标类接口),客户端的调用逻辑不会受到影响。

  • 满足里氏替换原则。 具体适配者类通过适配器类与目标类进行交互,那么适配器类只要不影响目标类的接口功能,具体适配者类无论使用什么样的新功能,都能很方便快速地进行替换。

  • 符合开闭原则。 由于具体适配者类要么是适配器类的子类,要么和适配器类是组合关系,所以对目标类没有修改,满足开闭原则。

  • 统一多个类或接口。 一个适配器类可以把多个不同的具体适配者类和子类,都适配到同一个目标类上,如果这个目标类是一个新类,那么就是间接实现了统一多个类或接口的功能。

同样,适配器模式也有一些缺点。

  • 一次只能适配一个抽象类或接口。 像 Java、C# 等编程语言是不支持多重继承的,那么在进行适配时,一次最多只能适配一个适配者类。另外,目标类只能为抽象类或接口,不能为具体实例类,这样会在适配时增加很多类文件和代码量,如果适配的类或接口比较多,那么就会增加代码的理解难度。

  • 过度嵌套会导致接口臃肿。 适配器有一个最大的弊端就是,一旦不停地在同一个目标类上增加适配器,就会很容易让接口变得越来越臃肿。你见过一个接口被适配 20 次的情景吗?我前不久在工作中就见过,其实这也是开闭原则极端副作用的某种体现。因为不想去修改原有接口,所以就不断使用新接口适配,而维护接口的人又在不断变化,于是就继续按照这个不修改的思路维护下去,表面上的确符合开闭原则,但实际上只不过是将风险不断隐藏罢了。一旦原始接口(目标类)功能下线后,这个适配链条造成的影响会非常大。

  • 目标接口依赖太多适配接口,修改目标接口会导致所有适配接口都需要定制修改。 本来适配器模式是为了解耦,但是如果适配太多接口,就会演变为另一种定制化的开发。比如,上游平台商家提供的接口变更,导致下游使用方频繁变更接口。再比如,消息组件接口的变更导致所有引用消息组件的适配器全部都需要修改。

总结

一般来说,适配器模式能够让一个接口与新的接口实现兼容,从而在新的抽象逻辑层次上统一多个不同的接口。但也正是因为适配器模式太过于灵活了,容易导致过度滥用而造成对象间耦合性过高,所以适配器模式的适配器类最好采用私有继承的方式,以起到限定接口功能范围的作用。

除此之外,在具体使用适配器模式的时候,还要尽量避免过多的嵌套适配,也就是不要不断地在适配器上增加适配器,我的建议是不要超过 3 次适配,超过了就要考虑是否需要重新设计接口功能。

由于结构性设计模式涉及如何组合更多的对象来提升代码结构的灵活性,因此在学习所有结构性设计模式的时候,都要努力建立一个大局观,也就是要多从整体程序设计的大结构去考虑模式应用的场景,不要过度纠结于局部是不是满足模式

设计模式22--金句.png

课后思考

当使用适配器模式的接口中有外部接口抛出异常时,适配器类是该直接透传抛出异常,还是捕获后重新抛出新异常,又或者是直接内部处理?为什么?

欢迎留言分享,我会第一时间给你回复。

在下一讲,我会接着与你分享“桥接模式:如何实现抽象协议与不同实现的绑定?”这个话题,记得按时来听课!

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/代码探险家/article/detail/828892
推荐阅读
相关标签
  

闽ICP备14008679号