多数据校验 - CheckMap

校验方法: https://godoc.org/github.com/gogf/gf/util/gvalid

  1. 其中params参数支持任意 map 数据类型;
  2. rules参数支持 []string / map[string]string 数据类型,前面一种类型支持返回校验结果顺序,后一种不支持(因为map是无序的);
  3. rules参数中的 map[string]string 是一个二维的关联数组/哈希表,第一维键名为参数键名,第二维为带有错误的校验规则名称,键值为错误信息;
  4. msgs参数为自定义的错误信息,为非必需参数,类型为CustomMsgmap[string]interface{})具体使用请参考后续示例;
  1. params := map[string]interface{} {
  2. "passport" : "",
  3. "password" : "123456",
  4. "password2" : "1234567",
  5. }
  6. rules := map[string]string {
  7. "passport" : "required|length:6,16",
  8. "password" : "required|length:6,16|same:password2",
  9. "password2" : "required|length:6,16",
  10. }
  11. if e := gvalid.CheckMap(params, rules); e != nil {
  12. }
  13. // 输出: map[passport:map[required:字段不能为空 length:字段长度为6到16个字符] password:map[same:字段值不合法]]

示例2,自定义错误提示

该示例同时也展示了msgs自定义错误信息传递的两种数据类型,string或者map[string]string。其中map[string]string类型参数需要指定对应字段、对应规则的错误提示信息,是一个二维的“关联数组”。

校验结果顺序性

如果将上面的例2程序多执行几次之后会发现,返回的结果是没有排序的,而且字段及规则输出的先后顺序完全是随机的。即使我们使用FirstItem, FirstString()等其他方法获取校验结果也是一样,返回的校验结果不固定。

使用gvalid tag顺序性校验:

我们来改进一下以上的示例:校验结果中如果不满足required那么返回对应的错误信息,否则才是后续的校验错误信息;也就是说,返回的错误信息应当和我设定规则时的顺序一致。如下:

  1. params := map[string]interface{} {
  2. "passport" : "",
  3. "password" : "123456",
  4. "password2" : "1234567",
  5. }
  6. rules := []string {
  7. "passport@required|length:6,16#账号不能为空|账号长度应当在:min到:max之间",
  8. "password@required|length:6,16|same:password2#密码不能为空|密码长度应当在:min到:max之间|两次密码输入不相等",
  9. "password2@required|length:6,16#",
  10. }
  11. if e := gvalid.CheckMap(params, rules); e != nil {
  12. fmt.Println(e.Map())
  13. fmt.Println(e.FirstItem())
  14. fmt.Println(e.FirstString())
  15. }
  16. // May Output:
  17. // passport map[required:账号不能为空 length:账号长度应当在6到16之间]
  18. // 账号不能为空

可以看到,我们想要校验结果满足顺序性,只需要将rules参数的类型修改为[]string,按照一定的规则设定即可,并且msgs参数既可以定义到rules参数中,也可以分开传入(使用第三个参数)。

其中: - 键名名称 必需字段(如果结合struct使用为非必需字段),指需要校验的map中的键名名称,需要和params参数中的键名一致。 - 必需字段,多个规则以|符号连接,注意规则顺序需要和错误提示中的顺序一致,以便一一对应。 - 错误提示 非必需字段,表示自定义的错误提示信息,当规则校验时对默认的错误提示信息进行覆盖;该字段也可以通过msgs参数传入覆盖。

可选校验规则

当给定的数据校验规则中不包含required*规则时,表示该规则不是一个必须规则,当键值为nil或者空字符串时,将会忽略其校验。我们将之前的例子改一下,去掉passport键名的required规则:

  1. params := map[string]interface{}{
  2. "passport": "",
  3. "password": "123456",
  4. "password2": "1234567",
  5. }
  6. rules := []string{
  7. "passport@length:6,16#账号不能为空|账号长度应当在:min到:max之间",
  8. "password@required|length:6,16|same:password2#密码不能为空|密码长度应当在:min到:max之间|两次密码输入不相等",
  9. "password2@required|length:6,16#",
  10. }
  11. if e := gvalid.CheckMap(params, rules); e != nil {
  12. fmt.Println(e.Map())
  13. fmt.Println(e.FirstItem())
  14. fmt.Println(e.FirstString())
  15. }
  16. // Output:
  17. // map[same:两次密码输入不相等]
  18. // 两次密码输入不相等