按条件禁用全局插件
全局插件默认应用于所有路由,适合实施身份验证、日志记录或监控等组织级策略。不过,在某些情况下,可能需要针对特定路由或服务禁用某些全局插件,以满足业务或技术要求。
本指南介绍如何精细控制全局插件的执行,使插件只在需要的位置运行。你将全局启用 multi-auth,并在选定路由上禁用该插件。
API7 Ingress Controller 目前不支持配置路由标签,而完成本指南需要此功能。
在条件中使用正则表达式匹配
本节使用正则表达式匹配,根据路由标签有条件地跳过全局插件执行。
与列表匹配相比,复杂的正则表达式可能带来更高的处理开销。
创建无服务器函数
创建一个无服务器函数,在路由包含此标签时注册变量 api7_disable_global_rules。之后将使用该变量的值确定是否禁用全局插件。
-
进入网关组。
-
在左侧菜单栏中点击插件设置,并添加一个新插件。
-
添加
serverless-pre-function插件。 -
应用以下配置:
functions:- |-return function(conf, ctx)local core = require "apisix.core"core.ctx.register_var("api7_disable_global_rules", function(ctx)local route = ctx.matched_route and ctx.matched_route.valueif route and route.labels thenreturn route.labels.api7_disable_global_rulesendreturn 1end)endphase: rewrite
配置全局插件
使用正则表达式匹配为示例全局插件配置 _meta.filter,以按条件决定是否执行。如果 api7_disable_global_rules 的值匹配插件名称,则跳过该全局插件。
-
进入网关组。
-
在左侧菜单栏中点击插件设置,并添加一个新插件。
-
添加
multi-auth插件。 -
应用以下配置:
{"_meta": {"filter": [["api7_disable_global_rules","!","~~",".*multi-auth.*"]]},"auth_plugins": [{"basic-auth": {}},{"key-auth": {"header": "apikey","hide_credentials": true,"query": "apikey"}}]}
对于 api7_disable_global_rules 标签包含 multi-auth 的资源,全局插件将跳过执行。
配置路由
- 按照入门教程创建服务。在该服务中创建两条路由:
/ip和/get。 - 在
/get路由上配置值为multi-auth的api7_disable_global_rules标签。
创建消费者
- 按照管理消费者凭据创建两个消费者:
consumer1和consumer2。 - 为
consumer1配置 Basic Authentication 凭据,用户名为consumer1,密码为consumer1_pwd。 - 为
consumer2配置 Key Authentication 凭据,以consumer2_pwd作为 Key。
验证
不带任何凭据向 /get 路由发送请求:
curl -i "http://127.0.0.1:9080/get"
由于该路由已禁用 multi-auth,应收到 HTTP/1.1 200 OK 响应。
不带任何凭据向 /ip 路由发送请求:
curl -i "http://127.0.0.1:9080/ip"
由于该路由启用了 multi-auth,应收到 HTTP/1.1 401 Unauthorized 响应。
向 /ip 路由发送两个请求,分别使用 Basic Authentication 和 Key Authentication:
curl -i "http://127.0.0.1:9080/anything" -u 'consumer1:consumer1_pwd'
curl -i "http://127.0.0.1:9080/anything" -H 'apikey: consumer2_pwd'
由于凭据有效,两个请求都应收到 HTTP/1.1 200 OK 响应。
在条件中使用列表匹配
本节使用列表匹配,根据路由标签有条件地跳过全局插件执行。
创建无服务器函数
创建一个无服务器函数,在路由包含此标签时注册变量 api7_disable_global_rules。该标签可包含一个或多个以逗号分隔的插件名称;函数会拆分并去除首尾空白,形成一个列表。之后将使用该列表决定禁用哪些全局插件。
-
进入网关组。
-
在左侧菜单栏中点击插件设置,并添加一个新插件。
-
添加
serverless-pre-function插件。 -
应用以下配置:
functions:- >-return function(conf, ctx)local core = require "apisix.core"core.ctx.register_var("api7_disable_global_rules", function(ctx)local route = ctx.matched_route and ctx.matched_route.valueif route and route.labels thenlocal value = route.labels.api7_disable_global_rulesif value thenlocal disable_plugins = {}for plugin_name in string.gmatch(value, "[^,]+") dolocal trimmed_name = string.gsub(plugin_name, "^%s*(.-)%s*$", "%1")if trimmed_name and trimmed_name ~= "" thentable.insert(disable_plugins, trimmed_name)endendcore.log.error("disable_plugins: ", core.json.encode(disable_plugins))return disable_pluginsendendreturn 1end)endphase: rewrite
配置全局插件
使用列表匹配为示例全局插件配置 _meta.filter,以按条件决定是否执行。如果 api7_disable_global_rules 变量包含插件名称,则跳过该全局插件。
-
进入网关组。
-
在左侧菜单栏中点击插件设置,并添加一个新插件。
-
添加
multi-auth插件。 -
应用以下配置:
{"_meta": {"disable": false,"filter": [["api7_disable_global_rules","!","has","multi-auth"]]},"auth_plugins": [{"basic-auth": {}},{"key-auth": {"header": "apikey","hide_credentials": true,"query": "apikey"}}]}
对于 api7_disable_global_rules 标签的禁用插件列表中包含 multi-auth 的资源,全局插件将跳过执行。
配置路由
- 按照入门教程创建服务。在该服务中创建两条路由:
/ip和/get。 - 在
/get路由上配置值为multi-auth, cors, limit-count的api7_disable_global_rules标签。
创建消费者
- 按照管理消费者凭据创建两个消费者:
consumer1和consumer2。 - 为
consumer1配置 Basic Authentication 凭据,用户名为consumer1,密码为consumer1_pwd。 - 为
consumer2配置 Key Authentication 凭据,以consumer2_pwd作为 Key。
验证
不带任何凭据向 /get 路由发送请求:
curl -i "http://127.0.0.1:9080/get"
由于该路由已禁用 multi-auth,应收到 HTTP/1.1 200 OK 响应。
不带任何凭据向 /ip 路由发送请求:
curl -i "http://127.0.0.1:9080/ip"
由于该路由启用了 multi-auth,应收到 HTTP/1.1 401 Unauthorized 响应。
向 /ip 路由发送两个请求,分别使用 Basic Authentication 和 Key Authentication:
curl -i "http://127.0.0.1:9080/anything" -u 'consumer1:consumer1_pwd'
curl -i "http://127.0.0.1:9080/anything" -H 'apikey: consumer2_pwd'
由于凭据有效,两个请求都应收到 HTTP/1.1 200 OK 响应。