batch-requests

描述

batch-requests 插件可以一次接受多个请求并以 http pipeline 的方式在网关发起多个 http 请求，合并结果后再返回客户端，这在客户端需要访问多个接口时可以显著地提升请求性能。

提示

外层的 Http 请求头会自动设置到每一个独立请求中，如果独立请求中出现相同键值的请求头，那么只有独立请求的请求头会生效。

属性

无

接口

插件会增加 /apisix/batch-requests 这个接口，需要通过 public-api 插件来暴露它。

如何启用

你需要在 config.yaml 里面启用 batch-requests 插件：

  1. # 加到 config.yaml
  2. plugins:
  3.   - ... # plugin you need
  4.   - batch-requests

如何配置

默认本插件限制请求体的大小不能大于 1 MiB。这个限制可以通过 apisix/admin/plugin_metadata/batch-requests 来修改。

  1. curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "max_body_size": 4194304
  4. }'

元数据

名称类型必选项默认值有效值描述
max_body_sizeinteger必选1048576> 0请求体的最大大小，单位为字节。

批量接口请求/响应

插件会为 apisix 创建一个 /apisix/batch-requests 的接口来处理你的批量请求。

接口请求参数:

参数名类型可选项默认值有效值描述
queryobject可选给所有请求都携带的 query string
headersobject可选给所有请求都携带的 header
timeoutnumber可选30000聚合请求的超时时间，单位为 ms
pipelineHttpRequest必须Http 请求的详细信息

HttpRequest

参数名类型可选默认值有效值描述
versionstring可选1.1[1.0, 1.1]请求用的 http 协议版本
methodstring可选GET[“GET”, “POST”, “PUT”, “DELETE”, “PATCH”, “HEAD”, “OPTIONS”, “CONNECT”, “TRACE”]请求使用的 http 方法
queryobject可选独立请求所携带的 query string, 如果 Key 和全局的有冲突，以此设置为主。
headersobject可选独立请求所携带的 header, 如果 Key 和全局的有冲突，以此设置为主。
pathstring必须请求路径
bodystring可选请求体
ssl_verifyboolean可选false验证 SSL 证书与主机名是否匹配

接口响应参数：

返回值为一个 HttpResponse 的 数组。

HttpResponse

参数名类型描述
statusintegerHttp 请求的状态码
reasonstringHttp 请求的返回信息
bodystringHttp 请求的响应体
headersobjectHttp 请求的响应头

如何修改自定义 uri

我们可以使用 public-api 插件轻易的设置自定义 uri。只需要在创建路由时设置需要的 uri 并改变 public-api 插件的配置即可。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/batch-requests",
  4.     "plugins": {
  5.         "public-api": {
  6.             "uri": "/apisix/batch-requests"
  7.         }
  8.     }
  9. }'

测试插件

首先，你需要为 batch request 的 API 设置一个路由，它将使用 public-api 插件。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/apisix/batch-requests",
  4.     "plugins": {
  5.         "public-api": {}
  6.     }
  7. }'

之后，你就可以将要访问的请求信息传到网关的批量请求接口( /apisix/batch-requests )了，网关会以 http pipeline 的方式自动帮你完成请求。

  1. curl --location --request POST 'http://127.0.0.1:9080/apisix/batch-requests' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "headers": {
  5.         "Content-Type": "application/json",
  6.         "admin-jwt":"xxxx"
  7.     },
  8.     "timeout": 500,
  9.     "pipeline": [
  10.         {
  11.             "method": "POST",
  12.             "path": "/community.GiftSrv/GetGifts",
  13.             "body": "test"
  14.         },
  15.         {
  16.             "method": "POST",
  17.             "path": "/community.GiftSrv/GetGifts",
  18.             "body": "test2"
  19.         }
  20.     ]
  21. }'

返回如下：

  1. [
  2.   {
  3.     "status": 200,
  4.     "reason": "OK",
  5.     "body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
  6.     "headers": {
  7.       "Connection": "keep-alive",
  8.       "Date": "Sat, 11 Apr 2020 17:53:20 GMT",
  9.       "Content-Type": "application/json",
  10.       "Content-Length": "81",
  11.       "Server": "APISIX web server"
  12.     }
  13.   },
  14.   {
  15.     "status": 200,
  16.     "reason": "OK",
  17.     "body": "{\"ret\":500,\"msg\":\"error\",\"game_info\":null,\"gift\":[],\"to_gets\":0,\"get_all_msg\":\"\"}",
  18.     "headers": {
  19.       "Connection": "keep-alive",
  20.       "Date": "Sat, 11 Apr 2020 17:53:20 GMT",
  21.       "Content-Type": "application/json",
  22.       "Content-Length": "81",
  23.       "Server": "APISIX web server"
  24.     }
  25.   }
  26. ]

禁用插件

正常情况不需要禁用本插件，如有需要，在 /conf/config.yaml 中新建一个所需的 plugins 列表，以覆盖原列表。