Vue / 系统课时

组合函数单元测试

组合函数单元测试

组合函数没有模板可点,测试重点应放在可观察状态和副作用:状态是否按规则变化、边界是否被限制、异步任务何时完成,以及作用域销毁后定时器等资源是否真正停止。下面用 Vitest 对一个带延迟更新的组合函数完成这四类验证。

学习目标

  • 使用 Vitest 直接测试 ref 暴露的响应式状态与边界条件
  • 用 fake timers 稳定验证延迟执行,避免真实等待造成慢测和偶发失败
  • 借助 effectScope 验证 onScopeDispose 注册的资源清理逻辑

先确定测试边界

组合函数的单元测试不需要挂载组件。只要它不依赖真实 DOM,就应直接调用函数并断言公开返回值。这样失败时能快速判断问题来自状态逻辑,而不是模板渲染或组件生命周期。

本例测试 useDelayedCounter:计数不能超过上限;同一时刻只允许一个延迟任务;调用方所在的 Vue 响应式作用域被销毁后,未执行的定时器必须取消。项目需已具备 Vue 3、TypeScript 与 Vitest。

实现可被独立观察的组合函数

下面是项目内片段示例,保存为 src/composables/useDelayedCounter.ts。它依赖 Vue 3 的响应式作用域,由后面的 Vitest 测试文件执行验证。

ts
import { onScopeDispose, ref } from 'vue'

export function useDelayedCounter(initial = 0, max = 3) {
  const safeMax = Math.max(0, max)
  const count = ref(Math.min(Math.max(0, initial), safeMax))
  const pending = ref(false)
  let timer: ReturnType<typeof setTimeout> | undefined

  const increment = (step = 1) => {
    // 负步长视为无效输入,同时把结果限制在最大值以内。
    count.value = Math.min(safeMax, count.value + Math.max(0, step))
  }

  const cancel = () => {
    if (timer !== undefined) clearTimeout(timer)
    timer = undefined
    pending.value = false
  }

  const incrementLater = (delayMs = 100) => {
    // 避免重复排队,也避免到达上限后继续创建无意义定时器。
    if (pending.value || count.value >= safeMax) return

    pending.value = true
    timer = setTimeout(() => {
      increment(1)
      pending.value = false
      timer = undefined
    }, Math.max(0, delayMs))
  }

  onScopeDispose(cancel)

  return { count, pending, increment, incrementLater, cancel }
}

这里刻意只暴露业务状态和操作,不暴露内部 timer。测试应通过 count、pending 和销毁后的行为确认资源是否清理,而不是绑定到实现细节。

验证状态、异步流程和清理

测试文件保存为 src/composables/useDelayedCounter.spec.ts。fake timers 让 1000 毫秒的逻辑时间瞬间推进;effectScope 则模拟组件 setup 所在的响应式作用域。

ts
import { effectScope } from 'vue'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { useDelayedCounter } from './useDelayedCounter'

describe('useDelayedCounter', () => {
  beforeEach(() => {
    vi.useFakeTimers()
  })

  afterEach(() => {
    vi.clearAllTimers()
    vi.useRealTimers()
  })

  it('限制同步更新的边界', () => {
    const scope = effectScope()
    const counter = scope.run(() => useDelayedCounter(2, 3))!

    counter.increment(10)
    expect(counter.count.value).toBe(3)

    counter.increment(-1)
    expect(counter.count.value).toBe(3)
    scope.stop()
  })

  it('只执行一个待处理的延迟更新', async () => {
    const scope = effectScope()
    const counter = scope.run(() => useDelayedCounter(0, 3))!

    counter.incrementLater(100)
    counter.incrementLater(100)
    expect(counter.pending.value).toBe(true)

    await vi.advanceTimersByTimeAsync(100)

    expect(counter.count.value).toBe(1)
    expect(counter.pending.value).toBe(false)
    scope.stop()
  })

  it('作用域销毁时取消未执行的任务', async () => {
    const scope = effectScope()
    const counter = scope.run(() => useDelayedCounter(0, 3))!

    counter.incrementLater(1000)
    scope.stop()

    expect(counter.pending.value).toBe(false)
    await vi.advanceTimersByTimeAsync(1000)
    expect(counter.count.value).toBe(0)
  })
})

运行这一份测试:

bash
npx vitest run src/composables/useDelayedCounter.spec.ts

预期输出中应出现 1 个测试文件、3 个测试全部通过;耗时等动态值会因机器而不同。

text
✓ src/composables/useDelayedCounter.spec.ts (3 tests)
Test Files  1 passed (1)
Tests  3 passed (3)

避免让测试依赖内部实现

如果测试直接检查私有定时器 ID、内部函数调用次数或某个临时变量,重构实现就可能导致测试无意义地失败。更稳妥的判断标准是:公开状态是否正确、重复调用是否被控制、时间推进后结果是否符合约定,以及作用域结束后是否还有副作用。

异步测试还要避免真实 setTimeout 等待。使用 fake timers 时,在每个测试后恢复真实计时器,防止后续用例继承伪造的时间环境。对组合函数而言,这种“公开行为 + 生命周期清理”的测试边界通常比追踪实现细节更耐维护。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

组合函数单元测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通