Vue / 系统课时

实现异步校验

实现异步校验

本课为用户名字段接入可控的异步校验:输入停止后再请求服务端,编辑时排除当前记录,并用取消与序号机制阻止过期结果覆盖最新输入。

学习目标

  • 使用 Element Plus 自定义校验器返回异步结果
  • 为高频输入加入防抖与请求取消
  • 正确处理编辑回填和竞态结果

异步校验的关键问题

同步规则只检查长度、格式等本地条件;用户名是否已存在必须访问服务端。直接在每次输入时请求,会产生大量无效调用,还可能出现“后发请求先返回”的竞态。

编辑用户时,服务端查询必须携带当前记录 ID。这样原用户名属于当前用户时仍视为可用,而不是被误判为重复。

用户名异步校验时序

编写可取消的校验器

下面是可直接放入 Vue 3 与 Element Plus 项目的单文件组件。示例用本地函数模拟接口,实际项目只需替换 queryUsername。

vue
<script setup lang="ts">
import { nextTick, reactive, ref } from 'vue'
import type { FormInstance, FormRules } from 'element-plus'

interface UserRecord {
  id: string
  username: string
}

const formRef = ref<FormInstance>()
const form = reactive({ id: '', username: '' })
const records: UserRecord[] = [
  { id: 'u-1', username: 'admin' },
  { id: 'u-2', username: 'simon' }
]

const wait = (ms: number) =>
  new Promise<void>((resolve) => setTimeout(resolve, ms))

async function queryUsername(
  username: string,
  currentId: string,
  signal: AbortSignal
): Promise<boolean> {
  await wait(300)
  if (signal.aborted) throw new DOMException('aborted', 'AbortError')
  return !records.some(
    (item) => item.username === username && item.id !== currentId
  )
}

let timer: ReturnType<typeof setTimeout> | undefined
let controller: AbortController | undefined
let finishPrevious: (() => void) | undefined
let sequence = 0

function validateUsername(
  _rule: unknown,
  value: string
): Promise<void> {
  clearTimeout(timer)
  controller?.abort()
  finishPrevious?.()

  const currentSequence = ++sequence
  const currentController = new AbortController()
  controller = currentController

  return new Promise<void>((resolve, reject) => {
    finishPrevious = resolve

    timer = setTimeout(async () => {
      try {
        const available = await queryUsername(
          value.trim(),
          form.id,
          currentController.signal
        )

        // 只允许最新输入对应的结果更新字段状态
        if (currentSequence !== sequence || value !== form.username) {
          resolve()
          return
        }

        available ? resolve() : reject(new Error('用户名已存在'))
      } catch (error) {
        if (error instanceof DOMException && error.name === 'AbortError') {
          resolve()
          return
        }
        reject(new Error('校验服务暂时不可用'))
      }
    }, 400)
  })
}

const rules: FormRules = {
  username: [
    { required: true, message: '请输入用户名', trigger: 'blur' },
    { min: 3, max: 20, message: '长度应为 3~20 个字符', trigger: 'blur' },
    { validator: validateUsername, trigger: 'change' }
  ]
}

async function loadForEdit(): Promise<void> {
  const user = records[1]
  form.id = user.id
  form.username = user.username

  // 回填完成后清除初始化阶段产生的校验提示
  await nextTick()
  formRef.value?.clearValidate('username')
}

loadForEdit()
</script>

<template>
  <el-form ref="formRef" :model="form" :rules="rules" label-width="90px">
    <el-form-item label="用户名" prop="username">
      <el-input v-model="form.username" placeholder="请输入用户名" />
    </el-form-item>
  </el-form>
</template>

预期结果

text
初始回填 simon 时不显示重复错误。
连续输入时,仅最后一次输入在约 400ms 后执行校验。
输入 admin 时显示“用户名已存在”,输入 new-user 时校验通过。

实际接口建议返回明确的可用性结果,例如 { "available": true },不要依赖 404 或异常消息推断业务状态。

处理边界与提交校验

防抖只能减少请求,不能解决响应乱序;请求取消与序号检查应同时保留。网络失败也不能默认“校验通过”,否则提交阶段可能写入重复数据。

最终提交前应调用 formRef.validate() 再做一次完整校验。服务端仍必须设置唯一约束,并在保存接口中返回可识别的冲突错误,因为前端校验无法替代并发写入保护。

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

目录与阅读设置

阅读设置

17

记录一个想法

实现异步校验

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

登录哪都通