API网关泛化调用
可能大部分人第一次在软件开发中接触到“泛化”这个词是在学习UML的过程中,泛化是UML所述的四中关系(泛化关系、实现关系、依赖关系、关联关系)中的一种。泛化关系指的是类与类、接口与接口之间的继承关系,UML中用带箭头的实线表示,如下:
本文中讲到的泛化是一个动作,可以理解为“变的宽泛”,由具体到抽象,由特殊到一般的一个动作实现。可以先简单理解为就是没有了具体的POJO,统一使用Map来封装对象。为什么说泛化调用时网关的基石呢?原因之一也在于此,使用者在调用提供者接口时,不再需要依赖服务提供方客户端的JAR包,因此也就没有了POJO,通过泛化的方式进行远程调用。
一般情况下我们需要通过RPC调用接口提供方的服务,首先在消费端嵌入提供方的Jar包,从而使用Jar包中的类和方法。那对于网关服务来说,如果一个网关调用了N个服务,那就需要引入N个Jar依赖,这样网关系统难以维护,如下:
在网关系统中,我们需要另外一种方式实现调用,这就是泛化调用。这种方式不在需要服务提供方提供jar包便可完成RPC调用,其中的原理跟普通的RPC调用时一致的,网络、序列化、反射这些底层的技术原理一致。区别在于参数和返回值都用Map来表示。通过GenericService来调用所有的服务实现。任何一个成熟的RPC框架都会支持泛化调用,比如阿里巴巴优秀的RPC框架Dubbo官网提供的泛化为例,示例代码:
import org.apache.dubbo.rpc.service.GenericService;
...
// 引用远程服务
// 该实例很重量,里面封装了所有与注册中心及服务提供方连接,请缓存
ReferenceConfig<GenericService> reference = new ReferenceConfig<GenericService>();
// 弱类型接口名
reference.setInterface("com.xxx.XxxService");
reference.setVersion("1.0.0");
// 声明为泛化接口
reference.setGeneric(true);
// 用org.apache.dubbo.rpc.service.GenericService可以替代所有接口引用
GenericService genericService = reference.get();
// 基本类型以及Date,List,Map等不需要转换,直接调用
Object result = genericService.$invoke("sayHello", new String[] {"java.lang.String"}, new Object[] {"world"});
// 用Map表示POJO参数,如果返回值为POJO也将自动转成Map
Map<String, Object> person = new HashMap<String, Object>();
person.put("name", "xxx");
person.put("password", "yyy");
// 如果返回POJO将自动转成Map
Object result = genericService.$invoke("findPerson", new String[]
{"com.xxx.Person"}, new Object[]{person});
...
使用泛化调用的网关系统只需要继承RPC框架基础的一个JAR包即可,其余的接口都通过泛化来调用服务的实现,这样无论网关系统承载多少个接口,都不需要引入多余的JAR包了,结构如下:
这样看来,泛化调用并不是一种很神秘的技术,它仍然实在基于RPC底层通信的基础之上进行调用的,跟普通RPC区别在于不在依赖多个服务提供方客户端JAR包了,入参和出参就像Dubbo官方示例代码中的一样,完全用Map来代替。泛化在RPC中出现的概念来与此,从具体到抽象,不在需要具体的POJO对象。
如何发布API接口到网关
网关系统与RPC环境起初是两个环境的事务,网关系统不需要依赖RPC的存在,各有各的生命周期:
在RPC环境下,调用者编写好各自的业务逻辑代码,通过提供者的客户端JAR包调用提供者的服务,注册中心负责同步数据,如下图所示。这个时候网关系统跟RPC服务是没有联系的。
现在要把API网关暴漏给外部使用者,我们通过前面介绍的泛化调用技术,以不需要引入API客户端的JAR包的方式调用服务提供者,如下图所示:
现在的问题是如何把API接口发布到网关系统中。实际问题是需要利用什么方法将RPC环境下的API接口让网关也能识别识别到,剩余的工作还是交给RPC本身去完成,包括编解码、序列化、反序列化、长连接等。
有了泛化调用作为基础支持,我们需要做的就是将API通过一种方式存储到网关系统能够访问的一种存储中,为了提高系统的性能一般会选用Redis存储。根据泛化调用的方式,网关系统需要知道服务的类名和方法名。网关系统可以提供一个API发布平台入口,让API发布者将RPC环境下的API数据录入到API发布平台。RPC本身就可以为官网系统提供一个获取API信息的接口,API发布平台可以在用户输入服务的类名之后直接通过这个接口获取要发布的API整体信息,包括所有的方法、入参、出参、注释、描述、接口负责人信息等。剩余的工作就可以交给API网关的泛化调用逻辑了,如下图:
总结
本片文章主要介绍了API网关的基石:泛化调用,以及通过如何发布API到API网关示例来说明为什么被称之为基石。
文章内容来源:《架构修炼之道》
更多个人博客:http://www.wangqi94.com