关于

注意：遗憾的是，wit-bindgen的维护者不想添加对Wasmer的支持，因此我们不得不进行硬分叉以使与Wasmer兼容。

本项目是一个WebAssembly程序及其嵌入的绑定生成器框架。它与描述模块接口（无论是导入的还是导出的）的*.wai文件一起工作。例如，此项目可用于以下情况：

• 您的语言（例如，Rust）编译为WebAssembly，您想导入WASI。本项目将生成Rust绑定来导入用*.wai描述的WASI API。

• 您的运行时（例如，Wasmer）想要向客户程序提供WASI功能。本项目将为您生成一个Rust trait以实现WASI接口。

• 您正在消费一个WebAssembly模块（例如，在浏览器中），并且不想处理奇特的ABI细节。您将使用此项目生成JS绑定，这些绑定提供了处理WebAssembly模块（由*.wai描述）的TypeScript接口，该接口与原生JS类型交互。

本项目基于接口类型提案。此仓库将跟踪上游变更。WAI的目的在于提供与接口类型和规范ABI兼容的工具链和故事。生成的语言绑定都使用规范ABI进行通信，使WebAssembly模块可以以支持任何语言的任何语言编写，并使WebAssembly模块可以以支持任何环境的任何语言进行消费。

演示

在线查看生成的绑定！

如果你对探索给定输入*.wai生成的绑定感兴趣，你可以通过在线探索生成的代码来了解生成的内容以及粘合代码的样式。

用法

目前提供的命令行工具主要用于调试和探索目的。它可以很容易地与wasmer CLI一起使用。

// browser.wai

record person {
  name: string,
  age: u32,
}

// Say hello to either the specified person or the current user
hello: func(who: option<person>) -> string

$ wasmer run wasmer/wai-bindgen-cli --dir=. -- js --import browser.wai
Generating "browser.d.ts"
Generating "browser.js"
Generating "intrinsics.js"

这个工具并不一定是为了集成到工具链中。例如，在Rust中的使用更有可能通过过程宏和Cargo依赖项来完成。在Web应用程序中的使用可能需要将wai-bindgen编译为WebAssembly，并发布到NPM。

不过，现在你可以通过CLI探索每种语言中的绑定看起来像什么。如果你愿意依赖这个，请通过Slack联系我们，我们可以为你找到比依赖CLI工具更好的解决方案。

支持的语言

首先，这是一个支持生成使用接口类型的WebAssembly二进制的语言列表。这意味着这些语言支持*.wai定义的导入和导出。

• rust-wasm - 这是针对编译为WebAssembly的Rust，根据你的使用情况，通常使用wasm32-wasi或wasm32-unknown-unknown目标。在这种模式下，你可能需要依赖wai-bindgen-rust包（位于crates/rust-wasm），并使用import!和export!宏来生成代码。

• c - 这是针对编译为WebAssembly的C，也可以使用上述任一目标。对于C，wai-bindgen CLI工具将生成一个*.h和一个*.c文件，这些文件将被编译到wasm模块中。

此存储库还支持许多宿主语言/运行时，可以用来消费使用接口类型的WebAssembly模块。这些模块需要遵循其导出/导入的规范ABI。

• wasmer - 这是针对使用wasmer包的Rust用户。此生成器通过wai-bindgen-wasmer包（位于crates/wasmer）使用，并且与编译为wasm的Rust支持一样，有一个import!和一个export!宏用于生成代码。

• js - 这是针对执行WebAssembly模块的JavaScript用户。这可能是在浏览器、Node.js或Deno中。理论上，这也涵盖了像Web Workers这样的浏览器用例。在这种模式下，wai-bindgen CLI工具将生成一个*.js和一个*.d.ts文件，描述接口并提供在JS中实现规范ABI所需的必要运行时支持。请注意，此语言的长期集成目标是将其本身编译为WebAssembly，并发布NPM包以集成到流行的JS构建系统中。

• wasmer-py - 这是针对使用wasmer PyPI包的Python用户。这使用底层的Wasmer，但你可以在提供导入给WebAssembly模块或使用接口类型消费模块时编写Python。这生成一个*.py文件，该文件带有类型注释，可以在mypy或其他类型检查器中使用。

所有生成器都支持 --import 和 --export 标志，在 wai-bindgen 命令行工具中。

$ wasmer run wasmer/wai-bindgen-cli --dir=. -- js --import browser.wai
$ wasmer run wasmer/wai-bindgen-cli --dir=. -- rust-wasm --export my-interface.wai
$ wasmer run wasmer/wai-bindgen-cli --dir=. -- wasmer --import host-functions.wai

在这里，“导入”意味着“我想导入并调用此接口中的函数”，“导出”则意味着“我想定义此接口中的函数供他人调用”。

最后，在一种“杂项”类别中，wai-bindgen 命令行工具还支持以下功能：

• markdown - 从源 *.wai 文件中的注释生成可读的文档，并生成一个 *.md 文件和一个 *.html 文件。

请注意，这里支持的语言列表是一个时间快照，并非最终版本。接口类型提案的目的是在 WebAssembly 模块的编写以及如何使用它们方面都是语言无关的。如果您在这里没有列出运行时，或者您正在将语言编译为 WebAssembly 而语言没有列出，这并不意味着它永远不会被支持！语言绑定生成器旨在不是世界上最困难的事情（但不幸的是也不是最容易的事情）去编写，而这个存储库中的 crate 和支持主要是为了使编写生成器尽可能简单。

一些其他语言和运行时，例如，今天在 wai-bindgen 中没有支持，但在未来是可能的（也可能在这里编写）包括：

• wasmer-go - 与 wasmer-py 相同，但用于 Go。基本上是为使用 wasmer-go 包 的 Go 用户，他们想使用接口类型而不是原始指针、内存等。

• wasmer-ruby - 与 wasmer-py 相同，但用于 Ruby。基本上是为使用 wasmer-ruby 包 的 Ruby 用户，他们想使用接口类型而不是原始指针、内存等。

请注意，这不是一个排他性列表，只是为了给您一个其他绑定可能的样子。有大量的运行时和语言可以编译为 WebAssembly，接口类型应该能够与所有这些一起工作，并且理论上只需一些工作时间就可以在 wai-bindgen 中获得支持。