golang通过代码注释自动生成枚举编码插件库go-enum-encoding的使用

go-enum-encoding 是一个简单高效的 Go 语言枚举编码生成工具，它可以通过代码注释自动生成枚举的编码/解码方法、测试和基准测试代码。

安装

go install github.com/nikolaydubina/go-enum-encoding@latest

特性

• 仅200行代码
• 简单、快速、严格
• 自动生成编码/解码方法、测试和基准测试

使用示例

结构体类型枚举

type Color struct{ c uint8 }

//go:generate go-enum-encoding -type=Color
var (
    UndefinedColor = Color{}  // json:""
    Red            = Color{1} // json:"red"
    Green          = Color{2} // json:"green"
    Blue           = Color{3} // json:"blue"
)

iota 常量枚举

type Size uint8

//go:generate go-enum-encoding -type=Size
const (
    UndefinedSize Size = iota // json:""
    Small                     // json:"small"
    Large                     // json:"large"
    XLarge                    // json:"xlarge"
)

生成代码

运行以下命令生成代码：

go generate

性能基准测试

生成的基准测试结果示例：

$ go test -bench=. -benchmem .
goos: darwin
goarch: arm64
pkg: github.com/nikolaydubina/go-enum-encoding/internal/testdata
cpu: Apple M3 Max
BenchmarkColor_UnmarshalText-16         752573839                1.374 ns/op           0 B/op          0 allocs/op
BenchmarkColor_AppendText-16            450123993                2.676 ns/op           0 B/op          0 allocs/op
BenchmarkColor_MarshalText-16           80059376                13.68 ns/op            8 B/op          1 allocs/op
BenchmarkImageSize_UnmarshalText-16     751743885                1.601 ns/op           0 B/op          0 allocs/op
BenchmarkImageSize_AppendText-16        500286883                2.402 ns/op           0 B/op          0 allocs/op
BenchmarkImageSize_MarshalText-16       81467318                16.46 ns/op            8 B/op          1 allocs/op
BenchmarkImageSize_String-16            856463289                1.330 ns/op           0 B/op          0 allocs/op
PASS
ok      github.com/nikolaydubina/go-enum-encoding/internal/testdata     8.561s

完整示例

下面是一个完整的示例，展示如何使用 go-enum-encoding：

package main

import (
    "encoding/json"
    "fmt"
)

// 定义颜色枚举类型
type Color struct{ c uint8 }

//go:generate go-enum-encoding -type=Color
var (
    UndefinedColor = Color{}  // json:""
    Red            = Color{1} // json:"red"
    Green          = Color{2} // json:"green"
    Blue           = Color{3} // json:"blue"
)

func main() {
    // 序列化示例
    colors := []Color{Red, Green, Blue}
    jsonData, _ := json.Marshal(colors)
    fmt.Println(string(jsonData)) // 输出: ["red","green","blue"]

    // 反序列化示例
    var decodedColors []Color
    json.Unmarshal([]byte(`["red","green","blue"]`), &decodedColors)
    fmt.Printf("%+v\n", decodedColors) // 输出: [{c:1} {c:2} {c:3}]
}

使用步骤：

1. 定义枚举类型和值
2. 添加 //go:generate 注释
3. 为每个枚举值添加 JSON 标签注释
4. 运行 go generate 生成代码
5. 在代码中使用生成的序列化/反序列化方法

这个工具特别适合需要将枚举值序列化为 JSON 或其他文本格式的场景，它生成的代码性能优异且内存效率高。