开发 Wasm 协议插件指南

1. 查看 GOPATH 路径
go env | grep GOPATH
2. 在 GOPATH/src 目录中创建
mkdir plugin-repocd plugin-repo
3. 执行项目初始化
go mod init
4. 创建协议插件目录名称，假设叫做

plugin-repo // 插件仓库根目录├── go.mod // 项目依赖管理└── bolt // 插件名称，开发者扩展代码放到这里 └── main // 注册插件逻辑，开发者编写注册插件逻辑 └── build // 插件编译后，自动生成

go get github.com/zonghaishang/proxy-wasm-sdk-gogo mod vendor

plugin-repo // 插件仓库根目录├── go.mod // 项目依赖管理├── Makefile // 编译插件成 wasm 文件└── bolt ├── protocol.go ├── command.go ├── codec.go ├── api.go ├── main │ ├── main.go │ └── main_test.go ├── build // 插件编译后，自动生成 └── bolt-go.wasm

type Codec interface { Decode(ctx context.Context, data Buffer) (Command, error) Encode(ctx context.Context, cmd Command) (Buffer, error)}

type Request interface { Command // IsOneWay Check that the request does not care about the response IsOneWay() bool GetTimeout() uint32 // request timeout}
type Response interface { Command GetStatus() uint32 // response status}

// Command base request or response commandtype Command interface { // Header get the data exchange header, maybe return nil. GetHeader() Header // GetData return the full message buffer, the protocol header is not included GetData() Buffer // SetData update the full message buffer, the protocol header is not included SetData(data Buffer) // IsHeartbeat check if the request is a heartbeat request IsHeartbeat() bool // CommandId get command id CommandId() uint64 // SetCommandId update command id // In upstream, because of connection multiplexing, // the id of downstream needs to be replaced with id of upstream // blog: https:mosn.io/blog/posts/multi-protocol-deep-dive/#%E5%8D%8F%E8%AE%AE%E6%89%A9%E5%B1%95%E6%A1%86%E6%9E%B6 SetCommandId(id uint64)}

type KeepAlive interface { KeepAlive(requestId uint64) Request ReplyKeepAlive(request Request) Response}

type Hijacker interface { // Hijack allows sidecar to hijack requests Hijack(request Request, code uint32) Response}

type Protocol interface { Name() string Codec() Codec KeepAlive Hijacker Options}type Hijacker interface { // Hijack allows sidecar to hijack requests Hijack(request Request, code uint32) Response}

// L7 layer extensiontype ProtocolContext interface { Name() string // protocol name Codec() Codec // frame encode & decode KeepAlive() KeepAlive // protocol keep alive Hijacker() Hijacker // protocol hijacker Options() Options // protocol options}

// 1. 提供 bolt 插件 protocolContext 实现type boltProtocolContext struct { proxy.DefaultRootContext // notify on plugin start. proxy.DefaultProtocolContext // 继承默认协议实现，比如使用默认 Options() bolt proxy.Protocol // 插件真实协议实现 contextID uint32}
// 2. 创建 bolt 单实例协议实例var boltProtocol = bolt.NewBoltProtocol()
func boltContext(rootContextID, contextID uint32) proxy.ProtocolContext { return &boltProtocolContext{ bolt: boltProtocol, contextID: contextID, }}
// 3. 注册 boltContext 协议钩子func main() { proxy.SetNewProtocolContext(boltContext)}
// 4. 如果协议不支持心跳，这里允许返回 nilfunc (proto *boltProtocolContext) KeepAlive() proxy.KeepAlive { return proto.bolt}
// 5. 如果需要获取插件参数，可以 override 对应方法func (proto *boltProtocolContext) OnPluginStart(conf proxy.ConfigMap) bool { proxy.Log.Infof("proxy_on_plugin_start from Go!") return true}

// 1. 注册对应 context 和配置，boltContext 在同一个 main 包下已经实现
opt := proxy.NewEmulatorOption().
    WithNewProtocolContext(boltContext).
    WithNewRootContext(rootContext).
    WithVMConfiguration(vmConfig)

// 2. 创建一个 sidecar 模拟器
host := proxy.NewHostEmulator(opt)
// release lock and reset emulator state
defer host.Done()

// 3. 调用 host 对应实现，比如启动沙箱
host.StartVM()

// 4. 调用启动插件
host.StartPlugin()

// 5. 模拟新请求到来，创建插件上下文
ctxId := host.NewProtocolContext()

// 6. 模拟 host 接收客户端请求，并解码
cmd, err := host.Decode(...)

// 7. 模拟 host 转发请求，并编码
upstreamBuf, err := host.Encode(...)

// 8. 模拟 host 处理完请求
host.CompleteProtocolContext(ctxId)

1. 本地编译，bolt 替换成开发者插件名
make name=bolt
2. 基于镜像编译
make build-image name=bolt

./mosnd start -c /path/to/mosn_rpc_config_wasm.json

下载 mosn 代码到本地 GOPATH, 可以通过本地 shell 执行：go env | grep GOPATH 查看
step 1:
mkdir -p $GOPATH/src/mosn.iocd $GOPATH/src/mosn.io
step 2:
clone mosn 源码
git clone https://github.com/mosn/mosn.git
step 3:
本地编译
sudo make build-local tags=wasmer
编译成功后，会在项目根目录下
build/bundles/v0.21.0/binary/mosnd

Package path: mosn.io/mosn/cmd/mosn/mainProgram arguments: start -c /path/to/mosn_rpc_config_wasm.json

git clone https://github.com/sofastack-guides/sofastack-mesh-demo.git
checkout 到 wasm_benchmark 分支
git checkout wasm_benchmark
cd sofastack-mesh-demo/sofa-samples-springboot2
本地打包 sofaboot 应用程序
mvn clean package
打包成功后，会在 sofa-echo-server 和 sofa-echo-client 下生成 target 目录，
其中分别包含服务端和客户端可执行程序，文件名分别为：
sofa-echo-server-web-1.0-SNAPSHOT-executable.jar
sofa-echo-client-web-1.0-SNAPSHOT-executable.jar

java -DMOSN_ENABLE=true -Drpc_tr_port=12199 -Dspring.profiles.active=dev -Drpc_register_registry_ignore=true -jar sofa-echo-server-web-1.0-SNAPSHOT-executable.jar

java -DMOSN_ENABLE=true -Drpc_tr_port=12198 -Dspring.profiles.active=dev -Drpc_register_registry_ignore=true -jar sofa-echo-client-web-1.0-SNAPSHOT-executable.jar

[57,21,7ms]2021-03-16 20:57:05 echo result: Hello world![57,22,5ms]2021-03-16 20:57:06 echo result: Hello world![57,23,7ms]2021-03-16 20:57:07 echo result: Hello world![57,24,7ms]2021-03-16 20:57:08 echo result: Hello world![57,25,8ms]2021-03-16 20:57:09 echo result: Hello world![57,26,7ms]2021-03-16 20:57:10 echo result: Hello world![57,27,5ms]2021-03-16 20:57:11 echo result: Hello world![57,28,7ms]2021-03-16 20:57:12 echo result: Hello world!