通过 Higress Wasm 插件 3 倍性能实现 Spring-cloud-gateway 功能

2023-12-22
浙江
本文字数：4490 字
阅读完需：约 15 分钟

作者：韦鑫，Higress Committer，来自南京航空航天大学分布式系统实验室

导读：本文将和大家一同回顾 Spring Cloud Gateway 是如何满足 HTTP 请求/响应转换需求场景的，并为大家介绍在这种场景下使用 Higress 云原生网关的解决方案，同时还对比了两者的性能差异。

SCG 修改请求/响应

在 Spring Cloud Gateway [ 1] (以下简称为 SCG) 中，当我们需要对 HTTP 请求或响应进行修改时，SCG 提供了许多内置的 GatewayFilter [ 2] 来满足我们对这种应用场景的需求，例如 AddRequestHeader,AddRequestParameter, DedupeResponseHeader,MapRequestHeader, ModifyRequestBody 等。

考虑以下简单用例：

添加请求头部 X-First，值从请求路径中获取，例如从 /response-headers?testKey=testValue 中获取 "response-headers"；
将请求头部 X-First 的值映射给 X-Second；
添加请求查询参数 k1=v1；
剔除重复的响应头部 X-Dedupe。

在 SCG 中使用 GatewayFilter 我们可以这样配置：

# application.yaml:
spring:  cloud:    gateway:      routes:        - id: test_route          uri: lb://httpbin-svc          predicates:            - Path=/{api}/**          filters:            - AddRequestHeader=X-First, {api}            - MapRequestHeader=X-First, X-Second            - AddRequestParameter=k1, v1            - DedupeResponseHeader=X-Dedupe, RETAIN_FIRST

复制代码

相信拥有 SCG 使用经验的同学对上述配置一定不陌生，那么本文将重点给出另一种能够**满足上述需求并且性能更加优越的解决方案——使用 Higress 云原生网关的 Transformer 插件。

Higress 插件与 SCG 性能比较

我们在同一吞吐量水平（QPS）上，开启/关闭 Higress Transformer 插件 [ 3] 和 SCG 相应 GatewayFilters，统计两者在 CPU 和内存资源上的开销。

经过测试 [ 13] ，我们得到的结论是：

在 Higress 未启用 Transformer 插件，SCG 未启用 GatewayFilters 的条件下，SCG 的 CPU, 内存资源开销分别约为 Higress 的 3.30, 4.88 倍；
在 Higress 启用 Transformer 插件，SCG 启用相应 GatewayFilters 的条件下，SCG 的 CPU,内存资源开销分别约为 Higress 的 2.98, 3.19 倍。

可见 Higress Transformer 相比于 SCG GatewayFilter 有着相当不错的性能表现！

接下来我们将进一步为大家介绍 Higress 云原生网关以及上述提到的 Higress Transformer 插件。

Higress 简介

Higress [ 4] 是基于阿里内部的 Envoy Gateway 实践沉淀、以开源 Istio + Envoy 为核心构建的下一代云原生网关，实现了流量网关+微服务网关+安全网关三合一的高集成能力，深度集成 Dubbo、Nacos、Sentinel 等微服务技术栈，能够帮助用户极大地降低网关的部署及运维成本且能力不打折；在标准上全面支持 Ingress 与 Gateway API，积极拥抱云原生下的标准 API 规范；同时，Higress Controller 也支持 Nginx Ingress 平滑迁移，帮助用户零成本快速迁移到 Higress。

Higress 提供了一套 Wasm (WebAssembly) SDK [ 5] ，使得开发者能够轻松使用 C++，Golang，Rust 开发 Wasm 插件增强网关能力。下面将为大家介绍 Higress Transformer 插件的基本功能，最后简单说明 Transformer 插件的核心代码逻辑。

Transformer 插件介绍

Higress Transformer 插件可以对请求/响应头部、请求查询参数、请求/响应体参数进行转换，支持的转换操作类型包括删除（remove）、重命名（rename）、更新（replace）、添加（add）、追加（append）、映射（map）和去重（dedupe）。

接下来我们复现最开始提到的 SCG GatewayFilter 简单用例，来演示如何使用该插件（以下使用 Higress 控制台可以很方便地部署插件，当然也可以使用 K8s YAML Manifests 的方式 [ 12] ）：

首先根据官方文档 [ 6] 快速安装 Higress，结果如下：

$ kubectl -n higress-system get deployNAME                         READY   UP-TO-DATE   AVAILABLE   AGEhigress-console              1/1     1            1           1dhigress-console-grafana      1/1     1            1           1dhigress-console-prometheus   1/1     1            1           1dhigress-controller           1/1     1            1           1dhigress-gateway              1/1     1            1           1d

复制代码

通过 Higress 控制台添加域名（foo.bar.com）、路由配置（foo），将流量转发至后端的 httpbin [ 7] 服务：

为 foo 路由添加 Transformer 插件（当前未推送插件至官方镜像仓库，可以先使用 docker.io/weixinx/transformer:v0.1.0，或到代码仓库自行构建）：

注：为了能够同时完成请求和响应转换的需求，我们需要为 foo 路由再添加一个 Transformer 插件，命名为 transformer-resp，用于处理响应方向。

添加 Transformer 配置并开启该插件：

添加请求头部 X-First，值从请求路径中获取，例如从 /response-headers?testKey=testValue 中获取 "response-headers"；
将请求头部 X-First 的值映射给 X-Second；
添加请求查询参数 k1=v1；
剔除重复的响应头部 X-Dedupe。

# transformer:type: request  # 指定 Transformer 类型rules:         # 指定转换规则- operate: add # 指定转换操作类型  headers:     # 指定头部转换规则  - key: X-First    value: $1  # 正则表达式捕获组 $1，支持 RE2 语法    path_pattern: ^\/(\w+)[\?]{0,1}.*$  querys:      # 指定查询参数转换规则  - key: k1    value: v1- operate: map  headers:  - key: X-First    value: X-Second---# transformer-resp:type: responserules:- operate: dedupe  headers:  - key: X-Dedupe    value: RETAIN_FIRST

复制代码

发送请求进行测试：

# 验证请求方向转换$ curl -v -H "host: foo.bar.com" "console.higress.io/get"...>< HTTP/1.1 200 OK...<{  "args": {    # 添加了查询参数 k1=v1    "k1": "v1"  },  "headers": {    ...    "X-First": "get", # 添加了请求头部 X-First，值 "get" 来自请求路径    "X-Second": "get" # 映射了请求头部 X-Second  },  ...  # 添加了查询参数 k1=v1  "url": "http://foo.bar.com/get?k1=v1"}

# 验证响应方向转换$ curl -v -H "host: foo.bar.com" \"console.higress.io/response-headers?X-Dedupe=1&X-Dedupe=2&X-Dedupe=3"...>< HTTP/1.1 200 OK< x-dedupe: 1 # 保留了响应头部 X-Dedupe 的第一个值...<{  ...  # 通过查询参数传给 httpbin 的自定义响应头部  "X-Dedupe": [    "1",    "2",    "3"  ],  ...}

复制代码

❗️需要注意的是：

与上述例子相同，若有同时处理请求和响应转换的需求，则需要为相应路由添加两个 Transformer 插件，分别处理请求方向和响应方向（正在优化）；
请求体支持的 Content-Type 有：application/json,application/x-www-form-urlencoded,multipart/form-data；而响应体仅支持 application/json；
更多说明详见插件文档 [ 3] 。

Transformer 逻辑

本节将简单说明 Higress Transformer 插件的核心代码逻辑，希望可以为有兴趣优化该插件或进行二次开发的同学提供一些帮助。

首先该插件代码位于 Higress 仓库的 plugins/wasm-go/extensions/transformer 目录下，使用 Higress 提供的 Wasm SDK [ 5] 进行开发（关于如何开发 Wasm 插件详见官方文档 [ 8] ）。

插件的配置模型 TransformerConfig：

# 模型以插件配置的形式暴露给用户type TransformerConfig struct {  typ   string          # Transformer 类型，[request, response]  rules []TransformRule # 转换规则    trans Transformer # Transformer 实例，不对用户暴露配置，用于实际的转换操作}
type TransformRule struct {  operate string   # 转换操作类型  headers []Param  # header 参数   querys  []Param  # query 参数  body    []Param  # body 参数}
type Param struct {  key         string # 表示字段的 key  value       string # 表示字段的 value 或 key (map) 或 strategy (dedupe)  valueType   string # 为 application/json body 指定 value 的数据类型  hostPattern string # host 正则匹配模式  pathPattern string # path 正则匹配模式}

复制代码

其中 Transformer 作为接口分别有请求和响应两个实现（requestTransformer, responseTransformer），主要实现了 3 个接口方法 TransformHeaders,TransformerQuerys 和 TransformBody：

type Transformer interface { TransformHeaders(host, path string, hs map[string][]string) error TransformQuerys(host, path string, qs map[string][]string) error TransformBody(host, path string, body interface{}) error ...}
var _ Transformer = (*requestTransformer)(nil)var _ Transformer = (*responseTransformer)(nil)

复制代码

由于头部（Headers）和查询参数（Querys）都是以 key-value 的形式存在，因此通过 kvHandler 对两者采用统一的处理逻辑；而 Body 由于请求、响应支持不同的 Content-Type，因此分别通过 requestBodyHandler (kvHandler,jsonHandler 组合)和 responseBodyHandler (jsonHandler) 进行处理。综上，在修改该插件逻辑时，主要对 kvHandler 和 jsonHandler 进行修改即可，其中 jsonHandler 依赖 GJSON [ 9] 和 SJSON [ 10] 工具库。