路由 RadixTree

什么是 libradixtree？

libradixtree, 是在 Lua 中为 OpenResty 实现的自适应 基数树 。

Apache APISIX 使用 libradixtree 作为路由调度库。

如何在 Apache APISIX 中使用 libradixtree？

libradixtree 是基于 rax 的 lua-resty-* 实现。

我们通过下面的示例可以有一个直观的理解。

1. 完全匹配

  1. /blog/foo

此时只能匹配 /blog/foo 。

2. 前缀匹配

  1. /blog/bar*

它将匹配带有前缀 /blog/bar 的路径， 例如： /blog/bar/a 、 /blog/bar/b 、 /blog/bar/c/d/e 、 /blog/bar 等。

3. 匹配优先级

完全匹配 -> 深度前缀匹配

以下是规则:

  1. /blog/foo/*/blog/foo/a/*/blog/foo/c/*/blog/foo/bar
路径匹配结果
/blog/foo/bar/blog/foo/bar
/blog/foo/a/b/c/blog/foo/a/
/blog/foo/c/d/blog/foo/c/
/blog/foo/gloo/blog/foo/*
/blog/barnot match

4. 不同的路由具有相同 uri

当不同的路由有相同的 uri 时，可以通过设置路由的 priority 字段来决定先匹配哪条路由，或者添加其他匹配规则来区分不同的路由。

注意：在匹配规则中， priority 字段优先于除 uri 之外的其他规则。

1、不同的路由有相同的 uri 并设置 priority 字段

创建两条 priority 值不同的路由（值越大，优先级越高）。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "upstream": {       "nodes": {           "127.0.0.1:1980": 1       },       "type": "roundrobin"    },    "priority": 3,    "uri": "/hello"}'
  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "upstream": {       "nodes": {           "127.0.0.1:1981": 1       },       "type": "roundrobin"    },    "priority": 2,    "uri": "/hello"}'

测试:

  1. curl http://127.0.0.1:1980/hello1980

所有请求只到达端口 1980 的路由。

2、不同的路由有相同的 uri 并设置不同的匹配条件

以下是设置主机匹配规则的示例：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "upstream": {       "nodes": {           "127.0.0.1:1980": 1       },       "type": "roundrobin"    },    "hosts": ["localhost.com"],    "uri": "/hello"}'
  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "upstream": {       "nodes": {           "127.0.0.1:1981": 1       },       "type": "roundrobin"    },    "hosts": ["test.com"],    "uri": "/hello"}'

测试:

  1. $ curl http://127.0.0.1:9080/hello -H 'host: localhost.com'1980
  1. $ curl http://127.0.0.1:9080/hello -H 'host: test.com'1981
  1. $ curl http://127.0.0.1:9080/hello{"error_msg":"404 Route Not Found"}

host 规则匹配，请求命中对应的上游， host 不匹配，请求返回404消息。

5. 参数匹配

当使用 radixtree_uri_with_parameter 时，我们可以用参数匹配路由。

例如，使用配置：

  1. apisix:  router:    http: 'radixtree_uri_with_parameter'

示例：

  1. /blog/:name

此时将匹配 /blog/dog 和 /blog/cat 。

更多使用方式请参考：lua-resty-radixtree#parameters-in-path

如何通过 Nginx 内置变量过滤路由

具体参数及使用方式请查看 radixtree#new 文档 ，下面是一个简单的示例:

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "uri": "/index.html",    "vars": [        ["http_host", "==", "iresty.com"],        ["cookie_device_id", "==", "a66f0cdc4ba2df8c096f74c9110163a9"],        ["arg_name", "==", "json"],        ["arg_age", ">", "18"],        ["arg_address", "~~", "China.*"]    ],    "upstream": {        "type": "roundrobin",        "nodes": {            "39.97.63.215:80": 1        }    }}'

这个路由需要请求头 host 等于 iresty.com ， 请求 cookie _device_id 等于 a66f0cdc4ba2df8c096f74c9110163a9 等。

如何通过 GraphQL 属性过滤路由

APISIX 支持通过 GraphQL 的一些属性过滤路由。 目前我们支持：

  • graphql_operation
  • graphql_name
  • graphql_root_fields

例如，像这样的 GraphQL：

  1. query getRepo {    owner {        name    }    repo {        created    }}
  • graphql_operation 是 query
  • graphql_name 是 getRepo，
  • graphql_root_fields 是 ["owner", "repo"]

我们可以用以下方法过滤掉这样的路由：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '{    "methods": ["POST"],    "uri": "/_graphql",    "vars": [        ["graphql_operation", "==", "query"],        ["graphql_name", "==", "getRepo"],        ["graphql_root_fields", "has", "owner"]    ],    "upstream": {        "type": "roundrobin",        "nodes": {            "39.97.63.215:80": 1        }    }}'

为了防止花费太多时间读取无效的 GraphQL 请求正文，我们只读取前 1 MiB 来自请求体的数据。 此限制是通过以下方式配置的：

  1. graphql:  max_size: 1048576

如果你需要传递一个大于限制的 GraphQL 查询语句 ，你可以增加 conf/config.yaml 中的值。