跳到主要内容
版本:3.2.14.6

插件

API7 企业版插件扩展了 API7 企业版的功能,满足组织或用户在流量管理、可观测性、安全性、请求/响应转换、无服务器计算等方面的特定要求。

API7 企业版提供了许多插件,可以根据你的需求进行定制和编排。这些插件可以全局启用,以便在每个传入请求上触发,或者本地绑定到其他对象,例如路由、服务或消费者。

如果现有的 API7 企业版插件不能满足你的需求,你还可以使用 Lua 或 Java、Python、Go、Wasm 等其他语言编写自己的插件。

插件执行生命周期​

然后根据定义的 JSON 架构检查插件的配置,以确保插件配置架构正确。

当发送请求到 API7 企业版时,会在以下一个或多个阶段执行插件相应的方法:rewrite、access、before_proxy、header_filter、body_filter 和 log。这些阶段很大程度上受到 OpenResty 指令的影响。


插件执行阶段

想要了解有关自定义插件开发阶段的更多信息,请参阅插件开发操作指南(即将推出)。

插件执行顺序​

一般来说,插件按以下顺序执行:

  1. 全局规则中的插件

    1. 重写阶段的插件
    2. 接入阶段的插件
  2. 与其他对象绑定的插件

    1. 重写阶段的插件
    2. 接入阶段的插件

插件执行顺序

在每个阶段中,你可以通过插件的 _meta.priority 属性设置优先级,覆盖默认优先级。优先级值越高的插件越先执行。

插件合并优先级​

当同一个插件在全局规则中全局配置和在对象(例如路由)中本地配置时,两个插件实例都会按顺序执行。

插件合并优先级

如果在多个对象上本地配置了同一个插件,执行时只使用一份配置。插件配置按以下优先顺序合并。

Consumer > Route > Service

因此,如果一个插件在不同对象中有不同的配置,则在合并时将使用优先级最高的插件配置。

插件执行过滤器​

默认情况下,所有插件均由与路由中配置的规则匹配的传入请求触发。有时你可能需要更精细地控制插件的执行,即有条件地确定请求触发哪些插件。

API7 企业版允许通过将 _meta.filter 配置应用于插件来动态控制插件执行。该配置支持评估各种内置变量和 API7 企业版表达式。

插件全局规则​

通过插件全局规则创建的插件会对每个传入请求执行。全局规则先于其他对象本地绑定的插件执行。限流、可观测性等插件通常在全局启用,为 API 提供一致且全面的保护。

下图展示了如何对传入请求全局启用 prometheus 插件,以及如何在路由上启用 proxy-rewrite 插件以修改请求的 HTTP 请求头。

插件全局规则

示例在全局规则和路由上启用了不同的插件。如果在这两个对象上配置同一个插件,该插件的两个实例会按顺序执行。

插件元数据​

插件元数据用于配置同名插件所有实例共有的元数据字段。插件用于多个对象且需要统一更新元数据时,可以使用插件元数据对象。

下图展示了插件元数据的用法。

插件元数据

默认情况下,插件元数据对象上的 log_format 会将相同的日志格式应用到两个 syslog 插件实例。/order 路由上的 syslog 插件配置了不同的 log_format,因此发往该路由的请求会采用路由插件中指定的格式生成日志。

如果在插件元数据和另一个对象中都定义了插件字段,则对象上的定义优先于插件元数据中的定义。

插件元数据对象仅适用于具有元数据字段的插件。有关支持元数据字段的插件,请参阅插件参考指南(即将推出)。