466 字

2 分钟

【Golang】使用反射实现验证struct必填字段是否为空

2021-08-20

浏览量加载中...

0x0#

反射：#

golang的reflect包实现了运行时的反射能力。reflect包中有两个重要函数：

reflect.TypeOf 获取数据类型信息，其类型为reflect.Type
reflect.ValueOf 获取数据运行时的信息，其类型为reflect.Value

Tag#

golang的struct中的每一个字段(field)后添加一段注释，称为 field tag，最经典就是构建json的struct，例如：

1
type Login struct{
2
  UserName string `json:"user_name"`
3
  Password string `json:"password"`
4
}

其中 json:"user_name" json:"password"就是 field tag

0x1#

假设现有一 struct：

1
type Note struct {
2
  Time    time.Time
3
  Content string
4
  Remarks string
5
}

我们想要指定一些字段非空，例如：Content != ""

按照一般通用的方法就是一个一个用if判断：

1
if content != "" { ... } else { ... }

如果只有几个字段需要这样判断还可以这样写。但如果有许多个字段或不同字段有不同类型，这样写的话就是一堆 if else，就不是很优雅。

0x2#

现在可以使用反射来更为优雅实现这一功能。只需要在struct需要非空的字段后添加一个 tag来标记，这个tag可以自定义，如：

1
type Note struct {
2
  Time    time.Time `must:"true"`
3
  Content string    `must:"true"`
4
  Remarks string
5
}

其中 must:"true"为我们自定义的tag，表示该字段非空。

0x3#

我们可以通过反射来获取struct字段的tag：

1
fmt.Println(reflect.TypeOf(&note).Elem().Field(0).Tag.Get("must"))  //获取第一个字段tag中"must"的值

0x4#

完整实现代码：

1
type Note struct {
2
  Time    time.Time `must:"true"`
3
  Content string    `must:"true"`
4
  Remarks string
5
}
6

7
func validator(value interface{}) {
8
  val := reflect.ValueOf(value).Elem() //获取字段值
9
  typ := reflect.TypeOf(value).Elem()  //获取字段类型
10
  // 遍历struct中的字段
11
  for i := 0; i < typ.NumField(); i++ {
12
    // 当struct中的tag为 must:"true" 且当前字段值为空值时，输出
13
    if typ.Field(i).Tag.Get("must") == "true" && val.Field(i).IsZero() {
14
      fmt.Println("Fail:", typ.Field(i).Name, "is null")
15
      return
16
    }
17
  }
18
  fmt.Println("Pass")
19
}
20

21
func main() {
22
  note1 := Note{
23
    Time:    time.Now(),
24
    Content: "content",
25
    Remarks: "",
26
  }
27
  validator(&note1)
28
  // Pass
29

30
  note2 := Note{
31
    Time:    time.Now(),
32
    Content: "",
33
    Remarks: "",
34
  }
35
  validator(&note2)
36
  // Fail: Content is null
37
}

支持与分享

如果这篇文章对你有帮助，欢迎分享给更多人或打赏支持！

打赏

【Golang】使用反射实现验证struct必填字段是否为空

https://rehtt.com/posts/249/

作者

Rehtt

发布于

2021-08-20

许可协议

CC BY-NC-SA 4.0

【Golang】关于time包的一些记录

【杂项】使用gocv库实现视频转终端字符画

评论区

分享你的想法，与大家交流讨论

加载更多…

音乐

音乐