作者: 陈鑫(lencx) / 后期编辑：张汉东

Wasm是什么?

MDN官方文档是这样给出定义

WebAssembly(为了书写方便，简称Wasm)是一种新的编码方式，可以在现代的网络浏览器中运行 － 它是一种低级的类汇编语言，具有紧凑的二进制格式，可以接近原生的性能运行，并为诸如C / C ++等语言提供一个编译目标，以便它们可以在Web上运行。它也被设计为可以与JavaScript共存，允许两者一起工作。

对于网络平台而言，WebAssembly具有巨大的意义——它提供了一条途径，以使得以各种语言编写的代码都可以以接近原生的速度在Web中运行。在这种情况下，以前无法以此方式运行的客户端软件都将可以运行在Web中。

WebAssembly被设计为可以和JavaScript一起协同工作——通过使用WebAssembly的JavaScript API，你可以把WebAssembly模块加载到一个JavaScript应用中并且在两者之间共享功能。这允许你在同一个应用中利用WebAssembly的性能和威力以及JavaScript的表达力和灵活性，即使你可能并不知道如何编写WebAssembly代码。

环境安装及简介

1. Rust

一门赋予每个人 构建可靠且高效软件能力的语言。

安装

  1. # macOS
  2. curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  4. # 其他安装方式
  5. # https://forge.rust-lang.org/infra/other-installation-methods.html

常用命令

  1. # 版本更新
  2. rustup update
  4. # 查看版本
  5. cargo --version
  7. # 构建项目
  8. cargo build
  10. # 运行项目
  11. cargo run
  13. # 测试项目
  14. cargo test
  16. # 为项目构建文档
  17. cargo doc
  19. # 将库发布到 crates.io
  20. cargo publish
  1. # nightly rust
  2. rustup toolchain install nightly
  4. rustup toolchain list
  6. rustup override set nightly

2. Node.js

Node.js是基于Chrome的V8 JavaScript引擎构建的JavaScript运行时

3. wasm-pack

用于构建和使用您希望与JavaScript，浏览器或Node.js互操作的Rust生成的WebAssembly。

安装

  1. # macOS
  2. curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
  4. # 其他安装方式
  5. # https://rustwasm.github.io/wasm-pack/installer

常用命令

  1. # 创建
  2. # https://rustwasm.github.io/docs/wasm-pack/commands/new.html
  3. wasm-pack new <name> --template <template> --mode <normal|noinstall|force>
  5. # 构建
  6. # https://rustwasm.github.io/docs/wasm-pack/commands/build.html
  7. wasm-pack build
  8.   [--out-dir <out>]
  9.   [--out-name <name>]
  10.   [--<dev|profiling|release>]
  11.   [--target <bundler|nodejs|web|no-modules>]
  12.   [--scope <scope>]
  13.   [mode <normal|no-install>]
  15. # 测试
  16. # https://rustwasm.github.io/docs/wasm-pack/commands/test.html
  17. wasm-pack test
  19. # 发包
  20. # https://rustwasm.github.io/docs/wasm-pack/commands/pack-and-publish.html
  21. # npm pack
  22. wasm-pack pack
  23. # npm publish
  24. wasm-pack publish

4. Vite

下一代前端工具

vite-plugin-rsw：vite插件，简称Rsw - 集成wasm-pack的CLI

  • 支持rust包文件热更新，监听src目录和Cargo.toml文件变更，自动构建
  • vite启动优化，如果之前构建过，再次启动npm run dev，则会跳过wasm-pack构建
  1. # 在vite项目中安装
  2. npm i -D vite-plugin-rsw
  3. # or
  4. yarn add -D vite-plugin-rsw

5. create-xc-app

脚手架 - ⚡️在几秒钟内创建一个项目！维护了多种项目模板。

  1. # 根据命令行提示，输入项目名称，选择模板初始化项目
  2. # template: `wasm-react` or `wasm-vue`
  3. npm init xc-app

image.png

快速开始

  • 在原有vite项目中使用，只需安装配置vite-plugin-rsw插件即可。
  • 新项目可以使用vite提供的@vitejs/app初始化项目，然后安装配置vite-plugin-rsw。
  • 或者使用脚手架create-xc-app初始化项目，模板包含wasm-react和wasm-vue，会定期更新维护相关版本依赖。

项目结构

  1. # 推荐目录结构
  2. [my-wasm-app] # 项目根路径
  3. |- [wasm-hey] # npm包`wasm-hey`
  4. |    |- [pkg] # 生成wasm包的目录
  5. |    |    |- wasm-hey_bg.wasm # wasm文件
  6. |    |    |- wasm-hey.js # 包入口文件
  7. |    |    |- wasm-hey_bg.wasm.d.ts # ts声明文件
  8. |    |    |- wasm-hey.d.ts # ts声明文件
  9. |    |    |- package.json
  10. |    |    `- ...
  11. |    |- [src] # rust源代码
  12. |    | # 了解更多: https://doc.rust-lang.org/cargo/reference/cargo-targets.html
  13. |    |- [target] # 项目依赖，类似于npm的`node_modules`
  14. |    | # 了解更多: https://doc.rust-lang.org/cargo/reference/manifest.html
  15. |    |- Cargo.toml # rust包管理清单
  16. |    `- ...
  17. |- [@rsw] # npm 组织包
  18. |     |- [hey] # @rsw/hey, 目录结构同`wasm-hey`
  19. |     `- ...
  20. |- [node_modules] # 前端的项目包依赖
  21. |- [src] # 前端源代码(可以是vue, react, 或其他)
  22. | # 了解更多: https://nodejs.dev/learn/the-package-json-guide
  23. |- package.json # `npm`或`yarn`包管理清单
  24. | # 了解更多: https://vitejs.dev/config
  25. |- vite.config.ts # vite配置文件
  26. | # 了解更多: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
  27. |- tsconfig.json # typescript配置文件
  28. ` ...

乍一看，可能会觉得目录有点复杂，其实它就是一个标准的基于vite前端项目，然后，在根路径下去添加我们需要构建的wasm包(一个rust crate会对应生成一个wasm包，可单独发布到npm上)

创建Wasm包

  1. # 两种方式创建
  3. # 1.
  4. # 如果报错，可查看：https://github.com/rustwasm/wasm-pack/issues/907
  5. wasm-pack new <name>
  7. # 2.
  8. # name可以是npm组织
  9. # 例：cargo new --lib @rsw/hello
  10. # 需要手动配置Cargo.toml
  11. cargo new --lib <name>

image.pngimage.png

项目配置

以react项目为例

Step1: 配置Vite插件 - vite.config.ts

  1. import reactRefresh from '@vitejs/plugin-react-refresh';
  2. import { defineConfig } from 'vite';
  3. import ViteRsw from 'vite-plugin-rsw';
  5. export default defineConfig({
  6.   plugins: [
  7.     reactRefresh(),
  8.     // 查看更多：https://github.com/lencx/vite-plugin-rsw
  9.     ViteRsw({
  10.       // 支持开发(dev)和生产模式(release)
  11.       // 生产模式会对wasm文件的体积进行优化
  12.       mode: "release",
  13.       // 如果包在`unLinks`和`crates`都配置过
  14.       // 会执行，先卸载(npm unlink)，再安装(npm link)
  15.       // 例如下面会执行
  16.       // `npm unlink wasm-hey rsw-test`
  17.       unLinks: ['wasm-hey', 'rsw-test'],
  18.       // 项目根路径下的rust项目
  19.       // `@`开头的为npm组织
  20.       // 例如下面会执行:
  21.       // `npm link wasm-hey @rsw/hey`
  22.       // 因为执行顺序原因，虽然上面的unLinks会把`wasm-hey`卸载
  23.       // 但是这里会重新进行安装
  24.       crates: ["wasm-hey", "@rsw/hey"],
  25.     }),
  26.   ],
  27. })

Step2: 配置Rust项目清单 - wasm-hey/Cargo.toml

  1. # ...
  3. # https://github.com/rustwasm/wasm-pack/issues/886
  4. # https://developers.google.com/web/updates/2019/02/hotpath-with-wasm
  5. [package.metadata.wasm-pack.profile.release]
  6. wasm-opt = false
  8. # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
  9. [lib]
  10. crate-type = ["cdylib", "rlib"]
  12. [profile.release]
  13. opt-level = "s"
  15. [dependencies]
  16. wasm-bindgen = "0.2.70"

Step3: 添加Rust代码 - wasm-hey/src/lib.rs

use wasm_bindgen::prelude::*;

// Import the `window.alert` function from the Web.
#[wasm_bindgen]
extern "C" {
    fn alert(s: &str);
}

// Export a `greet` function from Rust to JavaScript, that alerts a hello message.
#[wasm_bindgen]
pub fn greet(name: &str) {
    alert(&format!("Hello, {}!", name));
}

Step4: React项目中调用Wasm方法 - src/App.tsx

import React, { useEffect } from 'react';
import init, { greet } from 'wasm-hey';

import logo from './logo.svg';
import './App.css';

function App() {
  useEffect(() => {
    // wasm初始化，在调用`wasm-hey`包方法时
    // 必须先保证已经进行过初始化，否则会报错
    // 如果存在多个wasm包，则必须对每一个wasm包进行初始化
    init();
  }, [])

  const handleHey = () => {
    // 调用greet方法
    greet('wasm');
  }

  return (
    <div className="App">
      <header className="App-header">
        <img src={logo} className="App-logo" alt="logo" />
        <p>Hello WebAssembly!</p>
        <p>Vite + Rust + React</p>
        <p>
          <button onClick={handleHey}>hi wasm</button>
        </p>
        <p>Edit <code>App.tsx</code> and save to test HMR updates.</p>
      </header>
    </div>
  )
}

export default App

常见问题汇总

Rsw插件

  • 插件内部是通过npm link的形式实现的wasm包安装，在一些极端场景下会出现，找不到依赖的安装包，导入的包不存在等错误，可以根据提示路径删除其link的文件，重新启动npm run dev可以解决。
  • npm link命令会把包link到全局环境，如果在多个项目使用相同wasm包名，可能会导致报错，解决办法，在全局npm的node_modules中删除该包即可。推荐不同项目使用不同wasm包名避免此类异常。
  • 插件是处于Vite开发模式下运行构建，所以至少执行过一次npm run dev，生成wasm包之后，再执行npm run build，否则也会报错，到不到.wasm文件之类的。
  • 插件API可以配置需要卸载的包(仅限于之前通过插件配置crates中rust项目)

前端

// init是wasm实例的初始化方法
// 在调用其他方法之前，必须先调用一次init方法，否则会报错
// init会请求`.wasm`文件并且返回一个`Promise`
import init, { greet } from 'wasm-test';

// -----------------------------------------

// 调用init方法，有两种方式

// 1.
// 在react，vue3中可以将其抽离为`hook`组件,
// 在进入生命周期时调用
init();

// 在调用过init方法之后，可以单独调用greet方法
greet('wasm');

// 2.
// 在初始化之后直接调用方法
init()
  .then(wasm => wasm.greet('wasm'));

相关链接

作者简介：

陈鑫(lencx)

{折腾 ⇌ 迷茫 ⇌ 思考]ing，在路上…