欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

在 Typescript 中使用可被复用的 Vue Mixin功能

程序员文章站 2022-05-01 17:52:18
转到用 typescript 写 vue 应用以后,经过一轮工具链和依赖的洗礼,总算蹒跚地能走起来了,不过有一个很常用的功能 mixin,似乎还没有官方的解决方案。 既想...

转到用 typescript 写 vue 应用以后,经过一轮工具链和依赖的洗礼,总算蹒跚地能走起来了,不过有一个很常用的功能 mixin,似乎还没有官方的解决方案。

既想享受 mixin 的灵活和方便,又想收获 ts 的类型系统带来的安全保障和开发时使用 intellisense 的顺滑体验。

vuejs 官方组织里有一个 'vue-class-component' 以及连带推荐的 'vue-property-decorator',都没有相应实现。翻了下前者的 issue,有一条挂了好些时间的待做 feature 就是 mixin 的支持。

也不是什么复杂的事,自己写一个吧。

后注:vue-class-component 6.2.0 开始提供 mixins 方法,和本文的实现思路相似。

实现

import vue, { vueconstructor } from 'vue'
export type vclass<t> = {
 new(): t
} & pick<vueconstructor, keyof vueconstructor>
/**
 * mixins for class style vue component
 */
function mixins<a>(c: vclass<a>): vclass<a>
function mixins<a, b>(c: vclass<a>, c1: vclass<b>): vclass<a&b>
function mixins<a, b, c>(c: vclass<a>, c1: vclass<b>, c2: vclass<c>): vclass<a&b&c>
function mixins<t>(c: vclass<t>, ...traits: array<vclass<t>>): vclass<t> {
 return c.extend({
  mixins: traits
 })
}

声明 vclass<t> 可作为 t 的类构造器。同时通过 pick 拿到 vue 的构造器上的静态方法(extend/mixin 之类),如此才能够支持下面这段中的真正实现,通过调用一个 vue 的子类构造器上的 extend 方法生成新的子类构造器。

function mixins<t>(c: vclass<t>, ...traits: array<vclass<t>>): vclass<t> {
 return c.extend({
  mixins: traits
 })
}

至于 abc 这个纯粹是类型声明的体力活了。

使用

实际使用时:

import { component, vue } from 'vue-property-decorator'
import { mixins } from '../../util/mixins'
@component
class pagemixin extends vue {
 title = 'test page'
 redirectto(path: string) {
  console.log('calling reidrectto', path)
  this.$router.push({ path })
 }
}
interface idisposable {
 dispose(...args: any[]): any
}
class disposablemixin extends vue {
 _disposables: idisposable[]
 created() {
  console.log('disposable mixin created');
  this._disposables = []
 }
 beforedestroy() {
  console.log('about to clear disposables')
  this._disposables.map((d) => {
   d.dispose()
  })
  delete this._disposables
 }
 registerdisposable(d: idisposable) {
  this._disposables.push(d)
 }
}
@component({
 template: `
 <div>
  <h1>{{ title }}</h1>
  <p>counted: {{ counter }}</p>
 </div>
 `
})
export default class timerpage extends mixins(pagemixin, disposablemixin) {
 counter = 0
 mounted() {
  const timer = setinterval(() => {
   if (this.counter++ >= 3) {
    return this.redirectto('/otherpage')
   }
   console.log('count to', this.counter);
  }, 1000)

  this.registerdisposable({
   dispose() {
    clearinterval(timer)
   }
  })
 }
}
count to 1
count to 2
count to 3
calling reidrectto /otherpage
about to clear disposables

注意到直接 extends vue 的 disposablemixin 并不是一个有效的 vue 组件,也不可以直接在 mixins 选项里使用,如果要被以 vue.extend 方式扩展的自定义组件使用,记住使用 component 包装一层。

const extendedcomponent = vue.extend({
 name: 'extendedcomponent',
 mixins: [component(disposablemixin)],
})

abstract class

在业务系统中会使用到的 mixin 其实多数情况下会更复杂,提供一些基础功能,但有些部分需要留给继承者自行实现,这个时候使用抽象类就很合适。

abstract class abstractmusicplayer extends vue {
 abstract audiosrc: string
 playing = false
 toggleplay() {
  this.playing = !this.playing
 }
}
class musicplayera extends abstractmusicplayer {
 audiosrc = '/audio-a.mp3'
}
class musicplayerb extends abstractmusicplayer {
 staticbase = '/statics'
 get audiosrc() {
  return `${this.staticbase}/audio-b.mp3`
 }
}

但抽象类是无法被实例化的,并不满足 { new(): t } 这个要求,因此只能被继承,而不能被混入,由于同样的原因,抽象类也无法被 'vue-class-component' 的 component 函数装饰。

这时候只好将实现了的功能写入 mixin 中,待实现的功能放到接口里,让具体类来实现。

interface imusicsourceprovider {
 audiosrc: string
}
/**
 * @implements iplayerimplementation
 */
class playermixin extends vue {
 /** @abstract */
 audiosrc: string
 logsrc() {
  console.log(this.audiosrc)
 }
}
interface iplayerimplementation extends imusicsourceprovider {}
class realplayer extends mixins(playermixin) implements iplayerimplementation {
 audiosrc = '/audio-c.mp3'
}

这种欺骗编译器的方式其实还是比较拙劣的,如果一个具体类继承了 playermixin,却没有显示声明实现 iplayerimplementation ,编译器无法告诉你这个错误。我们只能在代码里小心翼翼写上注释,期待使用者不要忘了这件事。

总结

以上所述是小编给大家介绍的在 typescript 中使用可被复用的 vue mixin功能,希望对大家有所帮助