小技巧分享:在 Go 如何实现枚举?

开发 后端
Go 语言并没有 enum 关键字,有用过 Protobuf 等的小伙伴知道,Go 语言只是 ”有限的枚举“ 支持,我们也会用常量来定义,枚举值也需要有字面意思的映射。

[[404637]]

本文转载自微信公众号「脑子进煎鱼了」,作者陈煎鱼。转载本文请联系脑子进煎鱼了公众号。

大家好,我是煎鱼。

在日常的业务工程开发中,我们常常会有使用枚举值的诉求,枚举控的好,测试值边界一遍过...

有的小伙伴会说,在 Go 语言不是有 iota 类型做枚举吗,那煎鱼你这篇文章还讲什么?

讲道理,Go 语言并没有 enum 关键字,有用过 Protobuf 等的小伙伴知道,Go 语言只是 ”有限的枚举“ 支持,我们也会用常量来定义,枚举值也需要有字面意思的映射。

示例

在一些业务场景下,是没法达到我们的诉求的。示例如下:

  1. type FishType int 
  2.  
  3. const ( 
  4.  A FishType = iota 
  5.  B 
  6.  C 
  7.  D 
  8.  
  9. func main() { 
  10.  fmt.Println(A, B, C, D) 

输出结果为:“0 1 2 3”。这时候就一脸懵逼了...枚举值,应该除了键以外,还得有个对应的值。也就是这个 “0 1 2 3” 分别对应着什么含义,是不是应该输出 ”A B C D“

但 Go 语言这块就没有直接的支撑了,因此这不是一个完整的枚举类型的实现。

同时假设我们传入超过 FishType 类型声明范围的枚举值,在 Go 语言中默认也不会有任何控制,是正常输出的。

上述这种 Go 枚举实现,在某种情况下是不完全的,严格意义上不能成为 enum(枚举)。

使用 String 做枚举

如果要支持枚举值的对应输出的话,我们可以通过如下方式:

  1. type FishType int 
  2.  
  3. const ( 
  4.  A FishType = iota 
  5.  B 
  6.  C 
  7.  D 
  8.  
  9. func (f FishType) String() string { 
  10.  return [...]string{"A""B""C""D"}[f] 

运行程序:

  1. func main() { 
  2.  var f FishType = A 
  3.  fmt.Println(f) 
  4.  switch f { 
  5.  case A: 
  6.   fmt.Println("脑子进煎鱼了"
  7.  case B: 
  8.   fmt.Println("记得点赞"
  9.  default
  10.   fmt.Println("别别别..."
  11.  } 

输出结果:

  1. 脑子进煎鱼了 

我们可以借助 Go 中 String 方法的默认约定,针对于定义了 String 方法的类型,默认输出的时候会调用该方法。

这样就可以达到获得枚举值的同时,也能拿到其映射的字面意思。

自动生成 String

但每次手动编写还是比较麻烦的。在这一块,我们可以利用官方提供的 cmd/string 来快速实现。

我们安装如下命令:

  1. go install golang.org/x/tools/cmd/stringer 

在所需枚举值上设置 go:generate 指令:

  1. //go:generate stringer -type=FishType 
  2. type FishType int 

在项目根目录执行:

  1. go generate ./... 

会在根目录生成 fishtype_string.go 文件:

  1. ├── fishtype_string.go 
  2. ├── go.mod 
  3. ├── go.sum 
  4. └── main.go 

fishtype_string 文件内容:

  1. package main 
  2.  
  3. import "strconv" 
  4.  
  5. const _FishType_name = "ABCD" 
  6.  
  7. var _FishType_index = [...]uint8{0, 1, 2, 3, 4} 
  8.  
  9. func (i FishType) String() string { 
  10.  if i < 0 || i >= FishType(len(_FishType_index)-1) { 
  11.   return "FishType(" + strconv.FormatInt(int64(i), 10) + ")" 
  12.  } 
  13.  return _FishType_name[_FishType_index[i]:_FishType_index[i+1]] 

所生成出来的文件,主要是根据枚举值和映射值做了个映射,且针对超出枚举值的场景进行了判断:

  1. func main() { 
  2.  var f1 FishType = A 
  3.  fmt.Println(f1) 
  4.  var f2 FishType = E 
  5.  fmt.Println(f2) 

执行 go run . 查看程序运行结果:

  1. $ go run . 
  2. FishType(4) 

总结

在今天这篇文章中,我们介绍了如何在 Go 语言实现标准的枚举值,虽然有些繁琐,但整体不会太难。

 

也有小伙伴已经在社区中提出了 ”proposal: spec: add typed enum support“ 的提案,相信未来有机会能看到 Go 自身支持 enum(枚举)的那一天。

 

责任编辑:武晓燕 来源: 脑子进煎鱼了
相关推荐

2011-07-15 17:35:19

JavaScript

2012-09-11 14:55:29

Moosefs

2010-02-24 12:49:39

WCF枚举

2011-07-12 18:20:45

降权

2011-07-11 10:24:09

PHP

2011-06-28 13:56:43

JAVA

2021-06-07 23:51:16

MacGo服务

2011-07-05 14:59:17

java

2011-06-24 17:39:08

长尾关键词

2011-06-13 17:36:43

外链

2024-01-03 08:53:35

JavaScrip编程语言NodeJS

2009-12-10 10:24:24

PHP写入文件

2010-03-05 13:29:00

Python增量备份

2010-01-28 17:12:45

Android闪屏

2009-04-09 15:40:01

JSONJavaScript枚举

2009-12-03 16:54:36

PHP获取中国IP段

2010-02-24 11:22:04

WCF方法重载

2010-03-03 10:10:33

Python实现Soc

2009-12-30 16:19:49

Silverlight

2010-01-27 18:06:03

Android短信发送
点赞
收藏

51CTO技术栈公众号