Go枚举生成器go-enum：类型安全枚举创建与验证最佳实践

go-enum by cristiano-pacheco/ai-rules

1 周安装量

GitHub

安装命令

npx skills add https://github.com/cristiano-pacheco/ai-rules --skill go-enum

开发 Go 代码规范

🇨🇳中文介绍

Go Enum

遵循 GO 模块化架构规范生成类型安全的 Go 枚举。

何时使用

为模块创建类型安全的枚举
定义带有验证的领域常量
添加经过验证的枚举类型（例如状态、类别、方法）

模式

将枚举文件放置在 internal/modules/<module>/enum/<name>_enum.go。

每个枚举文件包含：

每个枚举值的字符串常量
用于 O(1) 查找的验证映射
枚举结构体类型
带有验证的构造函数 (New<Type>Enum)
String() 方法
私有验证函数 (validate<Type>)

注意：当文件中包含带有方法的结构体时，不要添加独立的函数。应使用结构体的私有方法。对于枚举文件，私有的 validate<Type> 函数是可以接受的，因为枚举结构体是一个简单值包装器，没有复杂的方法。

示例 — 枚举文件

对于 monitor 模块中名为 "ContactType"、值为 "email" 和 "webhook" 的枚举：

🇺🇸English

Go Enum

Generate type-safe Go enums following GO modular architecture conventions.

When to Use

Create type-safe enumerations for a module
Define domain constants with validation
Add validated enum types (e.g., status, category, method)

Pattern

Place enums in internal/modules/<module>/enum/<name>_enum.go.

Each enum file contains:

String constants for each enum value
Validation map for O(1) lookups
Enum struct type
Constructor with validation (New<Type>Enum)
String() method
Private validation function (validate<Type>)

Note : When a file contains a struct with methods, do not add standalone functions. Use private methods on the struct instead. For enum files, the private validate<Type> function is acceptable because the enum struct is a simple value wrapper without complex methods.

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

示例 — 错误条目

错误定义位于 internal/modules/<module>/errs/errs.go 并使用 bricks 包中的 errs.New：

package errs

import (
	"net/http"

	"github.com/cristiano-pacheco/bricks/pkg/errs"
)

var (
	ErrInvalidContactType = errs.New("MONITOR_01", "Invalid contact type", http.StatusBadRequest, nil)
)

errs.New 签名：errs.New(code string, message string, httpStatus int, metadata any)

code：<MODULE>_<NN> — 大写模块前缀，两位顺序号（例如 MONITOR_01，IDENTITY_25）。阅读现有的 errs.go 文件以找到下一个可用的编号。
message：句子大小写，以大写字母开头（例如 "Invalid contact type"）。保持简短且对用户安全。
httpStatus：对于无效的枚举值使用 http.StatusBadRequest。
metadata：对于枚举验证错误，始终为 nil。

确定枚举详情：
- 枚举名称（例如 ContactType，UserStatus，PKCEMethod）
- 可能的值（例如 ["email", "webhook"]，["active", "inactive"]）
- 目标模块（例如 monitor，identity）
将错误添加到 internal/modules/<module>/errs/errs.go：
- 阅读文件以找到下一个可用的顺序错误代码编号
- 添加：ErrInvalid<EnumName> = errs.New("<MODULE>_<NN>", "Invalid <enum name>", http.StatusBadRequest, nil)
- 确保导入了 net/http 和 github.com/cristiano-pacheco/bricks/pkg/errs
在 internal/modules/<module>/enum/<snake_case_name>_enum.go 创建枚举文件：
- 导入：github.com/cristiano-pacheco/pingo/internal/modules/<module>/errs
- 按照上述结构包含所有六个组件

文件：<snake_case>_enum.go（例如 contact_type_enum.go，user_status_enum.go）
常量：<EnumName><Value>（例如 ContactTypeEmail，UserStatusActive）
验证映射：valid<EnumName>s（非导出，复数形式，例如 validContactTypes）
结构体：<EnumName>Enum（例如 ContactTypeEnum）
构造函数：New<EnumName>Enum(value string) (<EnumName>Enum, error)
验证器：validate<EnumName>(value string) error（非导出，单数形式）
错误：internal/modules/<module>/errs/errs.go 中的 ErrInvalid<EnumName>

阅读 internal/modules/<module>/errs/errs.go 以找到下一个顺序错误代码
将 ErrInvalid<EnumName> 添加到 internal/modules/<module>/errs/errs.go
创建 internal/modules/<module>/enum/<snake_case_name>_enum.go
定义所有字符串常量
使用所有常量创建验证映射 (map[string]struct{})
定义带有私有 value string 字段的枚举结构体
实现构造函数 New<EnumName>Enum(value string) (<EnumName>Enum, error)
实现 String() string 方法
实现私有函数 validate<EnumName>(value string) error

// 验证并包装输入值
contactType, err := enum.NewContactTypeEnum(input)
if err != nil {
    return err
}
fmt.Println(contactType.String()) // "email"

// 当值在编译时已知时，直接使用常量
const defaultType = enum.ContactTypeEmail

完成枚举实现后，请确保使用有效和无效值测试构造函数，以确认验证按预期工作。

运行 make lint 和 make nilaway 以确保代码质量且没有空指针问题。

Example — Enum File

For an enum named "ContactType" with values "email" and "webhook" in the monitor module:

package enum

import "github.com/cristiano-pacheco/pingo/internal/modules/monitor/errs"

const (
	ContactTypeEmail   = "email"
	ContactTypeWebhook = "webhook"
)

var validContactTypes = map[string]struct{}{
	ContactTypeEmail:   {},
	ContactTypeWebhook: {},
}

type ContactTypeEnum struct {
	value string
}

func NewContactTypeEnum(value string) (ContactTypeEnum, error) {
	if err := validateContactType(value); err != nil {
		return ContactTypeEnum{}, err
	}
	return ContactTypeEnum{value: value}, nil
}

func (e ContactTypeEnum) String() string {
	return e.value
}

func validateContactType(contactType string) error {
	if _, ok := validContactTypes[contactType]; !ok {
		return errs.ErrInvalidContactType
	}
	return nil
}

Example — Error Entry

Errors live in internal/modules/<module>/errs/errs.go and use errs.New from the bricks package:

package errs

import (
	"net/http"

	"github.com/cristiano-pacheco/bricks/pkg/errs"
)

var (
	ErrInvalidContactType = errs.New("MONITOR_01", "Invalid contact type", http.StatusBadRequest, nil)
)

errs.New signature: errs.New(code string, message string, httpStatus int, metadata any)

code : <MODULE>_<NN> — uppercase module prefix, two-digit sequential number (e.g., MONITOR_01, IDENTITY_25). Read the existing errs.go to find the next available number.
message : Sentence case, starting with uppercase (e.g., "Invalid contact type"). Keep it short and user-safe.
httpStatus : Use http.StatusBadRequest for invalid enum values.
metadata : Always nil for enum validation errors.

Identify enum details :
- Enum name (e.g., ContactType, UserStatus, PKCEMethod)
- Possible values (e.g., ["email", "webhook"], ["active", "inactive"])
- Target module (e.g., monitor, identity)
Add error tointernal/modules/<module>/errs/errs.go:
- Read the file to find the next available sequential error code number
- Add: ErrInvalid<EnumName> = errs.New("<MODULE>_<NN>", "Invalid <enum name>", http.StatusBadRequest, nil)
- Ensure net/http and github.com/cristiano-pacheco/bricks/pkg/errs are imported
Create the enum file at internal/modules/<module>/enum/<snake_case_name>_enum.go:
- Import: github.com/cristiano-pacheco/pingo/internal/modules/<module>/errs
- Follow the structure above with all six components

File : <snake_case>_enum.go (e.g., contact_type_enum.go, user_status_enum.go)
Constants : <EnumName><Value> (e.g., ContactTypeEmail, UserStatusActive)
Validation map : valid<EnumName>s (unexported, plural, e.g., validContactTypes)
Struct : <EnumName>Enum (e.g., ContactTypeEnum)
Constructor : New<EnumName>Enum(value string) (<EnumName>Enum, error)
Validator : validate<EnumName>(value string) error (unexported, singular)
Error : ErrInvalid<EnumName> in internal/modules/<module>/errs/errs.go

Implementation Checklist

Read internal/modules/<module>/errs/errs.go to find the next sequential error code
Add ErrInvalid<EnumName> to internal/modules/<module>/errs/errs.go
Create internal/modules/<module>/enum/<snake_case_name>_enum.go
Define all string constants
Create validation map (map[string]struct{}) with all constants
Define enum struct with private value string field
Implement constructor New<EnumName>Enum(value string) (<EnumName>Enum, error)
Implement String() string method
Implement validate<EnumName>(value string) error private function

// Validate and wrap an input value
contactType, err := enum.NewContactTypeEnum(input)
if err != nil {
    return err
}
fmt.Println(contactType.String()) // "email"

// Use constants directly when value is known at compile time
const defaultType = enum.ContactTypeEmail

When finished the enum implementation, ensure to test the constructor with valid and invalid values to confirm validation works as expected.

Run make lint and make nilaway to ensure code quality and no nil pointer issues.

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

109,600 周安装

Go枚举生成器go-enum：类型安全枚举创建与验证最佳实践

🇨🇳中文介绍

Go Enum

何时使用

模式

示例 — 枚举文件

🇺🇸English

Go Enum

When to Use

Pattern

相关 Skills

示例 — 错误条目

生成步骤

命名约定

实现清单

使用模式

Example — Enum File

Example — Error Entry

Generation Steps

Naming Conventions

Implementation Checklist

Usage Pattern

最新 Skills