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

网友投稿 371 2023-02-08


在 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 = {

new(): T

} & Pick

/**

* mixins for class style vue component

*/

function Mixins(c: VMXsuWClass): VClass

function Mixins(c: VClass, c1: VClass): VClass

function Mixins(c: VClass, c1: VClass, c2: VClass): VClass

function Mixins(c: VClass, ...traits: Array>): VClass {

return c.extend({

mixins: traits

})

}

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

function Mixins(c: VClass, ...traits: Array): VClass {

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: `

Counted: {{ counter }}

`

})

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 reidrecMXsuWtTo /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 MusicMXsuWPlayerB 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功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,会及时回复大家的。在此也非常感谢大家对我们网站的支持!


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:vue双向数据绑定知识点总结
下一篇:笔记本怎样连接共享文件夹(笔记本怎样连接共享文件夹打印)
相关文章

 发表评论

暂时没有评论,来抢沙发吧~