From 274cabd88260ecfee8882bb7d92f8ec34110e334 Mon Sep 17 00:00:00 2001 From: ruanyf Date: Fri, 6 Jul 2018 18:04:31 +0800 Subject: [PATCH 001/345] docs(bom): edit URL.createObjectURL --- docs/bom/location.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/bom/location.md b/docs/bom/location.md index d33d96d..0052744 100644 --- a/docs/bom/location.md +++ b/docs/bom/location.md @@ -306,6 +306,12 @@ function handleFiles(files) { 上面代码中,`URL.createObjectURL`方法用来为上传的文件生成一个 URL 字符串,作为``元素的图片来源。 +该方法生成的 URL 就像下面的样子。 + +```javascript +blob:http://localhost/c745ef73-ece9-46da-8f66-ebes574789b1 +``` + 注意,每次使用`URL.createObjectURL`方法,都会在内存里面生成一个 URL 实例。如果不再需要该方法生成的 URL 字符串,为了节省内存,可以使用`URL.revokeObjectURL()`方法释放这个实例。 **(2)URL.revokeObjectURL()** From 872c96b5d3eb1ea9e7f622d2bf6972ade82dcb51 Mon Sep 17 00:00:00 2001 From: ruanyf Date: Sun, 8 Jul 2018 14:51:26 +0800 Subject: [PATCH 002/345] docs(htmlapi): edit Web Worker --- chapters.yml | 1 + docs/bom/indexeddb.md | 2 +- docs/bom/webworker.md | 385 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 387 insertions(+), 1 deletion(-) create mode 100644 docs/bom/webworker.md diff --git a/chapters.yml b/chapters.yml index 3021ca9..4d53fe1 100644 --- a/chapters.yml +++ b/chapters.yml @@ -81,6 +81,7 @@ - bom/file.md: File 对象,FileList 对象,FileReader 对象 - bom/form.md: 表单,FormData 对象 - bom/indexeddb.md: IndexedDB API +- bom/webworker.md: Web Worker - elements/: 附录:网页元素接口 - elements/a.md: - elements/image.md: diff --git a/docs/bom/indexeddb.md b/docs/bom/indexeddb.md index ffbb06e..752f4f2 100644 --- a/docs/bom/indexeddb.md +++ b/docs/bom/indexeddb.md @@ -92,7 +92,7 @@ request.onerror = function (event) { }; ``` -**(2)`success` 事件** +**(2)success 事件** `success`事件表示成功打开数据库。 diff --git a/docs/bom/webworker.md b/docs/bom/webworker.md new file mode 100644 index 0000000..a9e0378 --- /dev/null +++ b/docs/bom/webworker.md @@ -0,0 +1,385 @@ +# Web Worker + +## 概述 + +JavaScript 语言采用的是单线程模型,也就是说,所有任务只能在一个线程上完成,一次只能做一件事。前面的任务没做完,后面的任务只能等着。随着电脑计算能力的增强,尤其是多核 CPU 的出现,单线程带来很大的不便,无法充分发挥计算机的计算能力。 + +Web Worker 的作用,就是为 JavaScript 创造多线程环境,允许主线程创建 Worker 线程,将一些任务分配给后者运行。在主线程运行的同时,Worker 线程在后台运行,两者互不干扰。等到 Worker 线程完成计算任务,再把结果返回给主线程。这样的好处是,一些计算密集型或高延迟的任务,被 Worker 线程负担了,主线程(通常负责 UI 交互)就会很流畅,不会被阻塞或拖慢。 + +Worker 线程一旦新建成功,就会始终运行,不会被主线程上的活动(比如用户点击按钮、提交表单)打断。这样有利于随时响应主线程的通信。但是,这也造成了 Worker 比较耗费资源,不应该过度使用,而且一旦使用完毕,就应该关闭。 + +Web Worker 有以下几个使用注意点。 + +(1)**同源限制** + +分配给 Worker 线程运行的脚本文件,必须与主线程的脚本文件同源。 + +(2)**DOM 限制** + +Worker 线程所在的全局对象,与主线程不一样,无法读取主线程所在网页的 DOM 对象,也无法使用`document`、`window`、`parent`这些对象。但是,Worker 线程可以`navigator`对象和`location`对象。 + +(3)**通信联系** + +Worker 线程和主线程不在同一个上下文环境,它们不能直接通信,必须通过消息完成。 + +(4)**脚本限制** + +Worker 线程不能执行`alert()`方法和`confirm()`方法,但可以使用 XMLHttpRequest 对象发出 AJAX 请求。 + +(5)**文件限制** + +Worker 线程无法读取本地文件,即不能打开本机的文件系统(`file://`),它所加载的脚本,必须来自网络。 + +## 基本用法 + +### 主线程 + +主线程采用`new`命令,调用`Worker()`构造函数,新建一个 Worker 线程。 + +```javascript +var worker = new Worker('work.js'); +``` + +`Worker()`构造函数的参数是一个脚本文件,该文件就是 Worker 线程所要执行的任务。由于 Worker 不能读取本地文件,所以这个脚本必须来自网络。如果下载没有成功(比如404错误),Worker 就会默默地失败。 + +然后,主线程调用`worker.postMessage()`方法,向 Worker 发消息。 + +```javascript +worker.postMessage('Hello World'); +worker.postMessage({method: 'echo', args: ['Work']}); +``` + +`worker.postMessage()`方法的参数,就是主线程传给 Worker 的数据。它可以是各种数据类型,包括二进制数据。 + +接着,主线程通过`worker.onmessage`指定监听函数,接收子线程发回来的消息。 + +```javascript +worker.onmessage = function (event) { + console.log('Received message ' + event.data); + doSomething(); +} + +function doSomething() { + // 执行任务 + worker.postMessage('Work done!'); +} +``` + +上面代码中,事件对象的`data`属性可以获取 Worker 发来的数据。 + +Worker 完成任务以后,主线程就可以把它关掉。 + +```javascript +worker.terminate(); +``` + +### Worker 线程 + +Worker 线程内部需要有一个监听函数,监听`message`事件。 + +```javascript +self.addEventListener('message', function (e) { + self.postMessage('You said: ' + e.data); +}, false); +``` + +上面代码中,`self`代表子线程自身,即子线程的全局对象。因此,等同于下面两种写法。 + +```javascript +// 写法一 +this.addEventListener('message', function (e) { + this.postMessage('You said: ' + e.data); +}, false); + +// 写法二 +addEventListener('message', function (e) { + postMessage('You said: ' + e.data); +}, false); +``` + +除了使用`self.addEventListener()`指定监听函数,也可以使用`self.onmessage`指定。监听函数的参数是一个事件对象,它的`data`属性包含主线程发来的数据。`self.postMessage()`方法用来向主线程发送消息。 + +根据主线程发来的数据,Worker 线程可以调用不同的方法,下面是一个例子。 + +```javascript +self.addEventListener('message', function (e) { + var data = e.data; + switch (data.cmd) { + case 'start': + self.postMessage('WORKER STARTED: ' + data.msg); + break; + case 'stop': + self.postMessage('WORKER STOPPED: ' + data.msg); + self.close(); // Terminates the worker. + break; + default: + self.postMessage('Unknown command: ' + data.msg); + }; +}, false); +``` + +上面代码中,`self.close()`用于在 Worker 内部关闭自身。 + +### Worker 加载脚本 + +Worker 内部如果要加载其他脚本,有一个专门的方法`importScripts()`。 + +```javascript +importScripts('script1.js'); +``` + +该方法可以同时加载多个脚本。 + +```javascript +importScripts('script1.js', 'script2.js'); +``` + +### 错误处理 + +主线程可以监听 Worker 是否发生错误。如果发生错误,Worker 会触发主线程的`error`事件。 + +```javascript +worker.onerror(function (event) { + console.log([ + 'ERROR: Line ', e.lineno, ' in ', e.filename, ': ', e.message + ].join('')); +}); + +// 或者 +worker.addEventListener('error', function (event) { + // ... +}); +``` + +Worker 内部也可以监听`error`事件。 + +### 关闭 Worker + +使用完毕,为了节省系统资源,必须关闭 Worker。 + +```javascript +// 主线程 +worker.terminate(); + +// Worker 线程 +self.close(); +``` + +## 数据通信 + +前面说过,主线程与 Worker 之间的通信内容,可以是文本,也可以是对象。需要注意的是,这种通信是拷贝关系,即是传值而不是传址,Worker 对通信内容的修改,不会影响到主线程。事实上,浏览器内部的运行机制是,先将通信内容串行化,然后把串行化后的字符串发给 Worker,后者再将它还原。 + +主线程与 Worker 之间也可以交换二进制数据,比如 File、Blob、ArrayBuffer 等类型,也可以在线程之间发送。下面是一个例子。 + +```javascript +// 主线程 +var uInt8Array = new Uint8Array(new ArrayBuffer(10)); +for (var i = 0; i < uInt8Array.length; ++i) { + uInt8Array[i] = i * 2; // [0, 2, 4, 6, 8,...] +} +worker.postMessage(uInt8Array); + +// Worker 线程 +self.onmessage = function (e) { + var uInt8Array = e.data; + postMessage('Inside worker.js: uInt8Array.toString() = ' + uInt8Array.toString()); + postMessage('Inside worker.js: uInt8Array.byteLength = ' + uInt8Array.byteLength); +}; +``` + +但是,拷贝方式发送二进制数据,会造成性能问题。比如,主线程向 Worker 发送一个 500MB 文件,默认情况下浏览器会生成一个原文件的拷贝。为了解决这个问题,JavaScript 允许主线程把二进制数据直接转移给子线程,但是一旦转移,主线程就无法再使用这些二进制数据了,这是为了防止出现多个线程同时修改数据的麻烦局面。这种转移数据的方法,叫做[Transferable Objects](http://www.w3.org/html/wg/drafts/html/master/infrastructure.html#transferable-objects)。这使得主线程可以快速把数据交给 Worker,对于影像处理、声音处理、3D 运算等就非常方便了,不会产生性能负担。 + +如果要直接转移数据的控制权,就要使用下面的写法。 + +```javascript +// Transferable Objects 格式 +worker.postMessage(arrayBuffer, [arrayBuffer]); + +// 例子 +var ab = new ArrayBuffer(1); +worker.postMessage(ab, [ab]); +``` + +## 同页面的 Web Worker + +通常情况下,Worker 载入的是一个单独的 JavaScript 脚本文件,但是也可以载入与主线程在同一个网页的代码。 + +```html + + + + + +``` + +上面是一段嵌入网页的脚本,注意必须指定` ``` -` +``` + +注意,请求的脚本网址有一个`callback`参数(`?callback=bar`),用来告诉服务器,客户端的回调函数名称(`bar`)。 + +第二步,服务器收到请求后,拼接一个字符串,将 JSON 数据放在函数名里面,作为字符串返回(`bar({...})`)。 + +第三步,客户端会将服务器返回的字符串,作为代码解析,因为浏览器认为,这是` +``` + +上面代码中,`document.currentScript`就是`