小程序表單校驗uni-forms的正確使用方式以及避坑指南

更新時間：2022年08月02日 15:58:31 作者：iamlujingtao

因微信小程序上沒有自帶表單驗證,為了實現(xiàn)就自己做了個表單驗證,下面這篇文章主要給大家介紹了關(guān)于小程序表單校驗uni-forms的正確使用方式以及避坑指南,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下

一、前言

小程序上使用表單理應(yīng)是很常用，也很必須的功能，因為系統(tǒng)實用了uni-app，所以這時候會用到uni-forms，但使用過程中遇到不少問題。
這邊的需求有3個：

即時校驗（輸入框失焦立即校驗值）需自定義校驗規(guī)則需要異步校驗

滿足這3個需求，就能實現(xiàn)絕大部分表單校驗，然而直接使用官方的案例并不能滿足，踩過不少坑，最后解決方案如下。

二、成果展示

以下展示均滿足上述3個需求，下面示例代碼可以直接看第六點

三、uni-forms即時校驗

實現(xiàn)即時校驗，uni-forms需要加validate-trigger="bind"，同時input添加@blur="binddata('字段名', $event.detail.value)"
示例：

 <uni-forms ref="form" :modelValue="ruleForm" validate-trigger="bind">
   <uni-forms-item label="賬號" name="account">
     <input v-model.trim="ruleForm.account" 
     @blur="binddata('account', $event.detail.value)" 
     placeholder="請輸入您的登錄賬號" />
   </uni-forms-item>
 </uni-forms>

四、uni-forms自定義校驗規(guī)則

需要自定義校驗規(guī)則時，去掉uni-forms的:rules，同時onReady里加this.$refs.form.setRules(this.rules)，其中validateFunction: this.checkEmail為自定義校驗方法

示例：

<template>
  <uni-forms ref="form" :modelValue="ruleForm" validate-trigger="bind">
    ......
  </uni-forms>
</template>

<script>
export default {
  data() {
    return {
      // 校驗規(guī)則
      rules: {
        email: {
          rules: [
            {
              validateFunction: this.checkEmail,
            },
          ],
        },
      },
    };
  },
  onReady() {
    // 需要在onReady中設(shè)置規(guī)則
    this.$refs.form.setRules(this.rules);
  },
  methods: {
    /**
     * 表單驗證郵箱
     */
    checkEmail(rule, value, allData, callback) {
      if (value !== "" && !verifyEmail(value)) {
        return callback("郵箱不正確");
      }
      callback();
    },
  },
};
</script>

五、uni-forms異步校驗

通常使用異步方法來校驗賬號是否重復(fù)等，步驟：

首先需要自定義校驗方法validateFunction: this.checkAccount
然后進行常規(guī)的規(guī)則校驗
再進行異步方法校驗賬號唯一性
需要使用Promise，校驗通過使用 return resolve()
校驗失敗使用 return reject(new Error('錯誤提示信息'))

示例（核心代碼部分）：

export default {
  data() {
    return {
      // 校驗規(guī)則
      rules: {
        account: {
          rules: [
            {
              required: true,
              errorMessage: '請輸入您的賬號',
            },
            {
              validateFunction: this.checkAccount,
            },
          ],
        },
      },
    };
  },
  methods: {
    // 表單驗證賬號
    checkAccount(rule, value) {
      return new Promise((resolve, reject) => {
        // 先進行規(guī)則校驗
        if (value === '' || !verifyAccount(value)) {
          return reject(new Error('只能輸入4-30位英文、數(shù)字、下劃線'))
        }

        // 再進行異步校驗，checkUser為本系統(tǒng)api異步方法，結(jié)合你系統(tǒng)使用你自己的方法
        apiCheckAccount({ account: value })
          .then((data) => {
            if (data.exist) {
              return reject(new Error('賬號已存在'))
            }
            resolve()
          })
          .catch((err) => {
            return reject(new Error(err.message))
          })
      })
    },
  },

六、完整示例源碼

<template>
  <view class="register">
    <view class="title">最實用表單校驗</view>
    <uni-forms ref="form" :modelValue="ruleForm" validate-trigger="bind" label-width="40">
      <uni-forms-item label="賬號" name="account">
        <input v-model.trim="ruleForm.account" @blur="binddata('account', $event.detail.value)" placeholder="請輸入您的登錄賬號" />
      </uni-forms-item>
      <uni-forms-item label="姓名" name="name">
        <input v-model.trim="ruleForm.name" @blur="binddata('name', $event.detail.value)" placeholder="請輸入您的姓名" />
      </uni-forms-item>
      <uni-forms-item class="form-item-center">
        <button type="primary" @click="submit()">注冊</button>
      </uni-forms-item>
    </uni-forms>
  </view>
</template>

<script>
import { apiCheckAccount } from '@/api'
import { verifyAccount, verifyName } from '@/utils'

export default {
  data() {
    return {
      // 表單數(shù)據(jù)
      ruleForm: {
        account: '', // 賬號
        name: '', // 姓名
      },

      rules: {},
    }
  },
  onReady() {
    this.setRules()
    // 需要在onReady中設(shè)置規(guī)則
    this.$refs.form.setRules(this.rules)
  },
  methods: {
    // 提交表單
    submit() {
      this.$refs.form
        .validate()
        .then(() => {
          uni.showToast({
            title: '注冊成功！',
            duration: 2000,
            icon: 'success',
          })
        })
        .catch((err) => {
          console.log('表單校驗失?。?, err)
        })
    },

    // 設(shè)置校驗規(guī)則
    setRules() {
      this.rules = {
        account: {
          rules: [
            {
              required: true,
              errorMessage: '請輸入您的賬號',
            },
            {
              validateFunction: this.checkAccount,
            },
          ],
        },
        name: {
          rules: [
            {
              required: true,
              errorMessage: '請輸入您的姓名',
            },
            {
              validateFunction: this.checkName,
            },
          ],
        },
      }
    },

    // 驗證賬號
    checkAccount(rule, value) {
      return new Promise((resolve, reject) => {
        // 先進行規(guī)則校驗
        if (value === '' || !verifyAccount(value)) {
          return reject(new Error('只能輸入4-30位英文、數(shù)字、下劃線'))
        }

        // 再進行異步校驗，checkUser為本系統(tǒng)api異步方法，結(jié)合你系統(tǒng)使用你自己的方法
        apiCheckAccount({ account: value })
          .then((data) => {
            if (data.exist) {
              return reject(new Error('賬號已存在'))
            }
            resolve()
          })
          .catch((err) => {
            return reject(new Error(err.message))
          })
      })
    },

    // 驗證姓名
    checkName(rule, value, allData, callback) {
      if (!verifyName(value)) {
        return callback('只能輸入1-30位中英文和數(shù)字')
      }
      callback()
    },
  },
}
</script>