调用第三方服务

概念阐述

ServiceComb允许用户注册第三方REST服务的endpoint、接口契约等信息，使用户可以以调用ServiceComb provider服务相同的方式编写调用第三方服务的代码。使用该功能调用第三方服务时，发往第三方服务的请求会经过consumer端handler链、HttpClientFilter的处理，即该功能支持对第三方服务调用的治理功能，并且也支持ServiceComb既有的用户自定义扩展处理机制。

示例代码

  • 假设用户在本地开发了一个REST服务作为第三方REST服务，监听端口号为8080，其REST接口如契约所示：
  1. ---
  2. swagger: "2.0"
  3. info:
  4.  version: "0.0.1"
  5.  title: "3rd party REST service for example"
  6. basePath: "/rest"
  7. consumes:
  8. - "application/json"
  9. produces:
  10. - "text/plain"
  11. paths:
  12.  /{pathVar}:
  13.    get:
  14.      operationId: "testPathVar"
  15.      parameters:
  16.      - name: "pathVar"
  17.        in: "path"
  18.        required: true
  19.        type: "string"
  20.      responses:
  21.        200:
  22.          description: "response of 200, return \"Received, OK. [${pathVar}]\""
  23.          schema:
  24.            type: "string"
  • 为调用此服务，需要先根据其REST接口编写一个Java接口类，并打上参数注解。Java接口类的编写方式参照使用隐式契约开发SpringMVC和JAX-RS风格的provider方式。接口代码示例如下：
  1. @Path("/rest")
  2. @Api(produces = MediaType.TEXT_PLAIN)
  3. public interface VertxServerIntf {
  4.  @Path("/{pathVar}")
  5.  @GET
  6.  String testPathVar(@PathParam("pathVar") String pathVar);
  7. }
  • 在consumer服务中调用ServiceComb提供的方法将其进行注册：
  1. String endpoint = "rest://127.0.0.1:8080";
  2. RegistryUtils.getServiceRegistry().registerMicroserviceMappingByEndpoints(
  3.    // 3rd party rest service name, you can specify the name on your need as long as you obey the microservice naming rule
  4.    "thirdPartyService",
  5.    // service version
  6.    "0.0.1",
  7.    // list of endpoints
  8.    Collections.singletonList(endpoint),
  9.    // java interface class to generate swagger schema
  10.    ThirdPartyRestServiceInterface.class
  11. );
  • 调用第三方服务，声明和调用方式与调用ServiceComb provider服务相同，此处以RPC调用方式为例。
  1. // declare rpc reference to 3rd party rest service, schemaId is the same as microservice name
  2. @RpcReference(microserviceName = "thirdPartyService", schemaId = "thirdPartyService")
  3. ThirdPartyRestServiceInterface thirdPartyRestService;
  5. @RequestMapping(path = "/{pathVar}", method = RequestMethod.GET)
  6. public String testInvoke(@PathVariable(name = "pathVar") String pathVar) {
  7.  LOGGER.info("testInvoke() is called, pathVar = [{}]", pathVar);
  8.  // invoke 3rd party rest service
  9.  String response = thirdPartyRestService.testPathVar(pathVar);
  10.  LOGGER.info("testInvoke() response = [{}]", response);
  11.  return response;
  12. }
  • 使用治理功能

使用治理功能的方法与普通的consumer调用provider场景类似。以限流策略为例，在consumer服务的microservice.yaml文件中进行如下配置:

  1.  servicecomb:
  2.    flowcontrol:
  3.      Consumer:
  4.        qps:
  5.          enabled: true
  6.          limit:
  7.            thirdPartyService: 1

此时即将consumer调用名为thirdPartyService的第三方REST服务的QPS设置为1。当consumer调用thirdPartyService的流量高于1QPS时，将会得到429 Too Many Requests的InvocationException异常。

注意：- endpoint信息是以rest开头的，而非http，可以参照ServiceComb微服务注册到服务中心的endpoint样式进行编写。- 当第三方服务有多个实例（地址）时，可以在endpoint list中指定多个地址，ServiceComb支持对多个地址进行负载均衡处理，处理方式和对待ServiceCombprovider服务相同。- 当前仅支持一次性注册第三方服务及其实例信息，不支持增加、删除和修改操作。