dubbo-proxy

描述

dubbo-proxy 插件允许将 HTTP 请求代理到 dubbo

要求

如果你正在使用 OpenResty, 你需要编译它来支持 dubbo, 参考 如何编译

运行时属性

名称类型必选项默认值有效值描述
service_namestring必选dubbo 服务名字
service_versionstring必选dubbo 服务版本
methodstring可选uri路径dubbo 服务方法

静态属性

名称类型必选项默认值有效值描述
upstream_multiplex_countnumber必选32>= 1上游连接中最大的多路复用请求数

如何启用

首先,在 config.yaml 中启用 dubbo-proxy 插件:

  1. # Add this in config.yaml
  2. plugins:
  3. - ... # plugin you need
  4. - dubbo-proxy

然后重载 APISIX

这里有个例子,在指定的路由中启用 dubbo-proxy 插件:

  1. curl http://127.0.0.1:9080/apisix/admin/upstreams/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "nodes": {
  4. "127.0.0.1:20880": 1
  5. },
  6. "type": "roundrobin"
  7. }'
  8. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  9. {
  10. "uris": [
  11. "/hello"
  12. ],
  13. "plugins": {
  14. "dubbo-proxy": {
  15. "service_name": "org.apache.dubbo.sample.tengine.DemoService",
  16. "service_version": "0.0.0",
  17. "method": "tengineDubbo"
  18. }
  19. },
  20. "upstream_id": 1
  21. }'

测试插件

你可以在 Tengine 提供的 快速开始 例子中使用上述配置进行测试。

将会有同样的结果。

从上游 dubbo 服务返回的数据一定是 Map<String, String> 类型。

如果返回的数据如下

  1. {
  2. "status": "200",
  3. "header1": "value1",
  4. "header2": "valu2",
  5. "body": "blahblah"
  6. }

则对应的 HTTP 响应如下

  1. HTTP/1.1 200 OK # "status" will be the status code
  2. ...
  3. header1: value1
  4. header2: value2
  5. ...
  6. blahblah # "body" will be the body

禁用插件

当你想在某个路由或服务中禁用 dubbo-proxy 插件,非常简单,你可以直接删除插件配置中的 json 配置,不需要重启服务就能立即生效:

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uris": [
  5. "/hello"
  6. ],
  7. "plugins": {
  8. },
  9. "upstream_id": 1
  10. }
  11. }'

现在 dubbo-proxy 插件就已经被禁用了。 此方法同样适用于其他插件。

如果你想彻底禁用 dubbo-proxy 插件, 你需要在 config.yaml 中注释掉以下内容:

  1. plugins:
  2. - ... # plugin you need
  3. #- dubbo-proxy

然后重新加载 APISIX