vue elementUI组件表单动态验证失效的问题与解决办法

本文介绍了在Vue项目中使用Element UI实现动态表单验证的方法。针对特定场景需求,通过不同尝试,最终找到有效解决方案,包括利用v-if和key属性强制重新渲染表单,以及动态修改rules对象或form-item的rules属性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一、缘由
在项目中,有一个需求是需要根据条件给表单项添加验证属性prop确定是否验证表项。

二、第一次实现与遇到的问题
比如银行卡号根据输入年龄进行判断,如果大于等于18岁才需要填入银行卡号。最先的想法先设置好el-form的rules,然后通过三元表达式赋值prop属性,实现动态验证,示例如下:

<template>
  <el-form ref="ruleForm" :model="formData" :rules="rules">
    <el-form-item label="名字" prop="name">
      <el-input v-model="formData.name"></el-input>
    </el-form-item>
    <el-form-item label="年龄" prop="age">
      <el-input v-model="formData.age"></el-input>
    </el-form-item>
    <el-form-item label="银行卡号" :prop="formData.age >= 18 ? 'bankCardNo' : ''">
      <el-input v-model="formData.bankCardNo"></el-input>
    </el-form-item>
  </el-form>
</template>
<script>
export default {
  name: 'HelloWorld',
 
  data () {
    return {
      rules: {
        name: [{ required: true, message: '请输入名字', trigger: 'blur' }],
        age: [{ required: true, message: '请输入年龄', trigger: 'blur' }],
        bankCardNo: [{ required: true, message: '请输入银行卡号', trigger: 'blur' }]
      },
      formData: {
        name: '',
        age: '',
        bankCardNo: ''
      }
    }
  }
}
</script>
但是发现虽然页面有了红色星号的验证提示,但实际上当失去焦点的时候并未触发校验,如图所示:

三、遇到问题的原因
所以去查阅了elementUI的官方文档,文档给出了一种动态添加表单项动态的验证的示例,示例代码如下:

<el-form :model="dynamicValidateForm" ref="dynamicValidateForm" label-width="100px" class="demo-dynamic">
  <el-form-item
    prop="email"
    label="邮箱"
    :rules="[
      { required: true, message: '请输入邮箱地址', trigger: 'blur' },
      { type: 'email', message: '请输入正确的邮箱地址', trigger: ['blur', 'change'] }
    ]"
  >
    <el-input v-model="dynamicValidateForm.email"></el-input>
  </el-form-item>
  <el-form-item
    v-for="(domain, index) in dynamicValidateForm.domains"
    :label="'域名' + index"
    :key="domain.key"
    :prop="'domains.' + index + '.value'"
    :rules="{
      required: true, message: '域名不能为空', trigger: 'blur'
    }"
  >
    <el-input v-model="domain.value"></el-input><el-button @click.prevent="removeDomain(domain)">删除</el-button>
  </el-form-item>
  <el-form-item>
    <el-button type="primary" @click="submitForm('dynamicValidateForm')">提交</el-button>
    <el-button @click="addDomain">新增域名</el-button>
    <el-button @click="resetForm('dynamicValidateForm')">重置</el-button>
  </el-form-item>
</el-form>
<script>
  export default {
    data() {
      return {
        dynamicValidateForm: {
          domains: [{
            value: ''
          }],
          email: ''
        }
      };
    },
    methods: {
      submitForm(formName) {
        this.$refs[formName].validate((valid) => {
          if (valid) {
            alert('submit!');
          } else {
            console.log('error submit!!');
            return false;
          }
        });
      },
      resetForm(formName) {
        this.$refs[formName].resetFields();
      },
      removeDomain(item) {
        var index = this.dynamicValidateForm.domains.indexOf(item)
        if (index !== -1) {
          this.dynamicValidateForm.domains.splice(index, 1)
        }
      },
      addDomain() {
        this.dynamicValidateForm.domains.push({
          value: '',
          key: Date.now()
        });
      }
    }
  }
</script>
其运行结果如下:

但官方文档提供的示例与我想要的并不一样,于是上网查找了其他资料。

发现我的方法与官方文档的区别在于,官方文档的示例是通过v-for循环的方式渲染出来的表单,当数组domains变化时会触发表单的重新渲染(起初并未意识到这一点),所以能够有效的动态验证表单,而我的方法只是动态修改了props属性,而并未出发表单的重新渲染,验证器中的prop属性并未更新,还是初次渲染时的空值,知道原因就想到了解决办法。

四、第二次实现与遇到的问题
我的思路是通过v-if和v-else写两个表单项,一个带prop属性,一个不带prop属性,通过强制销毁和创建表单实现表单的重新渲染。

<template>
  <el-form ref="ruleForm" :model="formData" :rules="rules">
    <el-form-item label="名字" prop="name">
      <el-input v-model="formData.name"></el-input>
    </el-form-item>
    <el-form-item label="年龄" prop="age">
      <el-input v-model="formData.age"></el-input>
    </el-form-item>
    <el-form-item label="银行卡号" v-if="formData.age >= 18" prop="bankCardNo">
      <el-input v-model="formData.bankCardNo"></el-input>
    </el-form-item>
    <el-form-item label="银行卡号" v-else>
      <el-input v-model="formData.bankCardNo"></el-input>
    </el-form-item>
  </el-form>
</template>
然而并没啥用,还是没有生效!!!

实际上出现这个问题是因为vue的diff算法,在diff算法中会尽可能的复用组件,所以此处看上根据formData.age是否大于等于18进行切换,但实际上diff算法会复用组件,并没有重新渲染,所以需要配合key属性。

官方文档是这样介绍的:

Vue代码风格指南

五、最终解决办法
完整代码如下:

<template>
  <el-form ref="ruleForm" :model="formData" :rules="rules">
    <el-form-item label="名字" prop="name">
      <el-input v-model="formData.name"></el-input>
    </el-form-item>
    <el-form-item label="年龄" prop="age">
      <el-input v-model="formData.age"></el-input>
    </el-form-item>
    <el-form-item label="银行卡号" key="1" v-if="formData.age >= 18" prop="bankCardNo">
      <el-input v-model="formData.bankCardNo"></el-input>
    </el-form-item>
    <el-form-item label="银行卡号" key="2" v-else>
      <el-input v-model="formData.bankCardNo"></el-input>
    </el-form-item>
  </el-form>
</template>
<script>
export default {
  name: 'HelloWorld',
 
  data () {
    return {
      rules: {
        name: [{ required: true, message: '请输入名字', trigger: 'blur' }],
        age: [{ required: true, message: '请输入年龄', trigger: 'blur' }],
        bankCardNo: [{ required: true, message: '请输入银行卡号', trigger: 'blur' }]
      },
      formData: {
        name: '',
        age: '',
        bankCardNo: ''
      }
    }
  }
}
</script>
最终效果如图,当年龄大于等于18时就会触发验证器。

2020年4月3日更新
上述方法没有真正理解原因,可以查看本人新文章《深入了解Element Form表单动态验证问题》,提及两种新解决办法:

1.  form-item保留prop属性,根据条件动态修改form组件的rules对象

watch: {
  'formData.age': {
    immediate: true,
    handler (newVal) {
      if (newVal >= 18) {
        this.addRule('bankCardNo', [{ required: true, message: '请输入银行卡号', trigger: 'blur' }])
      } else {
        this.addRule('bankCardNo', [])
      }
    }
  }
}
 
data () {
  return {
    rules: {}
  }
},
 
methods: {
  addRule (prop, rule) {
    this.$set(this.rules, prop, rule)
  }
}
2. form-item保留prop属性,根据条件动态修改form-item组件的rules属性。比如下面两种方式,因为rules属性接受数据和对象

<el-form-item label="银行卡号" prop="bankCardNo" :rules="formData.age >= 18 ? [{ required: true, message: '请输入银行卡号', trigger: 'blur' }] : []">
  <el-input v-model="formData.bankCardNo"></el-input>
</el-form-item>
 
<!-- 或者 -->
<el-form-item label="银行卡号" prop="bankCardNo" :rules="formData.age >= 18 ? { required: true, message: '请输入银行卡号', trigger: 'blur' } : []">
  <el-input v-model="formData.bankCardNo"></el-input>
</el-form-item>
 

### ElementUI 表单重置无效的原因分析 表单重置功能失效通常由多种因素引起。一种常见原因是 `el-form-item` 元素未正确配置 `prop` 属性,这会阻止 `resetFields()` 正常工作[^2]。 另一种情况是在对话框(Dialog)场景下使用动态表单时可能出现的问题。当在同一弹窗内处理新增和编辑操作时,由于初始值设定当可能导致重置行为符合预期[^3]。 此外,在某些情况下即使调用了 `this.$refs[formName].resetFields()` 方法,实际的数据状态仍恢复到了之前的赋值状况,这是因为存在其他地方再次给这些字段设置了新值的情况[^4]。 对于 Vue 3 结合 Element Plus 使用的情形,需要注意的是 `resetField()` 的作用并非简单地将所有输入项设为空字符串或默认值,而是将其还原至最初渲染时所绑定的对象属性值。因此,如果希望实现真正的空白化效果,则需确保首次展示表单项时其关联模型即处于期望的初始化状态[^5]。 ### 解决方案示例代码 为了有效解决上述提到的各种潜在问题,可以采取如下措施: #### 确保 Form Item 设置 Prop 属性 ```html <template> <el-form :model="ruleForm" ref="ruleForm"> <!-- 添加 prop 属性 --> <el-form-item label="活动名称" prop="name"> <el-input v-model="ruleForm.name"></el-input> </el-form-item> </el-form> </template> <script setup lang="ts"> import { reactive, ref } from 'vue' const ruleForm = reactive({ name: '' }) // 定义模板引用 const ruleFormRef = ref(null) function resetForm() { if (ruleFormRef.value !== null) { ruleFormRef.value.resetFields() } } </script> ``` #### 处理 Dialog 中的表单逻辑 针对在 Dialog 内部使用的表单,可以通过调整示顺序来规避已填充数据影响后续重置操作的问题: ```javascript let formDataCopy = {} // 创建副本用于保存原始数据 async function openEditDialog(data) { Object.assign(formDataCopy, data); // 将要编辑的数据复制一份 await nextTick(); // 等待DOM更新完成后再继续执行下一步 showEditDialogVisible(true); setTimeout(() => { Object.keys(ruleForm).forEach(key => { ruleForm[key] = formDataCopy[key]; }); }, 0); // 延迟设置具体数值以允许组件完全加载完毕 } function closeAndReset() { showEditDialogVisible(false); // 关闭后立即重置整个表单结构及其验证规则 resetForm(); } ```
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值