uniapp之表单校验

uni-forms表单校验

1、uni-forms 需要通过rules属性传入约定的校验规则。

2、uni-forms 需要绑定model属性，值为表单的key/value组成的对象

3、uni-forms-item 需要设置name 属性为当前字段名，字段为String|Array类型

4、只要使用的组件不管内置组件还是三方组件，只需绑定v-model，无需其他操作

5、如果使用原生checkbox或三方组件不支持v-model等，只需要给罪案绑定binddata方法即可出发表单校验，无需绑定事件到methods中

6、binddata('name',$event.detail.value,'form')方法接受三个值，

第一个参数传入当前表单组件所在的name，同当前父组件uni-forms-item 绑定属性name的值

第二个参数传入需要校验的值，内置 组件可以通过$event.detail.value 获取到组件的返回值，自定义组件传入需要校验的值即可

第三个参数传入uni-forms组件绑定属性ref的值，通常在多表单的时候需要传入，用来区分表单，如页面中仅有一个uni-forms可忽略

7、如果内置binddata方法无法满足需求，在当前页面的methods中复写此方法即可，复写此方法需要调用uni-forms的setValue来触发表单校验

3. <script>
4. export default {
5. data() {
6. return {
7. // 表单数据
8. formData: {
9. name: 'LiMing',
10. email: 'dcloud@email.com'
11. },
12. rules: {
13. // 对name字段进行必填验证
14. name: {
15. rules: [{
16. required: true,
17. errorMessage: '请输入姓名',
18. },
19. {
20. minLength: 3,
21. maxLength: 5,
22. errorMessage: '姓名长度在 {minLength} 到 {maxLength} 个字符',
23. }
24. ]
25. },
26. // 对email字段进行必填验证
27. email: {
28. rules: [{
29. format: 'email',
30. errorMessage: '请输入正确的邮箱地址',
31. }]
32. }
33. }
34. }
35. },
36. methods: {
37. /**
38. * 复写 binddata 方法，如果只是为了校验，无复杂自定义操作，可忽略此方法
39. * @param {String} name 字段名称
40. * @param {String} value 表单域的值
41. */
42. // binddata(name,value){
43. // 通过 input 事件设置表单指定 name 的值
44. // this.$refs.form.setValue(name, value)
45. // },
46. // 触发提交表单
47. submit() {
48. this.$refs.form.validate().then(res=>{
49. console.log('表单数据信息：', res);
50. }).catch(err =>{
51. console.log('表单错误信息：', err);
52. })
53. }
54. }
55. }
57. script>

校验规则说明

校验规则接受一个Object类型的值，通过传入不同的规则来表示每个表单域的值该如何校验

对象的key表示当前表单域的字段名，value为具体的校验规则

以下为value所包含的内容

属性名	类型	说明
rules	Array	校验规则，下方rules属性说明
validateTrigger	String	表单校验时机【1.4.0】已废弃
label	String	当前表单域的字段中文名，多用于errMessage的显示，可以不填

1. rules: {
2. // 对name字段进行必填验证
3. name: {
4. // name 字段的校验规则
5. rules:[
6. // 校验 name 不能为空
7. {
8. required: true,
9. errorMessage: '请填写姓名',
10. },
11. // 对name字段进行长度验证
12. {
13. minLength: 3,
14. maxLength: 5,
15. errorMessage: '{label}长度在 {minLength} 到 {maxLength} 个字符',
16. }
17. ],
18. // 当前表单域的字段中文名，可不填写
19. label:'姓名',
20. validateTrigger:'submit'
21. }
22. }

rules 属性说明

每一个验证规则中，可以配置多个属性，下面是一些常见规则属性

属性名	类型	默认值	可选值	说明
required	Boolean	-	-	是否必填，配置此参数不会显示输入框左边的必填星号，如需要，请配置uni-forms-item组件的的required为true
range	Array	-	-	数组至少要有一个元素，且数组内的每一个元素都是唯一的。
format	String	-	-	内置校验规则，如这些规则无法满足需求，可以使用正则匹配或者自定义规则
pattern	RegExp	-	-	正则表达式，注意事项见下方说明
maximum	Number	-	-	校验最大值(大于)
minimum	Number	-	-	校验最小值(小于)
maxLength	Number	-	-	校验数据最大长度
errorMessage	String	-	-	校验失败提示信息语，可添加属性占位符，当前表格内属性都可用作占位符
validateFunction	Function	-	-	自定义校验规则

format属性值说明

属性名	说明
string	必须是 string 类型，默认类型
number	必须是 number 类型
boolean	必须是 boolean 类型
array	必须是 array 类型
object	必须是 object 类型
url	必须是 url 类型
email	必须是 email 类型

validateFunction 自定义校验规则使用说明

validateFunction 方法返回四个参数 validateFunction:function(rule,value,data,callback){} ，当然返回参数名开发者可以自定义：

rule : 当前校验字段在 rules 中所对应的校验规则

value : 当前校验字段的值

data : 所有校验字段的字段和值的对象

callback : 校验完成时的回调，一般无需执行callback，返回true(校验通过)或者false(校验失败)即可 ，如果需要显示不同的 errMessage，如果校验不通过需要执行 callback('提示错误信息')，如果校验通过，执行callback()即可

2. <script>
3. export default {
4. data() {
5. return {
6. formData:{
8. },
9. rules: {
10. hobby: {
11. rules: [{
12. required: true,
13. errorMessage: '请选择兴趣',
14. },{
15. validateFunction:function(rule,value,data,callback){
16. if (value.length < 2) {
17. callback('请至少勾选两个兴趣爱好')
18. }
19. return true
20. }
21. }]
22. }
23. }
24. }
25. },
26. onReady() {
27. // 需要在onReady中设置规则
28. this.$refs.form.setRules(this.rules)
29. },
30. methods: {
31. submit(form) {
32. this.$refs.form.validate().then(res=>{
33. console.log('表单数据信息：', res);
34. }).catch(err =>{
35. console.log('表单错误信息：', err);
36. })
37. }
38. }
39. }
40. script>

validateFunction 异步校验

上面的自定义校验方式为同步校验 ，如果需要异步校验，validateFunction 需要返回一个 Promise ，校验不通过 执行 reject(new Error('错误信息')) 返回对应的错误信息，如果校验通过则直接执行 resolve() 即可，在异步校验方法中，不需要使用 callback 。

3. <script>
4. export default {
5. data() {
6. return {
7. formData:{
8. age:''
9. },
10. rules: {
11. age: {
12. rules: [{
13. required: true,
14. errorMessage: '请输入年龄',
15. },{
16. validateFunction: (rule, value, data, callback) => {
17. // 异步需要返回 Promise 对象
18. return new Promise((resolve, reject) => {
19. setTimeout(() => {
20. if (value > 10 ) {
21. // 通过返回 resolve
22. resolve()
23. } else {
24. // 不通过返回 reject(new Error('错误信息'))
25. reject(new Error('年龄必须大于十岁'))
26. }
27. }, 2000)
28. })
29. }
30. }]
31. }
32. }
33. }
34. },
35. onReady() {
36. // 需要在onReady中设置规则
37. this.$refs.form.setRules(this.rules)
38. },
39. methods: {
40. /**
41. * 表单提交
42. * @param {Object} event
43. */
44. submit() {
45. uni.showLoading()
46. this.$refs.form.validate().then(res => {
47. uni.hideLoading()
48. console.log('表单数据信息：', res);
49. }).catch(err => {
50. uni.hideLoading()
51. console.log('表单错误信息：', err);
52. })
53. }
54. }
55. }
56. script>

动态表单校验

多用于同一个字段需要添加多次的场景，如需要动态创建多个域名参与检验。

1. 在 formData 中定义个变量用来接受同一个字段的多个结果。
   1. dynamicFormData: {
   2. email: '',
   3. // domains 字段下会有多个结果
   4. domains: []
   5. }

2. 使用 uni-forms-item 的 rules 属性定义单个表单域的校验规则。
   1. "item.label+' '+index" required
   2. :rules="[{'required': true,errorMessage: '域名项必填'}]" :key="item.id">
   3. ...

3. name 需要动态指定，动态表单推荐使用 Array 类型，内容从左到右为绑定值的调用链。['domains',index,'value'] 等同于 dynamicFormData.domains[index].value
   2. required
   3. :label="item.label+' '+index"
   4. :name="['domains',index,'value']"
   5. :rules="[{'required': true,errorMessage: '域名项必填'}]"
   6. :key="item.id"
   7. >
   8. ...

4. 需要绑定值的组件的 v-model 也需要动态指定 dynamicFormData.domains[index].value
   2. required
   3. :label="item.label+' '+index"
   4. :name="['domains',index,'value']"
   5. :rules="[{'required': true,errorMessage: '域名项必填'}]"
   6. :key="item.id"
   7. >
   8. <uni-easyinput v-model="dynamicFormData.domains[index].value" placeholder="请输入域名" />

   完整实例

   1. "dynamicForm" :rules="dynamicRules" :model="dynamicFormData">
   2. <uni-forms-item label="邮箱" required name="email">
   3. <uni-easyinput v-model="dynamicFormData.email" placeholder="请输入姓名" />
   4. uni-forms-item>
   5. <template v-for="(item,index) in dynamicFormData.domains">
   6. <uni-forms-item :label="item.label+' '+index" required
   7. :rules="[{'required': true,errorMessage: '域名项必填'}]" :key="item.id"
   8. :name="['domains',index,'value']">
   9. <view class="form-item">
   10. <uni-easyinput v-model="dynamicFormData.domains[index].value" placeholder="请输入域名" />
   11. <button class="button" size="mini" type="default" @click="del(item.id)">删除button>
   12. view>
   13. uni-forms-item>
   14. template>
   17. <view class="button-group">
   18. <button type="primary" size="mini" @click="add">新增域名button>
   19. <button type="primary" size="mini" @click="submit('dynamicForm')">提交button>
   20. view>
   22. <script>
   23. export default {
   24. data() {
   25. return {
   26. // 数据源
   27. dynamicFormData: {
   28. email: '',
   29. domains: []
   30. },
   31. // 规则
   32. dynamicRules: {
   33. email: {
   34. rules: [{
   35. required: true,
   36. errorMessage: '域名不能为空'
   37. }, {
   38. format: 'email',
   39. errorMessage: '域名格式错误'
   40. }]
   41. }
   42. }
   43. }
   44. },
   45. methods: {
   46. // 新增表单域
   47. add() {
   48. this.dynamicFormData.domains.push({
   49. label: '域名',
   50. value:'',
   51. id: Date.now()
   52. })
   53. },
   54. // 删除表单域
   55. del(id) {
   56. let index = this.dynamicLists.findIndex(v => v.id === id)
   57. this.dynamicLists.splice(index, 1)
   58. },
   59. // 提交
   60. submit(ref) {
   61. this.$refs[ref].validate((err,value)=>{
   62. console.log(err,value);
   63. })
   64. },
   65. }
   66. }
   68. script>
   

   表单校验时机说明

    

   如果需要子表单需要单独的校验时机，可以使用 uni-forms-item 的 rules 属性和 onFieldChange 配合

   

   【1.4.0后此规则已不生效】对于表单校验时机，同时只会有一个 validateTrigger 发生作用，它的作用权重为

   规则 > uni-forms-item > uni-forms

   如果规则里配置 validateTrigger ，则优先使用规则里的 validateTrigger 属性来决定表单校验时机

   如果规则里没有配置 validateTrigger ，则优先使用 uni-forms-item 的 validateTrigger 属性来决定表单校验时机

   如果 uni-forms-item 组件里没有配置 validateTrigger ，则优先使用 uni-forms 的 validateTrigger 属性来决定表单校验时机

   以此类推，如果都没有使用 validateTrigger 属性，则会使用 uni-forms 的 validateTrigger 属性默认值来决定表单校验时机

   API

   Forms Props

   属性名	类型	默认值	可选值	说明	兼容说明
   model	Object	-	-	表单数据	1.4.0 新增
   rules	Object	-	-	表单校验规则
   validateTrigger	String	submit	bind/submit/blur	表单校验时机,blur仅在 uni-easyinput 中生效	1.4.0 新增 blur 值
   label-position	String	left	top/left	label 位置
   label-width	String/Number	75	-	label 宽度，单位 px
   label-align	String	left	left/center/right	label 居中方式
   err-show-type	String	undertext	undertext/toast/modal	表单错误信息提示方式
   border	Boolean	false	-	是否显示分格线
   value	Object	-	-	表单数据，兼容vue2	即将弃用，请使用 model 代替
   modelValue	Object	-	-	表单数据，兼容vue3	即将弃用，请使用 model 代替

   Forms Events

   事件称名	说明
   @validate	任意表单项被校验后触发，返回表单校验信息

   Forms Methods

   方法称名	说明	兼容说明
   setRules	动态设置表单规则
   validate	对整个表单进行校验的方法，会返回一个 promise
   validateField	部分表单进行校验
   clearValidate	移除表单的校验结果
   submit	对整个表单进行校验的方法，会返回一个 promise	即将弃用，请使用validate代替
   setValue	设置表单某一项 name 的对应值，通常在 uni-forms-item 和自定表单组件中使用	即将弃用，请使用 onFieldChange 兼容相关功能
   resetFields	重置表单, 需要把uni-forms的modelValue属性改为v-model,且对内置组件可能不生效	1.4.0 已弃用

   validate(keepItem:Array,callback:Function) 方法说明

   validate 方法是对整个表单进行校验，方法接受两个参数

   参数称名	类型	说明
   keepItem	Array	保留不参与校验的字段
   callback	Function	校验完成返回函数

   校验成功后，校验对象只保留指定了name的字段（只要 uni-forms-item 绑定了 name，哪怕不校验，也会返回），如果需要保留其他字段，则需要 keepItem 属性

   3. <script>
   4. export default {
   5. data() {
   6. return {
   7. formData:{
   8. age:''
   9. },
   10. rules: {
   11. // ...
   12. }
   13. }
   14. },
   15. onLoad(){
   16. this.formData.id = 'testId'
   17. },
   18. methods: {
   19. submit() {
   20. // 在 onLoad 生命周期中，formData添加了一个 id 字段 ，此时这个字段是不参数校验的，所以结果中不返回
   21. // 在 validate(['id']) 方法中，指定第一个参数 ，即可返回id字段
   22. this.$refs.form.validate(['id'],(err,formData)=>{
   23. if(!err){
   24. console.log('success',formData)
   25. }
   26. })
   27. }
   28. }
   29. }
   30. script>
   

   validate 方法还可以返回一个 Promise 对象，如果使用了 callback 则Promise 返回 null，validate 方法会优先使用 callback。

   callback 方法会返回两个返回值 :

   第一个返回值为检验结果，如果校验失败，则返回失败信息，如果成功，返回 null

   第二个返回值校验数据

   2. // 使用 callback
   3. // 如果不需要 keepItem 参数 ，则可以省略
   4. this.$refs.form.validate((err,formData)=>{
   5. // 如果校验成功 ，err 返回 null
   6. if(!err){
   7. console.log('success',formData)
   8. return
   9. }
   10. console.log('error',err)
   11. }).then(res=>{
   12. // res 返回 null
   13. })
   15. // 使用 Promise
   16. // 对整个表单进行校验，返回一个 Promise
   17. this.$refs.form.validate().then((res)=>{
   18. // 成功返回，res 为表单数据
   19. // 其他逻辑处理
   20. // ...
   21. }).catch((err)=>{
   22. // 表单校验验失败，err 为具体错误信息
   23. // 其他逻辑处理
   24. // ...
   25. })
   

   setValue(name:String,value:any) 方法说明

   setValue 方法通常用于内置组件或三方组件返回值的校验，因为uni-esayinput 等 uni 开头的组件内置了对 uni-forms的支持，所以这些组件返回的值可以直接使用，但是比如像input 这些内置组件值的变化，无法及时通知 uni-forms ，从而无法正常的校验，这时就需要我们手动将这些值加入到uni-forms的校验。

   setValue 方法接受两个参数：

   name: 表单域对应的name

   value: 表单域对应的值