WebAssembly(简称 Wasm),是一个安全、可移植(无硬件和操作系统相依)的低级语言(类似汇编语言),由 W3C 制定标准,并由世界四大浏览器 Mozilla Firefox、Microsoft Edge、Google Chrome 和 Apple Safari 的提供商共同开发,能用来制作高性能且体积小的程序,通常是应用在 Web 上,但也不限于此。WebAssembly 并不是利用新语法来编译出优化过的 JavaScript 语法,而是一个崭新的、可以在一次编译后直接在各个主流网页浏览器上运行的编程语言。性能敏感的程序若使用 Web­Assembly 来开发,可以让它的性能比原先用 JavaScript 开发还要好上几倍,甚至是数十倍。

既然 Web­Assembly 这么厉害,那它会取代掉 JavaScript 吗?

尽管 JavaScript 引擎再怎么强大,JavaScript 程序的性能始终无法和 C/C++、Rust 等编程语言针对 CPU 架构和操作系统制作出来的原生程序相提并论,因此 WebAssembly 的出现主要就是为了解决这个问题,让程序就算在网页浏览器上运行,也还是可以保有接近原生程序的性能。不过 WebAssembly 也并不是想要取代 JavaScript,虽然 WebAssembly 的程序性能很好、体积也小,但在某些场合下,JavaScript 也不见得会比它慢,而且 JavaScript 的代码通常会比 WebAssembly 源代码编译出来的二进制档还要小很多,不用花费太多下载时间。

现阶段在网页浏览器或是 Node.js 上,WebAssembly 编译好的二进制档会透过胶水代码(glue code),以模块的形式加载到 JavaScript 中,其实就有点像是在 Node.js 使用 C/C++ 的附加程序(Add-on)啦!因此或许 Web­Assembly 最终会取代 JavaScript,但那大概也是十年后的事了。

Web­Assembly 的代码

Web­Assembly 的代码文件使用的扩展名为 .wat。

以下面这个 JavaScript 来举例:

function addTwo(a, b) {
    return a + b;
}

可以改用 Web­Assembly 来完成相同的功能,如下:

(module
  (func $addTwo (param i32 i32) (result i32)
    get_local 0
    get_local 1
    i32.add)
  (export "addTwo" (func $addTwo)))

Web­Assembly 的代码需要经过编译才可以被网页浏览器或是 Node.js 使用,编译出来的二进制档使用的扩展名为 .wasm。这种文件现阶段需要透过 JavaScript 的胶水代码来加载到 JavaScript 中才能被运行,这些胶水代码是由协助建置 Web­Assembly 项目的工具自动产生,用来处理 JavaScript 层和 Web­Assembly 层的转换。这个部份会在之后的章节做更详细的介绍。

上面的 addTwo 范例可以在这个网页中实际运行看看,网页中也提供了其它的范例,都可以开来玩玩看。

我没有学过汇编语言,觉得 Web­Assembly 的语法好难

对于没有学过汇编语言的人来说,Web­Assembly 类似汇编语言的语法结构可能会让他们有些困扰,不知道要从哪里下手。

其实不会汇编语言也没关系,许多高级编程语言都可以用来开发 Web­Assembly 的程序,其中就包括 C、C++、Rust、Go、JavaScript 和 Python。而在本系列文章中,主要就会用 Rust 编程语言来开发 Web­Assembly 的程序。

Rust + WebAssembly 的开发环境

使用 Rust 编程语言来开发 Web­Assembly 程序,并不只是单单引用某个或是某几个 crates.io 上的套件来用就好了,还需要安装 JavaScript 相关的工具,以及用来建置、测试及发布 Web­Assembly 程序项目的工具。

Rust 编程语言

如果您还不熟悉 Rust 编程语言,甚至是连 Rust 开发环境都还没有的话,请先参考笔者撰写的《Rust 学习之路》系列文章。

TypeScript 编程语言

虽然不是必要,但本系列的教学会撰写 TypeScript 程序来编译出 JavaScript 程序。因为 TypeScript 要比 JavaScript 容易维护多了,最好尽可能地使用 TypeScript。如果您还不熟悉 TypeScript 编程语言,甚至是连 TypeScript 开发环境都还没有的话,请先参考笔者撰写的《TypeScript 学习之路》系列文章。

Webpack(Node.js)

本系列的教学还需要用到 Webpack 来打包 Web­Assembly 的 TypeScript/JavaScript 程序,有关于 Webpack 的开发环境设置和基础教学,可以参考这两篇文章:

wasm-pack

wasm-pack 是 Rust 生态圈提供的 Web­Assembly 开发工具。可以使用以下指令来安装:

cargo install wasm-pack

cargo-generate

cargo-generate 可以快速地从远程的 Git 仓库(repository)中下载 Cargo 程序项目,当作是新的 Cargo 程序项目的模板。可以使用以下指令来安装:

cargo install cargo-generate

加入编译目标(target)

要使 Rust 程序能够被编译为 .wasm 文件,必须将编译目标设为 wasm32-unknown-unknown。

以下指令可以加入 wasm32-unknown-unknown 目标:

rustup target add wasm32-unknown-unknown

Hello World

学习一个编程语言,依照惯例,第一支程序都会是「Hello World」。现在,我们就来从无到有,一步步地从创建新的 Cargo 程序项目开始,一直到能够在网页浏览器上运行 WebAssembly 程序,并用对话框秀出 Hello, world! 这几个字吧!

创建项目目录

首先,运行以下指令,用 cargo-generate 创建出名叫 hello-webassembly 的应用程序项目。

cargo generate --git https://github.com/rustwasm/wasm-pack-template.git -n hello-webassembly

以 cargo generate 创建 WebAssembly 项目

若您有兴趣的话可以自行看一下 wasm-pack-template 这个模板产生出来的代码,底下会继续介绍程序的实作流程,就不多说明了。

wasm_bindgen

先用编辑器打开 src/lib.rs,应该会看到有两个部份的程序被加上 #[wasm_bindgen] 属性。如下:

...

#[wasm_bindgen]
extern "C" {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    alert("Hello, hello-webassembly!");
}

...

若在 extern 关键字所组成的程序区块加上 #[wasm_bindgen] 属性,表示要将这个区块里面定义的函数链接到 JavaScript 提供的函数。

如果在有使用 pub 来定义的函数加上 #[wasm_bindgen] 属性,表示要暴露(export)这个函数到 JavaScript 中。

Rust 程序实作

为了能在对话框秀出 Hello, world!,我们要将程序修改如下:

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    alert("Hello, world!");
}

...

建置项目

写完 Rust 程序后,就可以运行以下指令将它编译成 .wasm 文件了!

wasm-pack build

以 wasm-pack build 编译项目

编译后产生出来的东西会是一个完整的 JavaScript 套件,文件会被放在 Cargo 程序项目根目录的 pkg 目录中,列表如下:

  • hello_webassembly_bg.js:这个就是前面提到过的胶水代码。
  • hello_webassembly_bg.wasm:看扩展名就知道这个就是 WebAssembly 的二进制档。
  • hello_webassembly_bg.wasm.d.ts:TypeScript 定义档,可以使 WebAssembly 的二进制档(WASM 模块)被用于 TypeScript 中。
  • hello_webassembly.js:用来引用胶水代码和定义其它 JS 相关的东西,我们主要会引用这个文件来做东西。
  • hello_webassembly.d.ts:这个是 hello_webassembly.js 的 TypeScript 定义档,可以使胶水代码用于 TypeScript 中。
  • package.json:这个 JavaScript 套件的设置档。
  • README.md:这个就是 Cargo 程序项目根目录 README.md,wasm-pack 只是把它拷贝过来而已。

要怎么把这些文件套用在 HTML 网页?

我们可以在 Cargo 程序项目目录中,添加一个 www 目录,然后在这个目录中参考以下链接的文章来创建 TypeScript 函数库项目:

在 TypeScript 项目中运行以下指令来安装必要套件:

pnpm i -D webpack webpack-cli babel-loader @babel/core @babel/preset-env @babel/preset-typescript @babel/register terser-webpack-plugin html-webpack-plugin

修改 TypeScript 代码,如下:

export { greet } from "../../pkg/hello_webassembly.js";

添加 www/src/index.ts 文件,内容如下:

import { greet } from "./lib.js";

greet();

添加 www/views/index.html 文件,内容如下:

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <title>Greeting</title>
</head>
<body>
    You should see an alert message.

    <script src="./js/bundle.min.js"></script>
</body>
</html>

添加 www/webpack.config.ts 文件,即 Webpack 的设置档,内容如下:

import HtmlWebpackPlugin from "html-webpack-plugin";
import TerserPlugin from "terser-webpack-plugin";
import { Configuration } from "webpack";

const config: Configuration = {
    entry: "./src/index.ts",
    output: {
        clean: true,
        filename: "./js/bundle.min.js",
    },
    plugins: [
        new HtmlWebpackPlugin({
            template: "./views/index.html",
            filename: "./index.html",
            minify: {
                collapseBooleanAttributes: true,
                collapseWhitespace: true,
                removeAttributeQuotes: true,
                removeComments: true,
                removeEmptyAttributes: true,
                removeRedundantAttributes: true,
                removeScriptTypeAttributes: true,
                removeStyleLinkTypeAttributes: true,
                minifyCSS: true,
                minifyJS: true,
                sortAttributes: true,
                useShortDoctype: true,
            },
            inject: false,
        }),
    ],
    module: {
        rules: [
            {
                test: /\.ts$/i,
                use: [
                    {
                        loader: "babel-loader",
                        options: { presets: ["@babel/preset-env", "@babel/preset-typescript"] },
                    },
                ],
            },
            {
                test: /\.js$/i,
                use: [
                    {
                        loader: "babel-loader",
                        options: { presets: ["@babel/preset-env"] },
                    },
                ],
            },
        ],
    },
    resolve: { extensionAlias: { ".js": [".ts", ".js"] } },
    optimization: {
        minimizer: [
            new TerserPlugin({
                extractComments: false,
                terserOptions: { format: { comments: false } },
            }),
        ],
    },
    experiments: { asyncWebAssembly: true },
};

export default config;

修改 www/.eslintrc 文件,将 www/webpack.config.ts 加进 import/no-extraneous-dependencies 规则的 devDependencies 的例外中。

在 www/package.json 中添加脚本:

{
    ...

    "scripts": {
        ...

        "build:webpack": "webpack --mode production",

        ...
    }
  
    ...
}

然后就可以在 www 目录中运行 npm run build:webpack 指令来打包项目。接着再使用 VSCode 的 Live Server 打开 Webpack 输出的 index.html,正常情况下会成功在网页浏览器看到 Hello, world! 对话框。

这边要注意的是,在 Webpack 设置档中要将实验性的 WebAssembly 功能打开。Webpack 本身就有支持 .wasm 文件的打包,所以可不必替 .wasm 文件撰写加载器规则。Webpack 在输出 .wasm 文件时,会将文件名替换成哈希值。

如果要更变 .wasm 文件的输出文件名,或是输出路径的话,可以在 Webpack 设置的 output 字段再加上 webassemblyModuleFilename 字段,这个字段的值预设为 [hash].module.wasm,把它指定成我们要的路径和文件名即可。例如:

const config: Configuration = {
    ...

    output: {
        ...

        webassemblyModuleFilename: "./wasm/game-of-life.wasm",

        ...
    }

    ...
};

总结

在这个章节中,我们稍微了解了 Web­Assembly,以及 Web­Assembly 和 JavaScript 的关联。并且也学会了从无到有,用 Rust 编程语言和 Webpack 来制作出应用了 Web­Assembly 的网页。

在接下来的章节中,会以更多例子来介绍用 Rust 编程语言开发 Web­Assembly 程序的方式。

下一章:将高性能的 Rust 函数库套用在网页上。