Utilisez async-validator pour écrire des composants de formulaire

Cet article présente principalement la méthode d'utilisation du validateur asynchrone pour écrire des composants de formulaire. L'éditeur pense que c'est assez bon, je vais donc le partager avec vous maintenant et le donner comme référence. Suivons l'éditeur pour y jeter un œil, j'espère que cela pourra aider tout le monde.

Dans le développement front-end, la vérification de formulaire est une fonction très courante. Certaines bibliothèques d'interface utilisateur telles que ant.design et Element ui ont implémenté des composants de formulaire avec des fonctions de vérification. async-validator est une bibliothèque qui peut effectuer une vérification asynchrone des données. Le composant Form d'ant.design et Element ui utilisent async-validator. Cet article présentera brièvement l'utilisation de base d'async-validator et utilisera cette bibliothèque pour implémenter un composant Form simple avec fonction de vérification.

1. Utilisation de base du validateur asynchrone

La fonction du validateur asynchrone est de vérifier si les données sont légales et de fournir des informations rapides conformément aux règles de vérification.

Ce qui suit montre l'utilisation la plus élémentaire du validateur asynchrone.

import AsyncValidator from 'async-validator'
// 校验规则
const descriptor = {
 username: [
 {
  required: true,
  message: '请填写用户名'
 },
 {
  min: 3,
  max: 10,
  message: '用户名长度为3-10'
 }
 ]
}
// 根据校验规则构造一个 validator
const validator = new AsyncValidator(descriptor)
const data = {
 username: 'username'
}
validator.validate(model, (errors, fields) => {
 console.log(errors)
})

Lorsque les données ne répondent pas aux règles de vérification, vous pouvez obtenir le message d'erreur correspondant dans la fonction de rappel de validator.validate.

Lorsque les règles de vérification communes dans async-validator ne peuvent pas répondre aux besoins, nous pouvons écrire une fonction de vérification personnalisée pour vérifier les données. Une fonction de vérification simple est la suivante.

function validateData (rule, value, callback) {
 let err
 if (value === 'xxxx') {
  err = '不符合规范'
 }
 callback(err)
}
const descriptor = {
 complex: [
  {
  validator: validateData
  }
 ]
}
const validator = new AsyncValidator(descriptor)

async-validator prend en charge la vérification asynchrone des données, donc lors de l'écriture d'une fonction de vérification personnalisée, que la vérification réussisse ou non, le rappel dans la fonction de vérification Il faut tous les appeler.

2. Composant Write Form et composant FormItem

Maintenant que nous savons comment utiliser async-validator, comment combiner cette bibliothèque avec le composant Form à écrire.

Idée de mise en œuvre

Utilisez une image pour décrire l'idée de mise en œuvre.

Composant de formulaire

Le composant de formulaire doit être un conteneur qui contient un nombre indéfini de FormItem ou d'autres éléments. Vous pouvez utiliser le composant slot intégré de Vue pour représenter le contenu du formulaire.

Le composant Form doit également savoir combien de composants FormItem il contient et doivent être vérifiés. Normalement, la communication entre les composants parents et enfants est réalisée en liant des événements sur les composants enfants, mais en utilisant slot ici, les événements des composants enfants ne peuvent pas être surveillés. Ici, vous pouvez écouter les événements via $on sur le composant Form et déclencher l'événement personnalisé du composant Form avant que le FormItem ne soit monté ou détruit.

Suite à cette idée, nous écrivons d'abord le composant Form.

<template>
 <form class="v-form">
  <slot></slot>
 </form> 
</template>
<script>
import AsyncValidator from &#39;async-validator&#39;
export default {
 name: &#39;v-form&#39;,
 componentName: &#39;VForm&#39;, // 通过 $options.componentName 来找 form 组件
 data () {
  return {
   fields: [], // field: {prop, el}，保存 FormItem 的信息。
   formError: {}
  }
 },
 computed: {
  formRules () {
   const descriptor = {}
   this.fields.forEach(({prop}) => {
    if (!Array.isArray(this.rules[prop])) {
     console.warn(`prop 为 ${prop} 的 FormItem 校验规则不存在或者其值不是数组`)
     descriptor[prop] = [{ required: true }]
     return
    }
    descriptor[prop] = this.rules[prop]
   })
   return descriptor
  },
  formValues () {
   return this.fields.reduce((data, {prop}) => {
    data[prop] = this.model[prop]
    return data
   }, {})
  }
 },
 methods: {
  validate (callback) {
   const validator = new AsyncValidator(this.formRules)
   validator.validate(this.formValues, (errors) => {
    let formError = {}
    if (errors && errors.length) {
     errors.forEach(({message, field}) => {
      formError[field] = message
     })
    } else {
     formError = {}
    }
    this.formError = formError
    // 让错误信息的顺序与表单组件的顺序相同
    const errInfo = []
    this.fields.forEach(({prop, el}, index) => {
     if (formError[prop]) {
      errInfo.push(formError[prop])
     }
    })
    callback(errInfo)
   })
  }
 },
 props: {
  model: Object,
  rules: Object
 },
 created () {
  this.$on(&#39;form.addField&#39;, (field) => {
   if (field) {
    this.fields = [...this.fields, field]
   }
  })
  this.$on(&#39;form.removeField&#39;, (field) => {
   if (field) {
    this.fields = this.fields.filter(({prop}) => prop !== field.prop)
   }
  })
 }
}
</script>

Composant FormItem

Le composant FormItem est beaucoup plus simple. Il faut d'abord trouver le composant Form qui le contient. . Ensuite, les informations d'erreur correspondantes peuvent être calculées sur la base de formError.

<template>
 <p class="form-item">
  <label :for="prop" class="form-item-label" v-if="label">
   {{ label }}
  </label>
  <p class="form-item-content">
   <slot></slot>
  </p>
 </p>
</template>
<script>
export default {
 name: &#39;form-item&#39;,
 computed: {
  form () {
   let parent = this.$parent
   while (parent.$options.componentName !== &#39;VForm&#39;) {
    parent = parent.$parent
   }
   return parent
  },
  fieldError () {
   if (!this.prop) {
    return &#39;&#39;
   }
   const formError = this.form.formError
   return formError[this.prop] || &#39;&#39;
  }
 },
 props: {
  prop: String,
  label: String
 }
}
</script>

FormItem doit également déclencher certains événements personnalisés du composant Form dans les hooks montés et beforeDestroy.

<script>
export default {
 // ...
 methods: {
  dispatchEvent (eventName, params) {
   if (typeof this.form !== &#39;object&#39; && !this.form.$emit) {
    console.error(&#39;FormItem必须在Form组件内&#39;)
    return
   }
   this.form.$emit(eventName, params)
  }
 },
 mounted () {
  if (this.prop) {
   this.dispatchEvent(&#39;form.addField&#39;, {
    prop: this.prop,
    el: this.$el
   })
  }
 },
 beforeDestroy () {
  if (this.prop) {
   this.dispatchEvent(&#39;form.removeField&#39;, {
    prop: this.prop
   })
  }
 }
}
</script>

Enfin, créez un nouvel index.js pour exporter le composant écrit.

import VForm from './Form.vue'
import FormItem from './FormItem.vue'

export {
 VForm,
 FormItem
}

3. Utilisation

La fonction de validation du formulaire est dans le composant Form. Vous pouvez accéder au composant Form via $ref et appeler la fonction de validation pour obtenir les informations de vérification correspondantes.

L'utilisation est la suivante :

<template>
 <v-form :model="formData" :rules="rules" ref="form">
  <form-item label="手机号" prop="tel">
   <input type="tel" maxlength="11" v-model.trim="formData.tel"/>
  </form-item>
  <button @click="handleSubmit">保存</button>
 </v-form>
</template>
<script>
 import { VForm, FormItem } from &#39;./common/Form&#39;
 export default {
  data () {
   return {
    formData: {
     tel: &#39;&#39;
    },
    rules: {
     tel: [
      {required: true, message: &#39;您的手机号码未输入&#39;},
      {pattern: /^1[34578]\d{9}$/, message: &#39;您的手机号码输入错误&#39;}
     ]
    }
   }
  },
  methods: {
   handleSubmit () {
    this.$refs.form.validate(errs => {
     console.log(errs)
    })
   }
  },
  components: {
   VForm,
   FormItem
  }
 }
</script>

Cliquez ici pour le code complet.

4. Résumé

Cet article présente brièvement l'utilisation du validateur asynchrone et implémente un composant Form avec fonction de vérification. Le formulaire mis en œuvre ici présente de nombreuses lacunes : (1) Il n'est vérifié que lorsque le formulaire est soumis. (2) Le composant FormItem doit également ajuster l'interface utilisateur en fonction des résultats de la vérification et afficher les invites correspondantes. Par conséquent, le composant Form est plus adapté à une utilisation sur des terminaux mobiles avec moins d’interaction.

Sur la base de cette idée d'implémentation, vous pouvez écrire des composants de formulaire plus personnalisés en fonction de scénarios d'application.

Recommandations associées :

Explication détaillée de vue et vue-validator pour implémenter la fonction de vérification de formulaire

Comment écrire la méthode de vérification personnalisée bootstrapValidator

À propos de l'utilisation du plug-in de validation de formulaire formValidator

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!