vue-class-setup 编写 class 风格组合式API

目录

• 前言
• 诞生想法
• 快速开始
• 最佳实践
• 多个类实例
• PassOnTo
• Watch
• defineExpose
• 为什么使用 class ？
• 最后

前言

我司基于vue-class-component开发的项目有上百个，其中部署的 SSR 服务也接近100个，如此庞大体量的项目一开始的时候还幻想着看看是否要升级Vue3，结果调研一番下来，才发现vue-class-component对Vue3的支持，最后一个版本发布都过去两年了，迟迟还没有发布正式版本。目前基本上处于无人维护的状态，而且升级存在着大量的破坏性更新，对于未来是否还要继续使用Vue3现在还是持保留意见，但是不妨碍我们先把组件库做成Vue2和Vue3通用，于是就有了本文。

在过去的三年里，vue-class-component最大的问题是就是无法正确的校验组件的传参，事件类型，这给我带来了巨大的阴影，在经过一番调研后，惊喜的发现使用defineComponent定义的组件，在Vue2.7和3.x都可以正确的识别类型，所以先计划内部的组件库先做到同时支持Vue2和Vue3，如果后面还要继续采用Vue3就变得容易得多。

于是，回到了开头，调研了一番vue-class-component在Vue3的支持，目前最新的版本是8.0.0-rc.1，结果大失所望，目前基本上处于无人维护的状态，社区内又没有一个能满足我需求的，同时支持Vue2和Vue3的。

诞生想法

鉴于vue-class-component组件目前无法做到正确的组件类型检验，当我惊喜的发现组合式API写出来的代码可以被正确的识别类型时，诞生了一个使用 class 风格来编写组合式API的想法，于是花费一个月的实践，踩遍了所有的坑，终于诞生了vue-class-setup，一个使用 class 风格来编写代码的库，它gzip压缩后，1kb大小。

快速开始

npm install vue-class-setup

尝试多很多种方案，最终采用了上面的形式为最佳实践，它无法做到export default直接导出一个类，必须使用defineComponent 来包装一层，因为它只是一个组合类（API），并非是一个组件。

最佳实践

多个类实例

在一些复杂的业务时，有时需要多个实例

PassOnTo

在类实例准备就绪后，PassOnTo 装饰器，会将对应的函数，传递给回调，这样我们就可以顺利的和 onMounted 等钩子一起配合使用了

import { onMounted } from 'vue';
@Setup
class App extends Define {
    @PassOnTo(onMounted)
    public onMounted() {}
}

Watch

在使用 vue-property-decorator 的 Watch 装饰器时，他会接收一个字符串类型，它不能正确的识别类实例是否存在这个字段，但是现在 vue-class-setup 能检查你的类型是否正确，如果传入一个类实例不存在的字段，类型将会报错

defineExpose

在一些场景，我们希望可以暴露组件的一些方法和属性，那么就需要使用 defineExpose 编译宏来定义导出了，所以提供了一个.use的类静态方法帮你获取当前注入的类实例

为什么使用 class ？

其实不太想讨论这个问题，喜欢的自然会喜欢，不喜欢的自然会不喜欢，世上本无路，走的人多了，就有了路。

最后

不管是 选项 API 还是 组合式API，代码都是人写出来的，别人都说 Vue 无法胜任大型项目，但是在我司的实践中经受住了实践，基本上没有产生那种数千行的组件代码。

如果喜欢使用 class 风格来编写代码的，不妨来关注一下

• vue-class-setup

如果你的业务复杂，需要使用 SSR 和微服务架构，不妨也关注一下

• vue-genesis

以上就是vue-class-setup 编写 class 风格组合式API的详细内容，更多关于vue-class-setup 编写组合式API的资料请关注脚本之家其它相关文章！