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

因为公司的项目里面有一种case可以用w转载请注明出处：www.tangshuang.net著作权归作者所有，禁止商业用途转载。orker来解决，所以决定尝试一下。本来本文版权归作者所有，未经授权不得转载。著作权归作者所有，禁止商业用途转载。打算自己按照worker原理自己写一套，【转载请注明来源】转载请注明出处：www.tangshuang.net结果一google发现了vue-work【版权所有】唐霜 www.tangshuang.net【原创内容，转载请注明出处】er这个插件，简直戳中痛点，打算用它来实【原创不易，请尊重版权】转载请注明出处：www.tangshuang.net现自己的需求。

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

安装

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介绍

.run(fun, […args])

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

转载请注明出处：www.tangshua著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.netng.net【未经授权禁止转载】转载请注明出处：www.tangshua本文作者：唐霜，转载请注明出处。【本文首发于唐霜的博客】ng.net著作权归作者所有，禁止商业用途转载。

本文作者：唐霜，转载请注明出处。【本文受版权保护】著作权归作者所有，禁止商业用途转载。

.create([…actions])

这个方法让你创建一个worker对象（注【原创不易，请尊重版权】【关注微信公众号：wwwtangshuangnet】意不是worker实例，你无法通过该对象本文作者：唐霜，转载请注明出处。【版权所有】唐霜 www.tangshuang.net直接操作worker，这个实例仅仅是一个本文版权归作者所有，未经授权不得转载。【转载请注明来源】js object，提供了几个属性接口）本文作者：唐霜，转载请注明出处。【转载请注明来源】。

【访问 www.tangshuang.n原创内容，盗版必究。未经授权，禁止复制转载。et 获取更多精彩内容】原创内容，盗版必究。本文作者：唐霜，转载请注明出处。

actions是一个数组，数组的每个元素【访问 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(id) {
          //...
        },
      }
    ])
  },
  mounted() {
    let data = ...
    this.worker.postMessage('pull-data', [data])
      .then(res => console.log(res))
  },
  destroyed() {
    this.worker = null
  },
}

【原创内容，转载请注明出处】【未经授权禁止转载】

.postMessage(messageid, […args])

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

著作权归作者所有，禁止商业用途转载。原创内容，盗版必究。

你可能又会问了，这里的[..args]是【关注微信公众号：wwwtangshuangnet】【未经授权禁止转载】一个参数，还是说里面的元素才是参数。其实【版权所有，侵权必究】本文作者：唐霜，转载请注明出处。很简单，[…args]被用作【作者：唐霜】转载请注明出处：www.tangshuang.net了.apply的第二个参数：func.apply(null, [...args])，所以，…args对应的就是【版权所有】唐霜 www.tangshuang.net著作权归作者所有，禁止商业用途转载。func的参数。

【转载请注明来源】【转载请注明来源】【原创内容，转载请注明出处】

.postAll([…args])

这里的postAll和上面的postMe本文作者：唐霜，转载请注明出处。【本文受版权保护】ssage一样，是create之后的那个未经授权，禁止复制转载。未经授权，禁止复制转载。object的一个方法，而不是this.【未经授权禁止转载】【本文首发于唐霜的博客】$worker的，所以使用的时候，也只能【原创内容，转载请注明出处】【作者：唐霜】用在create之后。

【转载请注明来源】【访问 www.tangshuang.n未经授权，禁止复制转载。【本文受版权保护】et 获取更多精彩内容】【作者：唐霜】【转载请注明来源】

它的参数是一个数组，但是这个数组的元素有本文版权归作者所有，未经授权不得转载。转载请注明出处：www.tangshuang.net三种形式，一种是不传，一种是string【转载请注明来源】本文作者：唐霜，转载请注明出处。:messageid，另一种是{mess著作权归作者所有，禁止商业用途转载。本文作者：唐霜，转载请注明出处。age, […func_ar未经授权，禁止复制转载。【原创内容，转载请注明出处】gs]}。其实都很好理解。

不传

著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshua原创内容，盗版必究。未经授权，禁止复制转载。ng.net

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

[string:messageid]

代表对应的messageid的那个act【作者：唐霜】本文版权归作者所有，未经授权不得转载。ion被执行postMessage。

[{message, […f本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。unc_args]}]

给指定的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] => {})
  },
  destroyed() {
    this.worker = null
  },
}

比较难把握的就是，这里所有的传入都要采用未经授权，禁止复制转载。著作权归作者所有，禁止商业用途转载。数组的形式，理解上需要稍微思考下。

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

.register(action || […actions])

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

【本文首发于唐霜的博客】著作权归作者所有，禁止商业用途转载。本文版权归作者所有，未经授权不得转载。【访问 www.tangshuang.n转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.netet 获取更多精彩内容】

.unregister(message || […messages])

和register有点像，意思是当你某一转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。个任务不想要了，可以通过unregist【访问 www.tangshuang.net 获取更多精彩内容】本文作者：唐霜，转载请注明出处。er来取消这个任务。参数和registe【转载请注明来源】【作者：唐霜】r不一样，直接使用messageid作为原创内容，盗版必究。未经授权，禁止复制转载。参数即可。

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

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

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

【本文首发于唐霜的博客】未经授权，禁止复制转载。本文作者：唐霜，转载请注明出处。转载请注明出处：www.tangshua转载请注明出处：www.tangshuang.net本文版权归作者所有，未经授权不得转载。ng.net

原理

web worker是通过一个浏览器提供【版权所有】唐霜 www.tangshuang.net【原创内容，转载请注明出处】的Worker对象来创建的，创建的时候要转载请注明出处：www.tangshuang.net未经授权，禁止复制转载。传入指定的javascript文件作为w【本文受版权保护】【版权所有，侵权必究】orker线程的执行脚本。worker线【版权所有，侵权必究】著作权归作者所有，禁止商业用途转载。程内的脚本有一些限制，比如只能拿到win未经授权，禁止复制转载。【原创不易，请尊重版权】dow.navigator的信息，不能拿【关注微信公众号：wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net到完整的window对象。重点是，这里我转载请注明出处：www.tangshuang.net【关注微信公众号：wwwtangshuangnet】们没有提供一个js文件传入worker线【转载请注明来源】【作者：唐霜】程，vue-worker是怎么做到的呢？转载请注明出处：www.tangshuang.net【作者：唐霜】它利用了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 获取更多精彩内容】【本文首发于唐霜的博客】【关注微信公众号：wwwtangshuangnet】转载请注明出处：www.tangshuang.net转载请注明出处：www.tangshuang.net

2017-07-21 17200 vue, worker

唐霜

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

安装

注册

使用