选项式 API 和组合式 API的区别

Posted 2023-04-09 新时代的打工人

Vue 的组件可以按选项式 API 和组合式 API两种不同的风格书写。

选项式 API (Options API)
选项式 API，可以用包含多个选项的对象来描述组件的逻辑，例如 data、methods 和 mounted。选项所定义的属性都会暴露在函数内部的 this 上，它会指向当前的组件实例。

组合式 API (Composition API)
组合式 API，可以使用导入的 API 函数来描述组件逻辑，是一系列 API 的集合，可以使用函数的方式书写 Vue 组件。
组合式 API 的风格是基于函数的组合，但组合式 API 并不是函数式编程。组合式 API 是以 Vue 中数据可变的、细粒度的响应性系统为基础的，而函数式编程通常强调数据不可变。
在单文件组件中，组合式 API 通常会与 <script setup> 搭配使用。这个 setup attribute 是一个标识，告诉 Vue 需要在编译时进行一些处理，让我们可以更简洁地使用组合式 API。比如，<script setup> 中的导入和顶层变量/函数都能够在模板中直接使用。

两种 API 风格都能够覆盖大部分的应用场景。它们只是同一个底层系统所提供的两套不同的接口。实际上，选项式 API 是在组合式 API 的基础上实现的。

选项式 API 易于学习和使用（写代码的位置已经约定好了）。缺点是，代码组织性差，相似的逻辑代码不便于复用，逻辑复杂、代码多了不好阅读。虽然提供了 mixins 用来封装逻辑，但是出现数据函数覆盖的概率很大，不好维护。

组合式 API的学习成本可能会增加，需要良好的代码组织能力和拆分逻辑能力。优点是：

1. 提供了更好的逻辑复用：能够通过“组合函数”来实现更加简洁高效的逻辑复用。“组合式函数”（-Composables） 是一个利用 Vue 的组合式 API 来封装和复用有状态逻辑的函数。
2. 具有更灵活的代码组织：与同一个逻辑关注点相关的代码可以放在一起，不需要再为了一个逻辑关注点在不同的选项块间来回滚动切换。随时将功能的一部分拆分出去。
3. 具有更好的类型推导
4. 可生成更小的生产包体积：由于 <script setup> 形式书写的组件模板被编译为了一个内联函数，和 <script setup> 中的代码位于同一作用域。不像选项式 API 需要依赖 this 上下文对象访问属性，被编译的模板可以直接访问 <script setup> 中定义的变量，无需一个代码实例从中代理。这对代码压缩更友好，因为本地变量的名字可以被压缩，但对象的属性名则不能。

可以在一个选项式 API 的组件中通过 setup() 选项来使用组合式 API。然而，只推荐在一个已经基于选项式 API 开发了很久、但又需要和基于组合式 API 的新代码或是第三方库整合的项目中这样做。

Vue3 组合式 API 的基础 —— setup

参考技术A

组合式 API 基础 - Vue3中文文档
Setup - Vue3中文文档

setup 是一个组件选项，所以像别的组件选项一样，写在组件导出的对象里。

官方文档如此描述：
setup 选项应该是一个接受 props 和 context 的函数。
此外，我们从 setup 返回的所有内容都将暴露给组件的其余部分 (计算属性、方法、生命周期钩子等等) 以及组件的模板。

个人觉得可以理解为：

正如在一个标准组件中所期望的那样， setup 函数中的 props 是响应式的，当传入新的 prop 时，它将被更新。

context 上下文是一个普通的 JavaScript 对象，它暴露三个组件的 property：

context 是一个普通的 JavaScript 对象，也就是说，它不是响应式的，这意味着你可以安全地对 context 使用 ES6 解构。

attrs 和 slots 是有状态的对象，它们总是会随组件本身的更新而更新。这意味着你应该避免对它们进行解构，并始终以 attrs.x 或 slots.x 的方式引用 property。请注意，与 props 不同， attrs 和 slots 是非响应式的。如果你打算根据 attrs 或 slots 更改应用副作用，那么应该在 onUpdated 生命周期钩子中执行此操作。

如果 setup 返回一个对象，则可以在组件的模板中像传递给 setup 的 props property 一样访问该对象的 property：

setup 还可以返回一个渲染函数，该函数可以直接使用在同一作用域中声明的响应式状态：

新的 setup 组件选项在 创建组件之前 执行，一旦 props 被解析，并充当合成 API 的入口点。

在 setup() 内部， this 不会是该活跃实例的引用，因为 setup() 是在解析其它组件选项之前被调用的，所以 setup() 内部的 this 的行为与其它选项中的 this 完全不同。这在和其它选项式 API 一起使用 setup() 时可能会导致混淆。

reactive() 接收一个普通对象然后返回该普通对象的响应式代理。等同于 2.x 的 Vue.observable()

响应式转换是“深层的”：会影响对象内部所有嵌套的属性。基于 ES2015 的 Proxy 实现，返回的代理对象 不等于 原始对象。建议仅使用代理对象而避免依赖原始对象。

接受一个参数值并返回一个响应式且可改变的 ref 对象。ref 对象拥有一个指向内部值的单一属性 .value 。

如果传入 ref 的是一个对象，将调用 reactive 方法进行深层响应转换。

使用响应式 computed API 有两种方式：

传入一个对象（响应式或普通）或 ref，返回一个原始对象的 只读 代理。一个只读的代理是“深层的”，对象内部任何嵌套的属性也都是只读的。

立即执行传入的一个函数，并响应式追踪其依赖，并在其依赖变更时重新运行该函数。

当 watchEffect 在组件的 setup() 函数或生命周期钩子被调用时， 侦听器会被链接到该组件的生命周期，并在组件卸载时自动停止。

在一些情况下，也可以显式调用返回值以停止侦听：

有时副作用函数会执行一些异步的副作用, 这些响应需要在其失效时清除（即完成之前状态已改变了）。所以侦听副作用传入的函数可以接收一个 onInvalidate 函数作入参, 用来注册清理失效时的回调。当以下情况发生时，这个 失效回调 会被触发:

我们之所以是通过传入一个函数去注册失效回调，而不是从回调返回它（如 React useEffect 中的方式），是因为返回值对于异步错误处理很重要。

在执行数据请求时，副作用函数往往是一个异步函数：

我们知道异步函数都会隐式地返回一个 Promise，但是清理函数必须要在 Promise 被 resolve 之前被注册。另外，Vue 依赖这个返回的 Promise 来自动处理 Promise 链上的潜在错误。

Vue 的响应式系统会缓存副作用函数，并异步地刷新它们，这样可以避免同一个 tick 中多个状态改变导致的不必要的重复调用。在核心的具体实现中, 组件的更新函数也是一个被侦听的副作用。当一个用户定义的副作用函数进入队列时, 会在所有的组件更新后执行：

在这个例子中：

请注意，初始化运行是在组件 mounted 之前执行的。因此，如果你希望在编写副作用函数时访问 DOM（或模板 ref），请在 onMounted 钩子中进行：

如果副作用需要同步或在组件更新之前重新运行，我们可以传递一个拥有 flush 属性的对象作为选项（默认为 \'post\' ）：

onTrack 和 onTrigger 选项可用于调试一个侦听器的行为。

这两个回调都将接收到一个包含有关所依赖项信息的调试器事件。建议在以下回调中编写 debugger 语句来检查依赖关系：

onTrack 和 onTrigger 仅在开发模式下生效。

watch API 完全等效于 2.x this.$watch （以及 watch 中相应的选项）。 watch 需要侦听特定的数据源，并在回调函数中执行副作用。默认情况是懒执行的，也就是说仅在侦听的源变更时才执行回调。

可以直接导入 onXXX 一族的函数来注册生命周期钩子：