使用`wasm-bindgen`进行Rust与WebAssembly交互教程

2024-08-07 17:58:04作者：昌雅子Ethen

1. 项目介绍

wasm-bindgen是一个Rust库和CLI工具，它简化了WebAssembly模块与JavaScript之间的高级交互。该项目旨在提供一种方法，以便在Rust中定义JS类，从JavaScript传递字符串或对象到Rust，以及从Rust返回它们。wasm-bindgen不仅支持基本类型的交换，还支持更复杂的类型，如字符串、类和对象。它通过自动化绑定生成来减少手动编写转换代码的工作量。

2. 项目快速启动

安装`wasm-bindgen-cli`

首先确保已经安装了cargo，然后执行以下命令安装wasm-bindgen-cli：

cargo install wasm-bindgen-cli

创建简单的示例

创建一个新的Rust项目：

cargo new my_wasm_project --lib
cd my_wasm_project

在src/lib.rs中添加以下代码:

#[wasm_bindgen]
pub fn say_hello() {
    println!("Hello, WebAssembly!");
}

编译项目并生成WebAssembly文件：

wasm-bindgen --out-dir target/wasm32-unknown-unknown/release --target web src/lib.rs

接下来，在HTML中使用这个WebAssembly模块：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WASM Bindgen Example</title>
    <script type="module">
        import init, { say_hello } from './target/wasm32-unknown-unknown/release/my_wasm_project.js';

        async function run() {
            await init();
            say_hello(); // 在控制台应看到“Hello, WebAssembly!”
        }

        run();
    </script>
</head>
<body></body>
</html>

将HTML保存为index.html并在浏览器中打开。

3. 应用案例和最佳实践

案例1：从JavaScript调用Rust函数

在Rust中定义一个接受字符串参数的函数：

#[wasm_bindgen]
pub fn greet(name: &str) {
    println!("Hello, {}!", name);
}

在JavaScript中调用该函数：

import * as wasm from './my_wasm_project.js';
wasm.greet("World");

最佳实践：利用async/await处理异步

当处理Web API时，经常需要异步操作。wasm-bindgen支持async/await语法，使异步交互更加清晰：

#[wasm_bindgen]
pub async fn fetch_data(url: &str) -> Result<String, JsValue> {
    let resp = await!(fetch(url));
    Ok(await!(resp.text())?)
}

4. 典型生态项目

js-sys: 提供对JavaScript核心API的低级绑定。
web-sys: 提供对完整的Web API（DOM、WebGL等）的低级绑定。
wasm-bindgen-futures: 支持Rust中的futures和promises。
wasm-bindgen-test: 专为测试WebAssembly模块设计的框架。

以上内容是wasm-bindgen的基本介绍和入门指南。深入了解和进阶使用，请参考官方文档及教程资源。祝您开发愉快！

wasm-bindgen

Facilitating high-level interactions between Wasm modules and JavaScript

项目地址：https://gitcode.com/gh_mirrors/wa/wasm-bindgen

登录后查看全文