跳到主要内容

使用 GO 语言开发 WASM 插件

一、工具准备

需要先安装 Golang 和 TinyGo 两个程序

1. Golang

(要求 1.18 版本以上)
官方指引链接:https://go.dev/doc/install

Windows

  1. 下载安装文件:https://go.dev/dl/go1.19.windows-amd64.msi
  2. 打开下载好的安装文件直接安装,默认会安装到 Program FilesProgram Files (x86) 目录
  3. 安装完成后,使用键盘上的快捷键“Win+R”打开运行窗口,在运行窗口中输入“cmd”点击确定即可打开命令窗口,输入命令:go version,输出当前安装的版本,表明安装成功

MacOS

  1. 下载安装文件:https://go.dev/dl/go1.19.darwin-amd64.pkg
  2. 打开下载好的安装文件直接安装,默认会安装到/usr/local/go目录
  3. 打开终端命令行工具,输入命令:go version,输出当前安装的版本,表明安装成功

Linux

  1. 下载安装文件:https://go.dev/dl/go1.19.linux-amd64.tar.gz
  2. 执行下列命令进行安装:
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.19.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
  1. 执行 go version,输出当前安装的版本,表明安装成功

2. TinyGo

(要求 0.28.1 版本以上)
官方指引链接:https://tinygo.org/getting-started/install/

Windows

  1. 下载安装文件:https://github.com/tinygo-org/tinygo/releases/download/v0.28.1/tinygo0.28.1.windows-amd64.zip
  2. 解压安装文件到指定目录
  3. 如果安装解压后的目录为C:\tinygo,则需要将C:\tinygo\bin添加到环境变量PATH中,例如通过在命令窗口中输入 set 命令设置
set PATH=%PATH%;"C:\tinygo\bin";
  1. 在命令窗口执行命令 tinygo version,输出当前安装的版本,表明安装成功

MacOS

  1. 下载压缩包并解压
wget https://github.com/tinygo-org/tinygo/releases/download/v0.28.1/tinygo0.28.1.darwin-amd64.tar.gz
tar -zxf tinygo0.28.1.darwin-amd64.tar.gz
  1. 如果安装解压后的目录为/tmp,则需要将/tmp/tinygo/bin添加到环境变量PATH中:
export PATH=/tmp/tinygo/bin:$PATH
  1. 在终端执行 tinygo version,输出当前安装的版本,表明安装成功

Linux

以 Ubuntu 下 amd64 架构为例,其他系统请参考官方指引链接

  1. 下载 DEB 文件,并安装
wget https://github.com/tinygo-org/tinygo/releases/download/v0.28.1/tinygo_0.28.1_amd64.deb
sudo dpkg -i tinygo_0.28.1_amd64.deb
export PATH=$PATH:/usr/local/bin
  1. 在终端执行 tinygo version,输出当前安装的版本,表明安装成功

二、编写插件

1. 初始化工程目录

  1. 新建一个工程目录文件,例如wasm-demo-go
  2. 在所建目录下执行以下命令,进行 Go 工程初始化
go mod init wasm-demo-go
  1. 国内环境可能需要设置下载依赖包的代理
go env -w GOPROXY=https://proxy.golang.com.cn,direct
  1. 下载构建插件的依赖
go get github.com/higress-group/proxy-wasm-go-sdk
go get github.com/alibaba/higress/plugins/wasm-go@main
go get github.com/tidwall/gjson

2. 编写 main.go 文件

下面是一个简单示例,实现了在插件配置mockEnable: true时直接返回hello world应答;未做插件配置,或者设置mockEnable: false时给原始请求添加 hello: world请求头。更多例子请参考本文第四节。

注意:在网关控制台中的插件配置为 yaml 格式,下发给插件时将自动转换为 json 格式,所以例子中的 parseConfig 可以直接从 json 中解析配置

package main

import (
"github.com/alibaba/higress/plugins/wasm-go/pkg/wrapper"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
"github.com/tidwall/gjson"
)

func main() {
wrapper.SetCtx(
// 插件名称
"my-plugin",
// 为解析插件配置,设置自定义函数
wrapper.ParseConfigBy(parseConfig),
// 为处理请求头,设置自定义函数
wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
)
}

// 自定义插件配置
type MyConfig struct {
mockEnable bool
}

// 在控制台插件配置中填写的yaml配置会自动转换为json,此处直接从json这个参数里解析配置即可
func parseConfig(json gjson.Result, config *MyConfig, log wrapper.Log) error {
// 解析出配置,更新到config中
config.mockEnable = json.Get("mockEnable").Bool()
return nil
}

func onHttpRequestHeaders(ctx wrapper.HttpContext, config MyConfig, log wrapper.Log) types.Action {
proxywasm.AddHttpRequestHeader("hello", "world")
if config.mockEnable {
proxywasm.SendHttpResponse(200, nil, []byte("hello world"), -1)
}
return types.ActionContinue
}

HTTP 处理挂载点

上面示例代码中通过 wrapper.ProcessRequestHeadersBy将自定义函数 onHttpRequestHeaders用于HTTP 请求头处理阶段处理请求。除此之外,还可以通过下面方式,设置其他阶段的自定义处理函数

HTTP 处理阶段触发时机挂载方法
HTTP 请求头处理阶段网关接收到客户端发送来的请求头数据时wrapper.ProcessRequestHeadersBy
HTTP 请求 Body 处理阶段网关接收到客户端发送来的请求 Body 数据时wrapper.ProcessRequestBodyBy
HTTP 应答头处理阶段网关接收到后端服务响应的应答头数据时wrapper.ProcessResponseHeadersBy
HTTP 应答 Body 处理阶段网关接收到后端服务响应的应答 Body 数据时wrapper.ProcessResponseBodyBy

工具方法

上面示例代码中的 proxywasm.AddHttpRequestHeaderproxywasm.SendHttpResponse是插件 SDK 提供的两个工具方法,主要的工具方法见下表:

分类方法名称用途可以生效的
HTTP 处理阶段
请求头处理GetHttpRequestHeaders获取客户端请求的全部请求头HTTP 请求头处理阶段
ReplaceHttpRequestHeaders替换客户端请求的全部请求头HTTP 请求头处理阶段
GetHttpRequestHeader获取客户端请求的指定请求头HTTP 请求头处理阶段
RemoveHttpRequestHeader移除客户端请求的指定请求头HTTP 请求头处理阶段
ReplaceHttpRequestHeader替换客户端请求的指定请求头HTTP 请求头处理阶段
AddHttpRequestHeader新增一个客户端请求头HTTP 请求头处理阶段
请求 Body 处理GetHttpRequestBody获取客户端请求 BodyHTTP 请求 Body 处理阶段
AppendHttpRequestBody将指定的字节串附加到客户端请求 Body 末尾HTTP 请求 Body 处理阶段
PrependHttpRequestBody将指定的字节串附加到客户端请求 Body 的开头HTTP 请求 Body 处理阶段
ReplaceHttpRequestBody替换客户端请求 BodyHTTP 请求 Body 处理阶段
应答头处理GetHttpResponseHeaders获取后端响应的全部应答头HTTP 应答头处理阶段
ReplaceHttpResponseHeaders替换后端响应的全部应答头HTTP 应答头处理阶段
GetHttpResponseHeader获取后端响应的指定应答头HTTP 应答头处理阶段
RemoveHttpResponseHeader移除后端响应的指定应答头HTTP 应答头处理阶段
ReplaceHttpResponseHeader替换后端响应的指定应答头HTTP 应答头处理阶段
AddHttpResponseHeader新增一个后端响应头HTTP 应答头处理阶段
应答 Body 处理GetHttpResponseBody获取客户端请求 BodyHTTP 应答 Body 处理阶段
AppendHttpResponseBody将指定的字节串附加到后端响应 Body 末尾HTTP 应答 Body 处理阶段
PrependHttpResponseBody将指定的字节串附加到后端响应 Body 的开头HTTP 应答 Body 处理阶段
ReplaceHttpResponseBody替换后端响应 BodyHTTP 应答 Body 处理阶段
HTTP 调用DispatchHttpCall发送一个 HTTP 请求-
GetHttpCallResponseHeaders获取 DispatchHttpCall 请求响应的应答头-
GetHttpCallResponseBody获取 DispatchHttpCall 请求响应的应答 Body-
GetHttpCallResponseTrailers获取 DispatchHttpCall 请求响应的应答 Trailer-
直接响应SendHttpResponse直接返回一个特定的 HTTP 应答-
流程恢复ResumeHttpRequest恢复先前被暂停的请求处理流程-
ResumeHttpResponse恢复先前被暂停的应答处理流程-

3. 编译生成 WASM 文件

Linux执行以下命令

go mod tidy
tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags='custommalloc nottinygc_finalizer' ./main.go

Windows执行以下命令 (参数将单引号改为双引号)

go mod tidy
tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags="custommalloc nottinygc_finalizer" ./main.go

如果编译出现error: could not find wasm-opt, set the WASMOPT environment variable to override 则需要下载https://github.com/WebAssembly/binaryen/ 里面包含了bin\wasm-opt.exe将这个文件拷贝到tinygo的bin目录下重新编译即可。
编译成功会在当前目录下创建文件 main.wasm。这个文件在下面本地调试的例子中也会被用到。
在使用云原生网关插件市场的自定义插件功能时,直接上传该文件即可。

三、本地调试

工具准备

安装Docker

使用 docker compose 启动验证

  1. 进入在编写插件时创建的目录,例如wasm-demo目录,确认该目录下已经编译生成了main.wasm文件。
  2. 在目录下创建文件docker-compose.yaml,内容如下:
version: '3.7'
services:
envoy:
image: higress-registry.cn-hangzhou.cr.aliyuncs.com/higress/gateway:1.3.1
entrypoint: /usr/local/bin/envoy
# 注意这里对wasm开启了debug级别日志,正式部署时则默认info级别
command: -c /etc/envoy/envoy.yaml --component-log-level wasm:debug
depends_on:
- httpbin
networks:
- wasmtest
ports:
- "10000:10000"
volumes:
- ./envoy.yaml:/etc/envoy/envoy.yaml
- ./main.wasm:/etc/envoy/main.wasm

httpbin:
image: kennethreitz/httpbin:latest
networks:
- wasmtest
ports:
- "12345:80"

networks:
wasmtest: {}
  1. 继续在该目录下创建文件envoy.yaml,内容如下:
admin:
address:
socket_address:
protocol: TCP
address: 0.0.0.0
port_value: 9901
static_resources:
listeners:
- name: listener_0
address:
socket_address:
protocol: TCP
address: 0.0.0.0
port_value: 10000
filter_chains:
- filters:
- name: envoy.filters.network.http_connection_manager
typed_config:
"@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager
scheme_header_transformation:
scheme_to_overwrite: https
stat_prefix: ingress_http
route_config:
name: local_route
virtual_hosts:
- name: local_service
domains: ["*"]
routes:
- match:
prefix: "/"
route:
cluster: httpbin
http_filters:
- name: wasmdemo
typed_config:
"@type": type.googleapis.com/udpa.type.v1.TypedStruct
type_url: type.googleapis.com/envoy.extensions.filters.http.wasm.v3.Wasm
value:
config:
name: wasmdemo
vm_config:
runtime: envoy.wasm.runtime.v8
code:
local:
filename: /etc/envoy/main.wasm
configuration:
"@type": "type.googleapis.com/google.protobuf.StringValue"
value: |
{
"mockEnable": false
}
- name: envoy.filters.http.router
clusters:
- name: httpbin
connect_timeout: 30s
type: LOGICAL_DNS
# Comment out the following line to test on v6 networks
dns_lookup_family: V4_ONLY
lb_policy: ROUND_ROBIN
load_assignment:
cluster_name: httpbin
endpoints:
- lb_endpoints:
- endpoint:
address:
socket_address:
address: httpbin
port_value: 80
  1. 执行以下命令启动docker compose。
docker compose up

功能验证

  1. WASM功能验证

使用curl直接访问httpbin,可以看到不经过网关时的请求头内容,如下:

curl http://127.0.0.1:12345/get

{
"args": {},
"headers": {
"Accept": "*/*",
"Host": "127.0.0.1:12345",
"User-Agent": "curl/7.79.1"
},
"origin": "172.18.0.1",
"url": "http://127.0.0.1:12345/get"
}

使用curl通过网关访问httpbin,可以看到经过网关处理后的请求头的内容,如下:

curl http://127.0.0.1:10000/get

{
"args": {},
"headers": {
"Accept": "*/*",
"Hello": "world",
"Host": "127.0.0.1:10000",
"Original-Host": "127.0.0.1:10000",
"Req-Start-Time": "1681269273896",
"User-Agent": "curl/7.79.1",
"X-Envoy-Expected-Rq-Timeout-Ms": "15000"
},
"origin": "172.18.0.3",
"url": "https://127.0.0.1:10000/get"
}

此时上文编写插件的功能已经生效了,加入了hello: world请求头。

  1. 插件配置修改验证

修改envoy.yaml,将mockEnable配置修改为true。

  configuration:
"@type": "type.googleapis.com/google.protobuf.StringValue"
value: |
{
"mockEnable": true
}

使用curl通过网关访问httpbin,可以看到经过网关处理后的请求头的内容,如下:

curl http://127.0.0.1:10000/get

hello world

说明插件配置修改生效,开启了mock应答直接返回了hello world。

更多示例

无配置插件

插件无需配置时,直接定义空结构体即可

package main

import (
"github.com/alibaba/higress/plugins/wasm-go/pkg/wrapper"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
)

func main() {
wrapper.SetCtx(
"hello-world",
wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
)
}

type MyConfig struct {}

func onHttpRequestHeaders(ctx wrapper.HttpContext, config MyConfig, log wrapper.Log) types.Action {
proxywasm.SendHttpResponse(200, nil, []byte("hello world"), -1)
return types.ActionContinue
}

在插件中请求外部服务

目前仅支持 http 调用,支持访问在网关控制台中设置了服务来源的 Nacos、K8s 服务,以及固定地址或 DNS 来源的服务。请注意,无法直接使用net/http库中的 HTTP client,必须使用如下例中封装的 HTTP client。
下面例子中,在配置解析阶段解析服务类型,生成对应的 HTTP client ;在请求头处理阶段根据配置的请求路径访问对应服务,解析应答头,然后再设置在原始的请求头中。

package main

import (
"errors"
"net/http"
"strings"
"github.com/alibaba/higress/plugins/wasm-go/pkg/wrapper"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm"
"github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
"github.com/tidwall/gjson"
)

func main() {
wrapper.SetCtx(
"http-call",
wrapper.ParseConfigBy(parseConfig),
wrapper.ProcessRequestHeadersBy(onHttpRequestHeaders),
)
}

type MyConfig struct {
// 用于发起HTTP调用client
client wrapper.HttpClient
// 请求url
requestPath string
// 根据这个key取出调用服务的应答头对应字段,再设置到原始请求的请求头,key为此配置项
tokenHeader string
}

func parseConfig(json gjson.Result, config *MyConfig, log wrapper.Log) error {
config.tokenHeader = json.Get("tokenHeader").String()
if config.tokenHeader == "" {
return errors.New("missing tokenHeader in config")
}
config.requestPath = json.Get("requestPath").String()
if config.requestPath == "" {
return errors.New("missing requestPath in config")
}
serviceSource := json.Get("serviceSource").String()
// 固定地址和dns类型的serviceName,为控制台中创建服务时指定
// nacos和k8s来源的serviceName,即服务注册时指定的原始名称
serviceName := json.Get("serviceName").String()
servicePort := json.Get("servicePort").Int()
if serviceName == "" || servicePort == 0 {
return errors.New("invalid service config")
}
switch serviceSource {
case "k8s":
namespace := json.Get("namespace").String()
config.client = wrapper.NewClusterClient(wrapper.K8sCluster{
ServiceName: serviceName,
Namespace: namespace,
Port: servicePort,
})
return nil
case "nacos":
namespace := json.Get("namespace").String()
config.client = wrapper.NewClusterClient(wrapper.NacosCluster{
ServiceName: serviceName,
NamespaceID: namespace,
Port: servicePort,
})
return nil
case "ip":
config.client = wrapper.NewClusterClient(wrapper.StaticIpCluster{
ServiceName: serviceName,
Port: servicePort,
})
return nil
case "dns":
domain := json.Get("domain").String()
config.client = wrapper.NewClusterClient(wrapper.DnsCluster{
ServiceName: serviceName,
Port: servicePort,
Domain: domain,
})
return nil
default:
return errors.New("unknown service source: " + serviceSource)
}
}

func onHttpRequestHeaders(ctx wrapper.HttpContext, config MyConfig, log wrapper.Log) types.Action {
// 使用client的Get方法发起HTTP Get调用,此处省略了timeout参数,默认超时时间500毫秒
config.client.Get(config.requestPath, nil,
// 回调函数,将在响应异步返回时被执行
func(statusCode int, responseHeaders http.Header, responseBody []byte) {
// 请求没有返回200状态码,进行处理
if statusCode != http.StatusOK {
log.Errorf("http call failed, status: %d", statusCode)
proxywasm.SendHttpResponse(http.StatusInternalServerError, nil,
[]byte("http call failed"), -1)
return
}
// 打印响应的HTTP状态码和应答body
log.Infof("get status: %d, response body: %s", statusCode, responseBody)
// 从应答头中解析token字段设置到原始请求头中
token := responseHeaders.Get(config.tokenHeader)
if token != "" {
proxywasm.AddHttpRequestHeader(config.tokenHeader, token)
}
// 恢复原始请求流程,继续往下处理,才能正常转发给后端服务
proxywasm.ResumeHttpRequest()
})
// 需要等待异步回调完成,返回Pause状态,可以被ResumeHttpRequest恢复
return types.ActionPause
}