ant-design-vue 关于 formModel 表单部分校验的方法总结

阳光穿透心脏的1/2处 2022-09-09 00:28 638阅读 0赞

# 前情 #

利用antdv的 `card` 组件的时候，使用了带页签的 `card`，其中放有一些 `formModelItem` 这其中的每一个页签在没有被选中的时候，相关的表单项无法被渲染到页面上，造成提交的时候无法被校验。

所以试当页签在切换时触发当前页签的表单项校验，如果校验通过的话，才允许切换页签。

# 针对单个表单项 #

在官方文档中有这样的一个方法：[表单 FormModel - Ant Design Vue (antdv.com)][FormModel - Ant Design Vue _antdv.com]

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>说明</th> 
   <th>参数</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>validateField</td> 
   <td>对部分表单字段进行校验的方法</td> 
   <td>Function(props: array | string, callback: Function(errorMessage: string))</td> 
  </tr> 
 </tbody> 
</table>

由此，对于一个表单项的校验，可以传入一个 `prop` 的字符串或者数组，然后对其进行校验：

// 对单个表单项校验
    this.$refs.form.validateField('validateProp', (errMsg) => { 
      /** * 如果有错误的话，errMsg会直接输出校验不通过的错误信息 * 如果没有错误的话，errMsg会是一个空字符串 */
      if (errMsg === '') { 
          // TODO
      }
    })

# 针对多个表单项 #

当尝试对多个表单项进行进行校验时，我以为是会像校验全部表单一样，回调函数会传输一个 `boolean`，但是依旧是传输错误字符串，而且是一个表单项传输一个。

所以，我使用以下的方法来对校验进行处理：（可能会有更好的方法，因为对 JavaScript 了解不足，我只能想到这种方法。如果有更好的方法，欢迎私信或者评论告诉我。）

// 对多个表单项进行校验
    // 等待校验的字段名
    const validatePropList = ['prop1', 'prop2', ...];
    const validateErrMsgList = [];
    this.$refs.form.validateField(validateList, errMsg => { 
      // 将所有的校验信息放入一个数组
     /** * 这里试着用过扩展运算符对errMsg进行展开了，但是在控制台返回的只有一行一行的数据。 * 利用 console.dir(errMsg) 也无法将这个数据展开，查看内部的属性。 * 所以，大致可以确定ant-design-vue对这个方法的实行应该是对数组进行类似于循环调用的。 * 我虽然觉得这个实现挺不合理的，但是毕竟是用开源的东西，我也没有能力提PR，所以，就这样子用吧。 */
      validateErrMsgList.push(errMsg);
    });
    
    // 调用数组的 every 方法校验
    if (validateErrMsgList.every(element => element === '')) { 
      // PASS TODO
    } else { 
      // failed TODO
    }

其中，`array.prototype.every` 方法的用法请见这里：[Array.prototype.every() - JavaScript | MDN (mozilla.org)][Array.prototype.every_ - JavaScript _ MDN _mozilla.org]。

# 针对动态表单 #

其实就类似于针对多个表单项的，但是对于动态表单可以利用一个 `for` 循环，加上模板字符串，将其中的元素放入校验字段名数组即可：

for (let index = 0; index < someArray.someattr.length; index++) { 
      validatePropList.push(`someArray.someattr.${ index }`);
    }
    // 参考针对多个表单项进行校验

其中，针对模板字符串，这里可能有你想要知道的用法：[模板字符串 - JavaScript | MDN (mozilla.org)][- JavaScript _ MDN _mozilla.org]。

这样子就可以完成对于 `formModel` 的局部表单校验了。

[FormModel - Ant Design Vue _antdv.com]: https://www.antdv.com/components/form-model-cn/#%E6%96%B9%E6%B3%95
[Array.prototype.every_ - JavaScript _ MDN _mozilla.org]: https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Array/every
[- JavaScript _ MDN _mozilla.org]: https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Template_literals