vue-worker：在vue中方便使用web worker-唐霜

因为公司的项目里面有一种case可以用w【本文首发于唐霜的博客】未经授权，禁止复制转载。orker来解决，所以决定尝试一下。本来转载请注明出处：www.tangshuang.net【关注微信公众号：wwwtangshuangnet】打算自己按照worker原理自己写一套，【未经授权禁止转载】【版权所有，侵权必究】结果一google发现了vue-work【转载请注明来源】本文作者：唐霜，转载请注明出处。er这个插件，简直戳中痛点，打算用它来实【作者：唐霜】【访问 www.tangshuang.net 获取更多精彩内容】现自己的需求。

著作权归作者所有，禁止商业用途转载。原创内容，盗版必究。【未经授权禁止转载】未经授权，禁止复制转载。

vue-worker把复杂的web wo【未经授权禁止转载】【访问 www.tangshuang.net 获取更多精彩内容】rker封装起来，提供一套非常简明的ap本文版权归作者所有，未经授权不得转载。【原创不易，请尊重版权】i接口，使用的时候可以说像不接触work原创内容，盗版必究。【本文首发于唐霜的博客】er一样方便。那么具体怎么使用呢？

【转载请注明来源】【访问 www.tangshuang.net 获取更多精彩内容】

安装

npm i -S vue-worker

注册

import Vue from 'vue'import VueWorker from 'vue-worker'import App from 'App.vue'
Vue.use(VueWorker)
new Vue({
   el: '#app',
  render: h => h(App) })

注册之后，你可以像this.$store原创内容，盗版必究。转载请注明出处：www.tangshuang.net一样使用this.$worker

使用

export default {
 name: 'worker-test', data() {
   return {
    worker: null,
   }
 },
 mounted() {
   // 通过this.$worker.run这个方法，跑起一个worker，
   // worker是在另外的线程里面跑的，所以可以在run的第一个参数函数里面执行一个非常大计算的操作
   // run方法像Promise一样提供.then和.catch，then的参数就是run第一个参数函数的返回值
   this.worker = this.$worker.run(n => n + 10, [2])
    .then(res => console.log(res))
    .catch(e => console.log(e)) }, destroyed() {
   // 通过赋值null的方式，释放掉worker引用，这样就可以关闭worker，这是作者在github上说的
   this.worker = null
 },
}

API介绍

下面来详细介绍一下vue-worker的【关注微信公众号：wwwtangshuangnet】【关注微信公众号：wwwtangshuangnet】几个api，也就是方法method。

.run(fun, […args])

上面已经看到了这个方法，而且也有注释说明【作者：唐霜】【作者：唐霜】。注意第二个参数是一个数组，数组的个数和【原创内容，转载请注明出处】【作者：唐霜】第一个参数fun的形参个数是一样的。
著作权归作者所有，禁止商业用途转载。你可能会有一个疑问：直接在fun函数体【关注微信公众号：wwwtangshuangnet】【作者：唐霜】内使用当前变量不就好了么？js本身的全局原创内容，盗版必究。【本文受版权保护】变量特性在这里不能用？这是因为worke【转载请注明来源】【作者：唐霜】r是在另外一个线程中运行，跟当前页面内的转载请注明出处：www.tangshuang.net原创内容，盗版必究。js脚本不是在同一个线程，不共享内存空间【版权所有，侵权必究】【作者：唐霜】，所以直接在fun函数体里面使用另外一个【版权所有，侵权必究】转载请注明出处：www.tangshuang.net线程的变量是找不到的，所以要通过函数参数【原创内容，转载请注明出处】【版权所有】唐霜 www.tangshuang.net的形式进行传递。而传递的实质，是使用了w【转载请注明来源】未经授权，禁止复制转载。orker的postMessage方法，原创内容，盗版必究。【版权所有】唐霜 www.tangshuang.net把第二个参数当做postMessage的【访问 www.tangshuang.net 获取更多精彩内容】【作者：唐霜】内容，具体你可以阅读这里的源码。

【原创内容，转载请注明出处】著作权归作者所有，禁止商业用途转载。【关注微信公众号：wwwtangshuangnet】

run是一次性的，跑完这次，worker【原创不易，请尊重版权】原创内容，盗版必究。线程就会被关掉。想要持久化worker，未经授权，禁止复制转载。【作者：唐霜】可以使用下面的create来创建。

【关注微信公众号：wwwtangshuangnet】转载请注明出处：www.tangshuang.net【原创内容，转载请注明出处】

.create([…actions])

这个方法让你创建一个worker对象（注原创内容，盗版必究。【转载请注明来源】意不是worker实例，你无法通过该对象未经授权，禁止复制转载。【关注微信公众号：wwwtangshuangnet】直接操作worker，这个实例仅仅是一个【原创不易，请尊重版权】【版权所有】唐霜 www.tangshuang.netjs object，提供了几个属性接口）【未经授权禁止转载】著作权归作者所有，禁止商业用途转载。。

著作权归作者所有，禁止商业用途转载。【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。未经授权，禁止复制转载。

actions是一个数组，数组的每个元素【原创不易，请尊重版权】【转载请注明来源】是一个含有两个属性的对象：

export default {
  name: 'worker-test',
  data() {
    return {
     worker: null,
    }
  },
  created() {
    this.worker = this.$worker.create([
      {
        message: 'pull-data',
        func(data) {
          data.forEach(...)
          return data
        },
      },
      {
        message: 'run-task',
        func(id) {
          //...
        },
      }
    ])
  },
  mounted() {
    let data = ...
    this.worker.postMessage('pull-data', [data])
      .then(res => console.log(res))
  },
  destroyed() {
    this.worker = null
  },
}

你可以看到，实际上.run方法是crea本文版权归作者所有，未经授权不得转载。【本文受版权保护】te方法和postMessage方法的合【未经授权禁止转载】【本文首发于唐霜的博客】体，一次性把两个方法的事都做了。

转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.net

.postMessage(messageid, […args])

这个在上面的代码里面已经演示了。它不是t本文作者：唐霜，转载请注明出处。著作权归作者所有，禁止商业用途转载。his.$worker的方法，而是通过t本文作者：唐霜，转载请注明出处。【原创内容，转载请注明出处】his.$worker.create之后【版权所有，侵权必究】本文作者：唐霜，转载请注明出处。得到的object的一个方法。使用这个方本文版权归作者所有，未经授权不得转载。原创内容，盗版必究。法跟worker原生的方法很像，当然，这【本文首发于唐霜的博客】【关注微信公众号：wwwtangshuangnet】里的messageid就是上面actio【转载请注明来源】【未经授权禁止转载】ns数组里面的某个对象的message字转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。段对应的那个。而args就是你要传递的数著作权归作者所有，禁止商业用途转载。【转载请注明来源】据。

【原创不易，请尊重版权】【原创不易，请尊重版权】原创内容，盗版必究。原创内容，盗版必究。

你可能又会问了，这里的[..args]是【本文首发于唐霜的博客】未经授权，禁止复制转载。一个参数，还是说里面的元素才是参数。其实转载请注明出处：www.tangshuang.net【未经授权禁止转载】很简单，[…args]被用作【访问 www.tangshuang.net 获取更多精彩内容】本文版权归作者所有，未经授权不得转载。了.apply的第二个参数：func.apply(null, [...args])，所以，…args对应的就是【原创不易，请尊重版权】未经授权，禁止复制转载。func的参数。

【访问 www.tangshuang.net 获取更多精彩内容】【原创不易，请尊重版权】

.postAll([…args])

这里的postAll和上面的postMe【转载请注明来源】【版权所有，侵权必究】ssage一样，是create之后的那个【版权所有，侵权必究】【原创内容，转载请注明出处】object的一个方法，而不是this.【关注微信公众号：wwwtangshuangnet】本文版权归作者所有，未经授权不得转载。$worker的，所以使用的时候，也只能【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】用在create之后。

【原创不易，请尊重版权】【作者：唐霜】

原创内容，盗版必究。著作权归作者所有，禁止商业用途转载。【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】

不传

【未经授权禁止转载】【未经授权禁止转载】

代表所有的actions都执行一次pos著作权归作者所有，禁止商业用途转载。本文作者：唐霜，转载请注明出处。tMessage。

著作权归作者所有，禁止商业用途转载。【转载请注明来源】【原创内容，转载请注明出处】本文版权归作者所有，未经授权不得转载。

[string:messageid]

[{message, […f【访问 www.tangshuang.net 获取更多精彩内容】原创内容，盗版必究。unc_args]}]

本文版权归作者所有，未经授权不得转载。【转载请注明来源】

给指定的messageid传参数。

转载请注明出处：www.tangshuang.net未经授权，禁止复制转载。

export default {
  name: 'worker-test',
  data() {
    return {
      worker: null,
    }
  },
  created() {
    this.worker = this.$worker.create([
      {
        message: 'pull-data',
        func(data) {
          data.forEach(...)
          return data
        },
      },
      {
        message: 'run-task',
        func() {
          //...
        },
      }
    ])
  },
  mounted() {
  
    // 1. 不传
    this.worker.postAll().then([res1, res2] => {})
  
    // 2. 字符串形式
    let data = ...
    this.worker.postAll(['run-task']).then([res] => {}) // 仅'run-task'被postMessage
  
    // 3. 对象形式（混合形式）
    this.worker.postAll([
      'run-task',
      {
        message: 'pull-data',
        args: [data],
      },
    ]).then([res1, res2] => {})
  },
  destroyed() {
    this.worker = null
  },
}

.register(action || […actions])

同理，也是在<worker>【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号：wwwtangshuangnet】的object对象上的方法。当你使用cr著作权归作者所有，禁止商业用途转载。【未经授权禁止转载】eate之后，发现你的worker任务不本文作者：唐霜，转载请注明出处。著作权归作者所有，禁止商业用途转载。够用，要追加一个action或多个，那么【版权所有，侵权必究】【原创不易，请尊重版权】可以使用register来追加。acti本文版权归作者所有，未经授权不得转载。【版权所有，侵权必究】on(s)和create是一模一样的。

.unregister(message || […messages])

和register有点像，意思是当你某一【未经授权禁止转载】转载请注明出处：www.tangshuang.net个任务不想要了，可以通过unregist【原创不易，请尊重版权】转载请注明出处：www.tangshuang.neter来取消这个任务。参数和registe【关注微信公众号：wwwtangshuangnet】未经授权，禁止复制转载。r不一样，直接使用messageid作为【未经授权禁止转载】未经授权，禁止复制转载。参数即可。

【作者：唐霜】本文版权归作者所有，未经授权不得转载。原创内容，盗版必究。

export default {
  name: 'worker-test',
  data() {
    return {
      worker: null,
    }
  },
  created() {
    this.worker = this.$worker.create([
      {
        message: 'pull-data',
        func(data) {
          data.forEach(...)
          return data
        },
      },
      {
        message: 'run-task',
        func() {
          //...
        },
      }
    ])
  },
  mounted() {
    // 1. 不传
    this.worker.postAll().then([res1, res2] => {})
  
    // 2. 字符串形式
    let data = ...
    this.worker.postAll(['run-task']).then([res] => {}) // 仅'run-task'被postMessage
  
    // 3. 对象形式（混合形式）
    this.worker.postAll([
      'run-task',
      {
        message: 'pull-data',
        args: [data],
      },
    ]).then([res1, res2] => {
      // 注意，这里then里面执行的是在主js线程里面执行的，所以可以直接用this.worker
      this.worker.unregister('run-task')
      // 当你注销掉了，那么下回你在post到run-task这个任务消息时，就啥都不会发生了
    })
  },
  destroyed() {
    this.worker = null
  },
}

关闭worker

在最前面的代码里面已经提到了，插件的作者原创内容，盗版必究。转载请注明出处：www.tangshuang.net指出，你是没办法拿到worker原始实例【转载请注明来源】【版权所有】唐霜 www.tangshuang.net的，所以也就无法调用worker.ter本文版权归作者所有，未经授权不得转载。【本文受版权保护】minate()或者在worker线程内【版权所有，侵权必究】【原创内容，转载请注明出处】部执行self.close()来关闭wo未经授权，禁止复制转载。【未经授权禁止转载】rker。create方法创建的不是wo【转载请注明来源】【转载请注明来源】rker实例，所以它内部有，但是没有暴露本文版权归作者所有，未经授权不得转载。【未经授权禁止转载】出来。所以插件没有关闭worker的方法转载请注明出处：www.tangshuang.net【本文首发于唐霜的博客】，你直接把worker对象释放掉即可。我未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。翻阅了源码，发现它只在调用run方法时才【本文首发于唐霜的博客】本文作者：唐霜，转载请注明出处。使用close，执行完run之后worker会被close，但是如果你使用create创建的wor【原创不易，请尊重版权】原创内容，盗版必究。ker，是不会被close的它会一直存在【关注微信公众号：wwwtangshuangnet】本文版权归作者所有，未经授权不得转载。，直到你关闭浏览器。

本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。

原理

web worker是通过一个浏览器提供转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。的Worker对象来创建的，创建的时候要转载请注明出处：www.tangshuang.net【本文首发于唐霜的博客】传入指定的javascript文件作为w【转载请注明来源】【访问 www.tangshuang.net 获取更多精彩内容】orker线程的执行脚本。worker线本文作者：唐霜，转载请注明出处。【作者：唐霜】程内的脚本有一些限制，比如只能拿到win【作者：唐霜】原创内容，盗版必究。dow.navigator的信息，不能拿本文作者：唐霜，转载请注明出处。【作者：唐霜】到完整的window对象。重点是，这里我【版权所有】唐霜 www.tangshuang.net原创内容，盗版必究。们没有提供一个js文件传入worker线【本文受版权保护】本文版权归作者所有，未经授权不得转载。程，vue-worker是怎么做到的呢？本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。它利用了Blob来创建一个可执行的二进制【本文受版权保护】【原创内容，转载请注明出处】上下文，在通过这个上下文来调用我们传入的未经授权，禁止复制转载。【作者：唐霜】function，就好像在内存中虚拟了一【转载请注明来源】【原创不易，请尊重版权】个内容是我们传入的function的js【版权所有，侵权必究】【本文受版权保护】文件一样。具体的源码可以看这里。

【本文首发于唐霜的博客】【本文首发于唐霜的博客】原创内容，盗版必究。

【关注微信公众号：wwwtangshuangnet】【原创内容，转载请注明出处】【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net【关注微信公众号：wwwtangshuangnet】本文版权归作者所有，未经授权不得转载。转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.net【原创内容，转载请注明出处】【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net原创内容，盗版必究。【作者：唐霜】【原创不易，请尊重版权】原创内容，盗版必究。未经授权，禁止复制转载。【原创内容，转载请注明出处】原创内容，盗版必究。未经授权，禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】【本文受版权保护】原创内容，盗版必究。原创内容，盗版必究。【版权所有，侵权必究】【版权所有】唐霜 www.tangshuang.net原创内容，盗版必究。【原创不易，请尊重版权】【作者：唐霜】未经授权，禁止复制转载。转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。【版权所有】唐霜 www.tangshuang.net原创内容，盗版必究。

2017-07-21 17451 vue, worker

唐霜

vue-worker：在vue中方便使用web worker

安装

注册

使用