Skip to main content
Version: 3.1

Plugin

描述#

Plugin 表示将在 HTTP 请求/响应生命周期期间执行的插件配置。Plugin 的配置信息可以直接绑定在 Route 上，也可以被绑定在 Service、Consumer 或 Plugin Config 上。

你也可以参考 Admin API 了解如何使用该资源。

注意

对于同一个插件的配置，只能有一个是有效的，其插件配置优先级为 Consumer > Route > Plugin Config > Service。

配置简介#

如果你想在现有插件的基础上新增插件，请复制 ./conf/config-default.yaml 中的 plugins 参数下的插件列表到 ./conf/config.yaml 的 plugins 参数中。

提示

在 ./conf/config.yaml 中的 plugins 参数中，可以声明本地 APISIX 节点支持了哪些插件。这是个白名单机制，不在该白名单的插件配置将被自动忽略。该特性可用于临时关闭或打开特定插件，应对突发情况非常有效。

一个插件在一次请求中只会执行一次，即使被同时绑定到多个不同对象中（比如 Route 或 Service）。插件运行先后顺序是根据插件自身的优先级来决定的，例如：

local _M = {
    version = 0.1,
    priority = 0, -- 这个插件的优先级为 0
    name = plugin_name,
    schema = schema,
    metadata_schema = metadata_schema,
}

插件的配置信息，可以存放 Route、Service、Plugin Config 等对象中的 plugins 参数下。如下所示的配置中，包含 limit-count 和 prometheus 两个插件的配置信息：

{
    "plugins": {
        "limit-count": {
            "count": 2,
            "time_window": 60,
            "rejected_code": 503,
            "key": "remote_addr"
        },
        "prometheus": {}
    }
}

并不是所有插件都有具体配置项，比如 prometheus 下是没有任何具体配置项，此时可以使用一个空对象启用该插件。

如果一个请求因为某个插件而被拒绝，会有类似如下 warn 级别的日志：


ip-restriction exits with http status code 403

通用配置#

通过 _meta 配置项可以将一些通用的配置应用于插件，你可以参考下文使用这些通用配置。通用配置如下：

名称类型描述
disableboolean当设置为 true 时，则禁用该插件。可选值为 true 和 false。
error_responsestring/object自定义错误响应。
priorityinteger自定义插件优先级。
filterarray根据请求的参数，在运行时控制插件是否执行。此配置由一个或多个 {var, operator, val} 元素组成列表，类似：{{var, operator, val}, {var, operator, val}, ...}}。例如 {"arg_version", "==", "v2"}，表示当前请求参数 version 是 v2。这里的 var 与 NGINX 内部自身变量命名是保持一致。操作符的使用方法，请参考 lua-resty-expr。

禁用指定插件#

通过 disable 参数，你可以将某个插件调整为“禁用状态”，即请求不会经过该插件。

{
    "proxy-rewrite": {
        "_meta": {
            "disable": true
        }
    }
}

自定义错误响应#

通过 error_response 配置，可以将任意插件的错误响应配置成一个固定的值，避免因为插件内置的错误响应信息而带来不必要的麻烦。

如下配置表示将 jwt-auth 插件的错误响应自定义为 Missing credential in request。

{
    "jwt-auth": {
        "_meta": {
            "error_response": {
                "message": "Missing credential in request"
            }
        }
    }
}

自定义插件优先级#

所有插件都有默认优先级，但是你仍然可以通过 priority 配置项来自定义插件优先级，从而改变插件执行顺序。

 {
    "serverless-post-function": {
        "_meta": {
            "priority": 10000
        },
        "phase": "rewrite",
        "functions" : ["return function(conf, ctx)
                    ngx.say(\"serverless-post-function\");
                    end"]
    },
    "serverless-pre-function": {
        "_meta": {
            "priority": -2000
        },
        "phase": "rewrite",
        "functions": ["return function(conf, ctx)
                    ngx.say(\"serverless-pre-function\");
                    end"]
    }
}

serverless-pre-function 的默认优先级是 10000，serverless-post-function 的默认优先级是 -2000。默认情况下会先执行 serverless-pre-function 插件，再执行 serverless-post-function 插件。

上面的配置则将 serverless-pre-function 插件的优先级设置为 -2000，serverless-post-function 插件的优先级设置为 10000，因此 serverless-post-function 插件会优先执行。

注意
  • 自定义插件优先级只会影响插件实例绑定的主体，不会影响该插件的所有实例。比如上面的插件配置属于路由 A，路由 B 上的插件 serverless-post-function 和 serverless-post-function 插件执行顺序不会受到影响，会使用默认优先级。
  • 自定义插件优先级不适用于 Consumer 上配置的插件的 rewrite 阶段。路由上配置的插件的 rewrite 阶段将会优先运行，然后才会运行 Consumer 上除 auth 类插件之外的其他插件的 rewrite 阶段。

动态控制插件执行状态#

默认情况下，在路由中指定的插件都会被执行。但是你可以通过 filter 配置项为插件添加一个过滤器，通过过滤器的执行结果控制插件是否执行。

  1. 如下配置表示，只有当请求查询参数中 version 值为 v2 时，proxy-rewrite 插件才会执行。

    {
        "proxy-rewrite": {
            "_meta": {
                "filter": [
                    ["arg_version", "==", "v2"]
                ]
            },
            "uri": "/anything"
        }
    }

  2. 使用下述配置创建一条完整的路由。

    {
        "uri": "/get",
        "plugins": {
            "proxy-rewrite": {
                "_meta": {
                    "filter": [
                        ["arg_version", "==", "v2"]
                    ]
                },
                "uri": "/anything"
            }
        },
        "upstream": {
            "type": "roundrobin",
            "nodes": {
                "httpbin.org:80": 1
            }
        }
    }

  3. 当请求中不带任何参数时，proxy-rewrite 插件不会执行，请求将被转发到上游的 /get。

    curl -v /dev/null http://127.0.0.1:9080/get -H"host:httpbin.org"
    < HTTP/1.1 200 OK
    ......
    < Server: APISIX/2.15.0
    <
    {
    "args": {},
    "headers": {
        "Accept": "*/*",
        "Host": "httpbin.org",
        "User-Agent": "curl/7.79.1",
        "X-Amzn-Trace-Id": "Root=1-62eb6eec-46c97e8a5d95141e621e07fe",
        "X-Forwarded-Host": "httpbin.org"
    },
    "origin": "127.0.0.1, 117.152.66.200",
    "url": "http://httpbin.org/get"
    }

  4. 当请求中携带参数 version=v2 时，proxy-rewrite 插件执行，请求将被转发到上游的 /anything:

    curl -v /dev/null http://127.0.0.1:9080/get?version=v2 -H"host:httpbin.org"
    < HTTP/1.1 200 OK
    ......
    < Server: APISIX/2.15.0
    <
    {
    "args": {
        "version": "v2"
    },
    "data": "",
    "files": {},
    "form": {},
    "headers": {
        "Accept": "*/*",
        "Host": "httpbin.org",
        "User-Agent": "curl/7.79.1",
        "X-Amzn-Trace-Id": "Root=1-62eb6f02-24a613b57b6587a076ef18b4",
        "X-Forwarded-Host": "httpbin.org"
    },
    "json": null,
    "method": "GET",
    "origin": "127.0.0.1, 117.152.66.200",
    "url": "http://httpbin.org/anything?version=v2"
    }

热加载#

APISIX 的插件是热加载的，不管你是新增、删除还是修改插件，都不需要重启服务。

只需要通过 Admin API 发送一个 HTTP 请求即可：

curl http://127.0.0.1:9180/apisix/admin/plugins/reload -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT
注意

如果你已经在路由规则里配置了某个插件（比如在 Route 的 plugins 字段里面添加了它），然后在配置文件中禁用了该插件，在执行路由规则时则会跳过该插件。

stand-alone 模式下的热加载#

关于 Stand Alone 模式下的热加载的信息，请参考 stand alone 模式。