深入了解Element Form表单动态验证问题
element
A Vue.js 2.0 UI Toolkit for Web
项目地址:https://gitcode.com/gh_mirrors/eleme/element
免费下载资源
·
在上一篇《vue elementUI组件表单动态验证失效的问题与解决办法》中,讲到直接修改prop
属性,未触发form-item
的重新渲染,所以虽然有校验*
的标志,实际上并不会校验。这是表面现象,最近有了空余时间,去看看了element form
组件的源码,找到了根本原因。
源码分析
- 在
form
组件的created
钩子函数中添加了el.form.addField
和el.form.removeField
事件监听,往fields
中添加或删除field
,校验的时候会遍历fields数组,而field
就是form-item
的实例。接着查看form-item
组件的源码,可以看到在组件挂载后mounted
,如果prop属性有值
就会触发el.form.addField
事件,在组件销毁前beforeDestroy
触发el.form.removeField
事件。由此可知如果挂载时form-item
组件prop
属性无值,不会触发el.form.addField
。
// form.vue
created() {
this.$on('el.form.addField', (field) => {
if (field) {
this.fields.push(field);
}
});
/* istanbul ignore next */
this.$on('el.form.removeField', (field) => {
if (field.prop) {
this.fields.splice(this.fields.indexOf(field), 1);
}
});
}
// form-item.vue
mounted() {
// 重点挂载前有prop属性,才会触发'el.form.addField'
if (this.prop) {
this.dispatch('ElForm', 'el.form.addField', [this]);
// ...
this.addValidateEvents();
}
},
beforeDestroy() {
this.dispatch('ElForm', 'el.form.removeField', [this]);
}
form
表单校验是调用表单实例的validate
方法,去掉边界、合法性判断一类的代码,其核心源码如下,从代码注释中可以知道,form
表单的校验方法核心是调用form-item
组件实例的validate
方法。
// form.vue
methods: {
validate(callback) {
// ...
this.fields.forEach(field => {
// 调用form-item实例的validate方法
field.validate('', (message, field) => {
if (message) {
valid = false;
}
invalidFields = objectAssign({}, invalidFields, field);
if (typeof callback === 'function' && ++count === this.fields.length) {
callback(valid, invalidFields);
}
});
});
}
},
watch: {
// 如果rules有变化,强制更新form-item的校验事件,并触发一次form实例validate方法
rules() {
// remove then add event listeners on form-item after form rules change
this.fields.forEach(field => {
field.removeValidateEvents();
field.addValidateEvents();
});
if (this.validateOnRuleChange) {
this.validate(() => {});
}
}
}
- 最后看
form-item
的validate
方法,省略一些逻辑判断和优化代码,其核心是获取form
组件的对应属性的rules
及form-item
自身的rules
,生成AsyncValidator
校验器的校验规则描述,并进行数据校验。
// form-item.vue
validate(trigger, callback = noop) {
this.validateDisabled = false;
// 获取form组件的对应属性的rules及form-item自身的rules,并根据触发器trigger过滤
const rules = this.getFilteredRule(trigger);
// 判断校验规则,假值或者rules数组为空,则跳过。值得注意的是空对象并不是假值,所以不会跳过
if ((!rules || rules.length === 0) && this.required === undefined) {
callback();
return true;
}
this.validateState = 'validating';
// 设置AsyncValidator的校验规则描述
const descriptor = {};
if (rules && rules.length > 0) {
rules.forEach(rule => {
delete rule.trigger;
});
}
descriptor[this.prop] = rules;
const validator = new AsyncValidator(descriptor);
const model = {};
model[this.prop] = this.fieldValue;
validator.validate(model, { firstFields: true }, (errors, invalidFields) => {
this.validateState = !errors ? 'success' : 'error';
this.validateMessage = errors ? errors[0].message : '';
callback(this.validateMessage, invalidFields);
this.elForm && this.elForm.$emit('validate', this.prop, !errors, this.validateMessage || null);
});
}
从上面的第一点中可以看到,因为prop
初始值为空字符串''
,所以form
表单的fileds
不会持有该form-item
实例,故即使后面修改prop
属性,也不会去校验该表单项,导致校验失效。
解决办法
- 《vue elementUI组件表单动态验证失效的问题与解决办法》中讲的强制重新渲染
form-item
,当时不知道根本原因采用的笨办法。 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)
}
}
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>
总结
终须由浅入深,浮于表面便是管中窥豹,自身还需静下心认真研究
GitHub 加速计划 / eleme / element
54.06 K
14.63 K
下载
A Vue.js 2.0 UI Toolkit for Web
最近提交(Master分支:3 个月前 )
c345bb45
7 个月前
a07f3a59
* Update transition.md
* Update table.md
* Update transition.md
* Update table.md
* Update transition.md
* Update table.md
* Update table.md
* Update transition.md
* Update popover.md 7 个月前
更多推荐
已为社区贡献4条内容
所有评论(0)