grpc-transcode

描述

HTTP(s) -> APISIX -> gRPC server

Proto

参数

  • content: .proto 或 .pb 文件的内容

添加proto

路径中最后的数字，会被用作 proto 的 id 做唯一标识，比如下面示例的 proto id 是 1 ：

  1. curl http://127.0.0.1:9080/apisix/admin/proto/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "content" : "syntax = \"proto3\";
  4.     package helloworld;
  5.     service Greeter {
  6.         rpc SayHello (HelloRequest) returns (HelloReply) {}
  7.     }
  8.     message HelloRequest {
  9.         string name = 1;
  10.     }
  11.     message HelloReply {
  12.         string message = 1;
  13.     }"
  14. }'

如果你的 .proto 文件包含 import，或者你想把多个 .proto 文件合并成一个 proto。 你可以使用 .pb 文件来创建 proto。

假设我们有一个 .proto 叫 proto/helloworld.proto，它导入了另一个 proto 文件：

  1. syntax = "proto3";
  4. package helloworld;
  5. import "proto/import.proto";
  6. ...

首先，让我们从 .proto文件创建一个.pb文件。

  1. protoc --include_imports --descriptor_set_out=proto.pb proto/helloworld.proto

输出的二进制文件 proto.pb 将同时包含 helloworld.proto 和 import.proto。

然后我们可以将 proto.pb 的内容作为 proto 的 content 字段提交。

由于内容是二进制的，我们需要先对其进行 base64 编码。这里我们用一个 Python 脚本来做。

  1. #!/usr/bin/env python
  2. # coding: utf-8
  3. # save this file as upload_pb.py
  4. import base64
  5. import sys
  6. # sudo pip install requests
  7. import requests
  10. if len(sys.argv) <= 1:
  11.     print("bad argument")
  12.     sys.exit(1)
  13. with open(sys.argv[1], 'rb') as f:
  14.     content = base64.b64encode(f.read())
  15. id = sys.argv[2]
  16. api_key = "edd1c9f034335f136f87ad84b625c8f1" # Change it
  19. reqParam = {
  20.     "content": content,
  21. }
  22. resp = requests.put("http://127.0.0.1:9080/apisix/admin/proto/" + id, json=reqParam, headers={
  23.     "X-API-KEY": api_key,
  24. })
  25. print(resp.status_code)
  26. print(resp.text)

创建proto：

  1. chmod +x ./upload_pb.pb
  2. ./upload_pb.py proto.pb 1
  3. # 200
  4. # {"node":{"value":{"create_time":1643879753,"update_time":1643883085,"content":"CmgKEnByb3RvL2ltcG9ydC5wcm90bxIDcGtnIhoKBFVzZXISEgoEbmFtZRgBIAEoCVIEbmFtZSIeCghSZXNwb25zZRISCgRib2R5GAEgASgJUgRib2R5QglaBy4vcHJvdG9iBnByb3RvMwq9AQoPcHJvdG8vc3JjLnByb3RvEgpoZWxsb3dvcmxkGhJwcm90by9pbXBvcnQucHJvdG8iPAoHUmVxdWVzdBIdCgR1c2VyGAEgASgLMgkucGtnLlVzZXJSBHVzZXISEgoEYm9keRgCIAEoCVIEYm9keTI5CgpUZXN0SW1wb3J0EisKA1J1bhITLmhlbGxvd29ybGQuUmVxdWVzdBoNLnBrZy5SZXNwb25zZSIAQglaBy4vcHJvdG9iBnByb3RvMw=="},"key":"\/apisix\/proto\/1"},"action":"set"}

参数列表

名称类型必选项默认值有效值描述
proto_idstring/integer必须.proto 内容的 id
servicestring必须grpc 服务名
methodstring必须grpc 服务中要调用的方法名
deadlinenumber可选0grpc deadline, ms
pb_optionarray[string(pb_option_def)]可选proto 编码过程中的转换选项

示例

使用 grpc-transcode 插件

在指定 route 中，代理 grpc 服务接口:

  • 注意： 这个 route 对应的 upstream 的属性 scheme 必须设置为 grpc
  • 代理 grpc 服务例子可参考：grpc_server_example
  1. curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/grpctest",
  5.     "plugins": {
  6.         "grpc-transcode": {
  7.          "proto_id": "1",
  8.          "service": "helloworld.Greeter",
  9.          "method": "SayHello"
  10.         }
  11.     },
  12.     "upstream": {
  13.         "scheme": "grpc",
  14.         "type": "roundrobin",
  15.         "nodes": {
  16.             "127.0.0.1:50051": 1
  17.         }
  18.     }
  19. }'

测试

访问上面配置的 route：

  1. $ curl -i http://127.0.0.1:9080/grpctest?name=world
  2. HTTP/1.1 200 OK
  3. Date: Fri, 16 Aug 2019 11:55:36 GMT
  4. Content-Type: application/json
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server
  8. Proxy-Connection: keep-alive
  11. {"message":"Hello world"}

这表示已成功代理。

使用 grpc-transcode 插件的 pb_option 选项

在指定 route 中，代理 grpc 服务接口:

选项清单

  • 枚举类型

    • enum_as_name
    • enum_as_value

  • 64位整型

    • int64_as_number
    • int64_as_string
    • int64_as_hexstring

  • 使用默认值

    • auto_default_values
    • no_default_values
    • use_default_values
    • use_default_metatable

  • Hooks开关

    • enable_hooks
    • disable_hooks
  1. curl http://127.0.0.1:9080/apisix/admin/routes/23 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/zeebe/WorkflowInstanceCreate",
  5.     "plugins": {
  6.         "grpc-transcode": {
  7.             "proto_id": "1",
  8.             "service": "gateway_protocol.Gateway",
  9.             "method": "CreateWorkflowInstance",
  10.             "pb_option":["int64_as_string"]
  11.         }
  12.     },
  13.     "upstream": {
  14.         "scheme": "grpc",
  15.         "type": "roundrobin",
  16.         "nodes": {
  17.             "127.0.0.1:26500": 1
  18.         }
  19.     }
  20. }'

测试 pb_option 参数

访问上面配置的 route：

  1. $ curl -i "http://127.0.0.1:9080/zeebe/WorkflowInstanceCreate?bpmnProcessId=order-process&version=1&variables=\{\"orderId\":\"7\",\"ordervalue\":99\}"
  2. HTTP/1.1 200 OK
  3. Date: Wed, 13 Nov 2019 03:38:27 GMT
  4. Content-Type: application/json
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. grpc-encoding: identity
  8. grpc-accept-encoding: gzip
  9. Server: APISIX web server
  10. Trailer: grpc-status
  11. Trailer: grpc-message
  14. {"workflowKey":"#2251799813685260","workflowInstanceKey":"#2251799813688013","bpmnProcessId":"order-process","version":1}

"workflowKey":"#2251799813685260" 表示已成功。

禁用插件

在插件设置页面中删除相应的 json 配置即可禁用 grpc-transcode 插件。APISIX 的插件是热加载的，因此无需重启 APISIX 服务。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/grpctest",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "scheme": "grpc",
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:50051": 1
  10.         }
  11.     }
  12. }'