WebAssembly.instantiate
这是一个实验中的功能
在使用此产品之前,请仔细检查浏览器兼容性表。
WebAssembly.instantiate() 是编译和实例化 WebAssembly 代码的主要方法. 这个方法有两个重载方式:
- 第一种重载使用WebAssembly二进制代码的 typed array 或 ArrayBuffer 形式进行编译和实例化. 返回的
Promise会携带已编译的WebAssembly.Module和它的第一个实例化对象WebAssembly.Instance.
- 第二种重载使用已编译的
WebAssembly.Module, 返回的Promise携带一个Module的实例化对象Instance. 如果这个Module已经被编译了或者是从缓存中获取的( retrieved from cache), 那么这种重载方式是非常有用的.
语法
主重载方式 — 使用wasm二进制代码
Promise<ResultObject> WebAssembly.instantiate(bufferSource, importObject);参数
bufferSource一个包含你想编译的wasm模块二进制代码的typed array(类型数组) orArrayBuffer(数组缓冲区)importObject可选一个将被导入到新创建实例中的对象,它包含的值有函数、WebAssembly.Memory对象等等。编译的模块中,对于每一个导入的值都要有一个与其匹配的属性与之相对应,否则将会抛出WebAssembly.LinkError。
返回值
解析为包含两个字段的 ResultObject 的一个Promise:
module: 一个被编译好的WebAssembly.Module对象. 这个模块可以被再次实例化,通过 postMessage() 被分享,或者缓存到 IndexedDB。
instance: 一个包含所有 Exported WebAssembly functions的WebAssembly.Instance对象。
异常
- 如果参数的类型或结构不正确,将会抛出异常
TypeError.
- 如果操作失败,promise 将会被 reject 掉, 根据失败的原因不同,会抛出3种异常,
WebAssembly.CompileError,WebAssembly.LinkError, 或WebAssembly.RuntimeError。
第二种重载 — 使用模块对象
Promise<WebAssembly.Instance> WebAssembly.instantiate(module, importObject);参数
module将被实例化的WebAssembly.Module对象。importObject可选一个将被导入到新创建实例中的对象,它包含的值有函数、WebAssembly.Memory对象等等。编译的模块中,对于每一个导入的值都要有一个与其匹配的属性与之相对应,否则将会抛出WebAssembly.LinkError。
返回值
一个解析为WebAssembly.Instance的Promise 对象。
异常
- 如果参数的类型或结构不正确,将抛出异常
TypeError。
- 如果操作失败,promise 将会被 reject 掉, 根据失败的原因不同,会抛出3种异常,
WebAssembly.CompileError,WebAssembly.LinkError, 或WebAssembly.RuntimeError。
示例
第一种重载例子
使用 fetch 获取一些 WebAssembly 二进制代码后,我们使用WebAssembly.instantiate() 方法编译并实例化模块,在此过程中,导入了一个 Javascript 方法在 WebAssembly 模块中, 接下来我们使用Instance 导出的Exported WebAssembly方法。
var importObject = {
imports: {
imported_func: function(arg) {
console.log(arg);
}
}
};
fetch('simple.wasm').then(response =>
response.arrayBuffer()
).then(bytes =>
WebAssembly.instantiate(bytes, importObject)
).then(result =>
result.instance.exports.exported_func()
);注: 查看GitHub(在线实例)的 index.html 中一个相似的例子,使用了我们的fetchAndInstantiate()库函数
第二种重载例子
下面的例子(查看我们GitHub的index-compile.html 例子,可在线演示)使用 compile()方法编译了 simple.wasm 字节码,然后通过postMessage() 发送给一个线程 worker。
var worker = new Worker("wasm_worker.js");
fetch('simple.wasm').then(response =>
response.arrayBuffer()
).then(bytes =>
WebAssembly.compile(bytes)
).then(mod =>
worker.postMessage(mod)
);在线程中 (查看 wasm_worker.js) 我们定义了一个导入对象供模块使用,然后设置了一个事件处理函数来接收主线程发来的模块。当模块被接收到后,我们使用WebAssembly.instantiate()方法创建一个实例并且调用它从内部导出的函数。
var importObject = {
imports: {
imported_func: function(arg) {
console.log(arg);
}
}
};
onmessage = function(e) {
console.log('module received from main thread');
var mod = e.data;
WebAssembly.instantiate(mod, importObject).then(function(instance) {
instance.exports.exported_func();
});
};规范
Specification | Status | Comment |
|---|---|---|
Web Assembly JavaScript APIThe definition of 'instantiate()' in that specification. | Draft | Initial draft definition. |
浏览器兼容性
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
Basic Support | 57 | 16 | 522 | No | 44 | 11 |
Feature | Android | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
|---|---|---|---|---|---|---|---|
Basic Support | 57 | 57 | (Yes)1 | 522 | No | ? | 11 |
本文档系腾讯云开发者社区成员共同维护,如有问题请联系 cloudcommunity@tencent.com

