基于 Wasmer 的完整且成熟的 Go WebAssembly 运行时。
特性
- 易于使用:
wasmer
API 模仿标准 WebAssembly API, - 快速:
wasmer
以尽可能快的速度执行 WebAssembly 模块,接近原生速度, - 安全:所有对 WebAssembly 的调用都将快速执行,更重要的是,完全安全且沙盒化。
文档:浏览详细的 API 文档,其中包含大量示例。
示例作为教程:浏览 examples/
目录,这是完整介绍的最佳场所!
安装
要安装该库,请按照常规方式执行:
$ go get github.com/wasmerio/wasmer-go/wasmer
然后就可以开始使用了!
支持的平台
该库嵌入了编译为共享库对象的 Wasmer 运行时,因此使用 cgo
来使用它。我们提供了一组预编译的共享库对象。因此,该库可在以下平台上工作(并经过测试):
平台 | 架构 | 三元组 | 状态 |
---|---|---|---|
Linux | amd64 | x86_64-unknown-linux-gnu | ✅ |
aarch64 | aarch64-unknown-linux-gnu | ✅ | |
Darwin | amd64 | x86_64-apple-darwin | ✅ |
aarch64 | aarch64-apple-darwin | ⏳ | |
Windows | amd64 | x86_64-pc-windows-msvc | ⏳ |
如果你的平台缺失怎么办?
目前还没有自动化该过程的脚本。我们正在努力。
以下是手动执行的步骤:
$ # 构建新的 Wasmer C API 共享对象库。
$ cargo build --release
$
$ # 配置 cgo。
$ export CGO_CFLAGS="-I$(pwd)/wasmer/packaged/include/"
$ export CGO_LDFLAGS="-Wl,-rpath,$(pwd)/target/release/ -L$(pwd)/target/release/ -lwasmer_go"
$
$ # 运行测试。
$ just test -tags custom_wasmer_runtime
示例
我们强烈建议阅读 examples/
目录,其中包含一系列示例/教程。这是通过阅读示例来学习的最佳场所。
但对于最急切的人来说,在 examples/appendices/simple.go
中有一个用 Rust 编写的简单玩具程序:
#[no_mangle]
pub extern "C" fn sum(x: i32, y: i32) -> i32 {
x + y
}
编译后的WebAssembly二进制文件包含在examples/appendices/simple.wasm
中。
然后,我们可以在Go中执行它:
package main
import (
"fmt"
"os"
wasmer "github.com/wasmerio/wasmer-go/wasmer"
)
func main() {
wasmBytes, _ := os.ReadFile("simple.wasm")
engine := wasmer.NewEngine()
store := wasmer.NewStore(engine)
// 编译模块
module, _ := wasmer.NewModule(store, wasmBytes)
// 实例化模块
importObject := wasmer.NewImportObject()
instance, _ := wasmer.NewInstance(module, importObject)
// 从WebAssembly实例中获取导出的`sum`函数
sum, _ := instance.Exports.GetFunction("sum")
// 使用Go标准值调用导出的函数。WebAssembly类型会被自动推断和转换。
result, _ := sum(5, 37)
fmt.Println(result) // 42!
}
最后,通过运行以下命令来享受结果:
$ cd examples/appendices/
$ go run simple.go
42
测试
使用以下命令运行测试:
$ just test
什么是WebAssembly?
引用WebAssembly官网的话:
WebAssembly(简称Wasm)是一种为基于栈的虚拟机设计的二进制指令格式。Wasm被设计为高级语言(如C/C++/Rust)编译的可移植目标,使客户端和服务器应用能够部署在Web上。
关于速度:
WebAssembly旨在通过利用各种平台上普遍可用的常见硬件功能来实现原生速度执行。
关于安全性:
WebAssembly描述了一个内存安全、沙箱化的执行环境 […]。
许可证
整个项目采用MIT许可证。请阅读LICENSE
文件。
常见问题
如何使用wasmer-go
运行编译为WebAssembly模块的Go程序?
首先要强调的是,wasmer-go
是一个WebAssembly运行时。它允许在Go中运行WebAssembly。它不是将Go程序编译成WebAssembly的工具。然而,许多人在将Go程序编译为WebAssembly,然后尝试使用wasmer-go
(或其他主机,如Python、C、PHP、Ruby、Rust等)运行时遇到问题。
主要问题是,虽然Go编译器支持WebAssembly,但它不支持WASI(WebAssembly系统接口)。它生成的ABI与JavaScript深度绑定,需要使用Go工具链提供的wasm_exec.js
文件,而这在JavaScript主机之外无法工作。
幸运的是,有两个解决方案:
-
使用TinyGo将Go程序编译为WebAssembly,并使用
-target wasi
选项,例如:$ tinygo build -o module.wasm -target wasi .
生成的WebAssembly模块将可在所有支持WASI的WebAssembly运行时中移植。
-
使用Go编译器和适配器。让我们看看如何编译:
$ GOOS=js GOARCH=wasm go build -o module.wasm .
(
GOOS=js
表明目标是JavaScript,这并不意外)。然后选择一个适配器(它们由社区编写):
并按照它们的文档进行操作。
如果可行的话,我们强烈推荐第一种解决方案(使用TinyGo),因为WebAssembly模块将可在所有WebAssembly运行时中移植。这不是基于适配器的黑客解决方案;这是正确的方式。