当你在用C/C++之类的语言编写模块时,你可以使用Emscripten来将它编译到WebAssembly。让我们来看看它是如何工作的。
首先,让我们来配置所需要的开发环境。
你需要将下列工具安装在您的电脑上,首先让我们确认下都有哪些。
注意: 在Windows下您可能需要pywin32,为了降低安装pywin32可能遇到的错误,请使用管理员权限在cmd内运行安装程序。
接下来,您需要通过源码自己编译一个Emscripten。运行下列命令来自动化地使用Emscripten SDK。(在你想保存Emscripten的文件夹下运行)。
git clone https://github.com/juj/emsdk.git
cd emsdk
# 在 Linux 或者 Mac OS X 上
./emsdk install --build=Release sdk-incoming-64bit binaryen-master-64bit
./emsdk activate --global --build=Release sdk-incoming-64bit binaryen-master-64bit
# 在 Windows 上
emsdk install --build=Release sdk-incoming-64bit binaryen-master-64bit
emsdk activate --global --build=Release sdk-incoming-64bit binaryen-master-64bit
# 注意:Windows 版本的 Visual Studio 2017 已经被支持,但需要在 emsdk install 需要追加 --vs2017 参数。
安装过程可以会花上一点时间,是时候去休息一下。安装程序会设置所有Emscripten运行所需要的环境变量。
注意: –global标识会让PATH变量在全局被设置,所以接下来所打开的终端或者命令行窗口都会被设置。如果您仅仅想让Emscripten在当前窗口生效,就删掉这个标识。
注意: 每当您想要使用Emscripten时,尝试从远程更新最新的emscripten代码是个很好的习惯(运行git pull)。如果有更新,重新执行 install 和 activate命令。这样就可以确保您使用的Emscripten一直保持最新。
现在让我们进入emsdk文件夹,输入以下命令来让你进入接下来的流程,编译一个样例C程序到asm.js或者wasm。
# on Linux or Mac OS X
source ./emsdk_env.sh
# on Windows
emsdk_env.bat
现在环境配置完毕,让我们看看如何使用它把C代码编译到Emscripten。当使用Emscripten来编译的时候有很多种不同的选择,我们介绍其中主要的2种:
让我们一个一个看看。
我们先来看一个最简单的例子,通过这个,你可以使用Emscripten来将任何代码生成到WebAssembly,然后在浏览器上运行。
#include <stdio.h>
int main(int argc, char ** argv) {
printf("Hello World\n");
}
emcc hello.c -s WASM=1 -o hello.html
下面列出了我们命令中选项的细节:
-s WASM=1
— 指定我们想要的wasm输出形式。如果我们不指定这个选项,Emscripten默认将只会生成asm.js。-o hello.html
— 指定这个选项将会生成HTML页面来运行我们的代码,并且会生成wasm模块,以及编译和实例化wasm模块所需要的“胶水”js代码,这样我们就可以直接在web环境中使用了。这个时候在您的源码文件夹应该有下列文件:
hello.wasm
二进制的wasm模块代码hello.js
一个包含了用来在原生C函数和JavaScript/wasm之间转换的胶水代码的JavaScript文件hello.html
一个用来加载,编译,实例化你的wasm代码并且将它输出在浏览器显示上的一个HTML文件现在使用一个支持 WebAssembly 的浏览器,加载生成的 hello.html
。
提示:Firefox 52+ 和 Chrome 57+ 和最新版本的 Opera已经默认启用,你也可以在Firefox 47+中通过在about:config页面启用
javascript.options.wasm
字段获得支持,Chrome51+ 和 Opera 38+ 可以在chrome://flags 页面启用Experimental WebAssembly 选项以支持WebAssembly。
如果一切顺利,你应该可以在页面上的 Emscripten 控制台
和 浏览器控制台
中看到 “Hello World” 的输出。
恭喜!你已经成功将 C 代码编译成 JavaScript 并且在浏览器中执行了!
有些时候你可能想要使用一个自定义的 HTML 模板。让我们看看怎么实现。
#include <stdio.h>
int main(int argc, char ** argv) {
printf("Hello World\n");
}
shell_minimal.html
的文件,然后复制它到刚刚创建的目录下的html_template
文件夹。
mkdir html_template
cp ~/emsdk/emscripten/1.38.15/src/shell_minimal.html html_template
emcc -o hello2.html hello2.c -O3 -s WASM=1 --shell-file html_template/shell_minimal.html
这次使用的选项略有不同:
-o hello2.html
,这意味编译器将仍然输出 js 胶水代码和 html 文件。--shell-file html_template/shell_minimal.html
,这指定了您要运行的例子使用 HTML 页面模板。注意: 通过用.js取代.htm(l)作为文件后缀名,你就可以得到只有JavaScript的输出文件,而不再是完整的HTML文件。例如:
emcc -o hello2.js hello2.c -O3 -s WASM=1
. 你可以完全从零开始创建你自己的HTML文件。尽管如此,不推荐这样做。因为Emscripten需要大量的JavaScript“胶水”代码从而能够处理内存分配、内存泄漏以及大量的其他问题。这些问题都已经在提供的模板中得到了处理。使用模板要比自己编写模板要容易得多。不过,当对模板所做的事情越来越熟悉的时候,你就能够按照自己的需要创建定制化的模板了。
如果需要调用一个在 C 语言自定义的函数,你可以使用 Emscripten中的ccall()
函数,以及EMSCRIPTEN_KEEPALIVE
声明(将你的函数添加到导出函数列表中(详见Why do functions in my C/C++ source code vanish when I compile to JavaScript, and/or I get No functions to process?))。
接下来让我们看看这是怎么实现的。
hello3.c
:
#include <stdio.h>
#include <emscripten/emscripten.h>
int main(int argc, char ** argv) {
printf("Hello World\n");
}
#ifdef __cplusplus
extern "C" {
#endif
int EMSCRIPTEN_KEEPALIVE myFunction(int argc, char ** argv) {
printf("我的函数已被调用\n");
}
#ifdef __cplusplus
}
#endif
默认情况下,Emscripten 生成的代码只会调用main()
函数,其它的函数将被视为无用代码。在一个函数名之前添加EMSCRIPTEN_KEEPALIVE
能够防止这样的事情发生。你需要导入emscripten.h
库来使用EMSCRIPTEN_KEEPALIVE
。
注意: 为了保证万一你想在 C++代码中引用这些代码时代码可以正常工作,我们添加了
#ifdef
代码块。由于 C 与 C++中名字修饰规则的差异,添加的代码块有可能产生问题,但目前我们设置了这一额外的代码块以保证你使用C++ 时,这些代码会被视为外部 C 语言函数。
为了方便起见,现在将html_template/shell_minimal.html
也添加到这一目录(但在实际开发环境中你肯定需要将其放到某一特定位置)。
emcc -o hello3.html hello3.c -O3 -s WASM=1 -s "EXTRA_EXPORTED_RUNTIME_METHODS=['ccall']" --shell-file html_template/shell_minimal.html
如果你在浏览器中在此加载实例,你将看到和之前相同的结果。
myFunction()
JavaScript函数。首先,按照以下实例添加一个 <button>
,就在<script type='text/javascript'>
开头标签之前。
<button class="mybutton">运行我的函数</button>
<script>
元素 (就在</script>
关闭标签之前)中添加以下代码:
document.querySelector('.mybutton').addEventListener('click', function(){
alert('检查控制台');
var result = Module.ccall('myFunction', // name of C function
null, // return type
null, // argument types
null); // arguments
});
以上就是如何使用ccall()
调用导出的函数的方式。