前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Web Worker使用教程

Web Worker使用教程

作者头像
玖柒的小窝
修改2021-10-20 10:14:34
1.6K0
修改2021-10-20 10:14:34
举报
文章被收录于专栏:各类技术文章~各类技术文章~

1. 概述

JavaScript是单线程模型,所有的任务都只能在一个线程上完成,一次只能做一件事情。 Web Worker的作用就是为JavaScript创建多线程环境,允许主线程创建Worker线程,将一些任务分配给后者运行,两者互不干扰。等到Worker线程完成计算任务,再把结果返回给主线程。

优点:一些计算密集型或高延迟的任务,被Worker线程负担了,主线程(通常负责UI交互)就会很流畅,不会被阻塞或拖慢。

注意:Worker一旦新建成功,就会始终运行,不会被主线程的活动(比如按钮点击等)打断。有利于随时响应主线程的通讯,但是Worker比较耗费资源,不应该过度使用,一旦使用应该关闭

注意事项

(1) 同源限制:分配给Worker线程运行的脚本文件,必须与主线程的脚本文件同源

(2) DOM限制:Worker线程所在的全局对象,与主线程的不一样,无法读取主线程所在的网页的DOM对象,也无法使用documentwindownparent这些对象。但是,Worker线程可以获取navigatorlocation对象。

(3) 通信联系:Worker线程和主线程不在同一个上下文环境,它们不能直接通信,必须通过消息完成。

(4) 脚本限制:Worker线程不能执行alert()confirm(),但可以使用XMLHttpRequest对象发出Ajax请求

(5) 文件限制:Worker线程无法读取本地文件,即不能打开本机的文件系统 (file://),它所加载的脚本,必须来自网络

基本用法

1. 主线程

主线程采用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('Recevied message ' + event.data);
    doSomething();
}
function doSomething() {
    // 执行任务
    worker.postMessage('Work done!');
}
复制代码

Worker 完成任务以后,主线程就可以把它关掉

代码语言:javascript
复制
worker.terminate();
复制代码
2. Worker线程

Worker线程内部需要有一个监听函数,监听message事件。

代码语言:javascript
复制
// 写法一:
self.addEventListener('message', function(e) {
    this.postMessage('You said: ' + e.data);
}, false);

// 写法二:
addEventListener('message', function(e) {
    this.postMessage('You said: ' + e.data);
}, false);
复制代码

也可以根据主线程发过来的数据,worker线程可以调用不同的方法。

代码语言:javascript
复制
self.addEventListener('message', function(e) {
    var data = e.data;
    switch (data.cmd) {
        case 'start':
            self.postMessage('WORKER STARTER: ' + data.msg);
            break;
        case 'stop':
            self.postMessage('WORKED STOPED: ' + data.msg);
            self.close(); // Terminates the worker.
            break;
        default:
            self.postMessage('Unknown commandL ' + data.msg);
    }
}, false);
复制代码

上述代码中,self.close()用于Worker内部关闭自身监听

3. Worker加载脚本

Worker内部如果需要加载其他脚本,有一个专门的方法importScripts()

代码语言:javascript
复制
importScripts('script1.js);
// 同时加载多个脚本
importScripts('script1.js', 'script2.js');
复制代码
4. 错误处理

主线程可以监听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事件。

5. 关闭worker
代码语言:javascript
复制
// 主线程
worker.terminate();

// Worker 线程
self.close();
复制代码

数据通信

前面提及,主线程和worker之间的通信可以是文本,也可以是对象也可以是二进制数据【File、Blob、ArrayBuffer等类型】,但是这种关系是拷贝关系即是传值而不是传地址,worker对通信内容的修改,不应该到主线程。事实上,浏览器内部的运行机制是,先将通信内容串行化,然后把串行化后的字符发给worker,后者再将其还原。

代码语言:javascript
复制
// 主线程
var uInt8Array = new Uint8Array(new ArrayBuffer(10));
for (var i = 0; i < uInt8Array.length;  ++i) {
    uInt8Array[i] = i * 2;
}
worker.postMessage(uInt8Array);

// Worker 进程
self.onmesssage = 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。这使得主线程可以快速把数据交给 Worker,对于影像处理、声音处理、3D 运算等就非常方便了,不会产生性能负担。

如果要直接转移数据的控制权,就要使用下面的写法。

代码语言:javascript
复制
// Transferable Objects 格式
worker.postMessage(arrayBuffer, [arrayBuffer]);

// 例子
var ab = new ArrayBuffer(1);
worker.postMessage(ab, [ab]);
复制代码

同页面的Web Worker

通常请下,Worker载入的是一个单独的JavaScript脚本,但是也可以载入与主线程在同一个网页的代码。

代码语言:javascript
复制
<!DOCTYPE html>
  <body>
    <script id="worker" type="app/worker">
      addEventListener('message', function () {
        postMessage('some message');
      }, false);
    </script>
  </body>
</html>
复制代码

上面是一段嵌入网页的脚本,注意必须指定script标签的type属性是一个浏览器不认识的值,上例是app/worker。然后,读取这一段嵌入页面的脚本,用 Worker 来处理。

代码语言:javascript
复制
var blob = new Blob([document.querySelector('#worker').textContent]);
var url = window.URL.createObjectURL(blob);
var worker = new Worker(url);

worker.onmessage = function (e) {
  // e.data === 'some message'
};
复制代码

上面代码中,先将嵌入网页的脚本代码,转成一个二进制对象,然后为这个二进制对象生成 URL,再让 Worker 加载这个 URL。这样就做到了,主线程和 Worker 的代码都在同一个网页上面。

事例:worker 线程完成轮询

有时,浏览器需要轮询服务器状态,以便第一时间得知状态改变。这个工作可以放在 Worker 里面。

代码语言:javascript
复制
function createWorker(f) {
  var blob = new Blob(['(' + f.toString() +')()']);
  var url = window.URL.createObjectURL(blob);
  var worker = new Worker(url);
  return worker;
}

var pollingWorker = createWorker(function (e) {
  var cache;

  function compare(new, old) { ... };

  setInterval(function () {
    fetch('/my-api-endpoint').then(function (res) {
      var data = res.json();

      if (!compare(data, cache)) {
        cache = data;
        self.postMessage(data);
      }
    })
  }, 1000)
});

pollingWorker.onmessage = function () {
  // render data
}

pollingWorker.postMessage('init');

复制代码

上面代码中,Worker 每秒钟轮询一次数据,然后跟缓存做比较。如果不一致,就说明服务端有了新的变化,因此就要通知主线程。

实例:Worker新建Worker

Worker 线程内部还能再新建 Worker 线程(目前只有 Firefox 浏览器支持)。下面的例子是将一个计算密集的任务,分配到10个 Worker。

主线程代码如下。

代码语言:javascript
复制
var worker = new Worker('worker.js');
worker.onmessage = function (event) {
  document.getElementById('result').textContent = event.data;
};
复制代码

Worker 线程代码如下。

代码语言:javascript
复制
// worker.js

// settings
var num_workers = 10;
var items_per_worker = 1000000;

// start the workers
var result = 0;
var pending_workers = num_workers;
for (var i = 0; i < num_workers; i += 1) {
  var worker = new Worker('core.js');
  worker.postMessage(i * items_per_worker);
  worker.postMessage((i + 1) * items_per_worker);
  worker.onmessage = storeResult;
}

// handle the results
function storeResult(event) {
  result += event.data;
  pending_workers -= 1;
  if (pending_workers <= 0)
    postMessage(result); // finished!
}
复制代码

上面代码中,Worker 线程内部新建了10个 Worker 线程,并且依次向这10个 Worker 发送消息,告知了计算的起点和终点。计算任务脚本的代码如下。

代码语言:javascript
复制
// core.js
var start;
onmessage = getStart;
function getStart(event) {
  start = event.data;
  onmessage = getEnd;
}

var end;
function getEnd(event) {
  end = event.data;
  onmessage = null;
  work();
}

function work() {
  var result = 0;
  for (var i = start; i < end; i += 1) {
    // perform some complex calculation here
    result += 1;
  }
  postMessage(result);
  close();
}
复制代码

API

1. 主线程

浏览器原生提供Worker()构造函数,用来供主线程生成Worker线程。

代码语言:javascript
复制
var myWorker = new Worker(jsUrk, options);
复制代码

Worker()构造函数,可以接受两个参数。第一个参数是脚本的网址(必须是同源),该参数是必须的,且只能加载JS脚本,否则会报错。第二个参数是配置对象,该对象可选,它的一个作用就是指定Worker的名称,用来区分多个Worker线程。

代码语言:javascript
复制
// 主线程
var myWorker = new Worker('worker.js', { name : 'myWorker' });

// Worker 线程
self.name // myWorker
复制代码

Worker()构造函数返回一个 Worker 线程对象,用来供主线程操作 Worker。Worker 线程对象的属性和方法如下。

代码语言:javascript
复制
-   Worker.onerror:指定 error 事件的监听函数。
-   Worker.onmessage:指定 message 事件的监听函数,发送过来的数据在`Event.data`属性中。
-   Worker.onmessageerror:指定 messageerror 事件的监听函数。发送的数据无法序列化成字符串时,会触发这个事件。
-   Worker.postMessage():向 Worker 线程发送消息。
-   Worker.terminate():立即终止 Worker 线程。
复制代码

Worker 线程

Web Worker 有自己的全局对象,不是主线程的window,而是一个专门为 Worker 定制的全局对象。因此定义在window上面的对象和方法不是全部都可以使用。 Worker 线程有一些自己的全局属性和方法。

代码语言:javascript
复制
-   self.name: Worker 的名字。该属性只读,由构造函数指定。
-   self.onmessage:指定`message`事件的监听函数。
-   self.onmessageerror:指定 messageerror 事件的监听函数。发送的数据无法序列化成字符串时,会触发这个事件。
-   self.close():关闭 Worker 线程。
-   self.postMessage():向产生这个 Worker 线程发送消息。
-   self.importScripts():加载 JS 脚本。

本文系转载,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文系转载前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1. 概述
    • 注意事项
    • 基本用法
      • 1. 主线程
        • 2. Worker线程
          • 3. Worker加载脚本
            • 4. 错误处理
              • 5. 关闭worker
              • 数据通信
              • 同页面的Web Worker
              • 事例:worker 线程完成轮询
              • 实例:Worker新建Worker
              • API
                • 1. 主线程
                  • Worker 线程
                  领券
                  问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档