Files
SOP/doc/docs/files/10050_接口交互详解.md
2019-03-25 11:49:16 +08:00

2.7 KiB
Raw Blame History

接口交互详解

开放平台所提供的接口有几十个到几百个不等,同样支持的服务也是多个的。就拿支付宝开放平台来说 它所提供的服务有,支付服务、会员服务、店铺服务、芝麻信用服务等。相信这些服务接口肯定不是写在同一个项目中,但是它的接口地址只有一个:https://openapi.alipay.com/gateway.do 从地址信息中可以看到,这是一个网关服务。也就是说,网关是所有请求的入口,然后通过请求分发的方式,把请求路由到具体某个服务中去。 虽然支付宝开放平台的实现方式我们不得而知,但是这种思路是可行的。

SOP也是采用这种方式实现大致步骤如下

  • 每个服务注册到注册中心在启动的时候把自己的路由信息上传到zookeeper并且保证每一个接口都能对应到哪个服务。
  • 网关启动时同样注册到注册中心获取zookeeper上的接口信息保存到本地并监听zookeeper上的接口信息一旦接口信息有修改网关这边能及时进行更新。
  • 网关收到客户端请求后,先进行签名校验,通过之后根据接口信息找到对应的服务,然后进行路由
  • 网关对返回结果进行处理(或不处理),返回给客户端。

如何通过接口参数找到对应的服务呢?

在网关定义一个Map<String, RouteInfo> routeMap = ...key为接口名+版本号。

网关启动时从zookeeper中获取路由信息并保存到routeMap中

routeMap = buildFromZookeeper();

接口请求进来后,根据方法名+版本号获取路由信息,然后进行路由转发。

String method = request.getParameter("method");
String version = request.getParameter("version");

RouteInfo routeInfo = routeMap.get(method + version);

doRoute(routeInfo);

因为有多个服务把路由信息注册到zookeeper我们要确保接口名唯一method全局唯一。

我们推荐接口名的命名规则应该是:服务模块.业务模块.功能模块.行为,如:

mini.user.userinfo.get 小程序服务.用户模块.用户信息.获取

member.register.total.get 会员服务.注册模块.注册总数.获取

如果觉得命名规则有点长可以精简为:服务模块.功能模块.行为,如member.usercount.get,前提是确保前缀要有所区分,不和其它服务冲突。

得益于Spring Cloud的注册中心和和网关功能我们能很方便的进行接口路由并且还能实现LoadBalance不需要自己再去实现。

整个SOP的架构如下图所示

SOP架构图