如何在Golang中用反射实现枚举校验 分享String方法反射调用方案

String()

String()

package main

import (
    "fmt"
    "reflect"
)

// Status 定义一个枚举类型
type Status int

// 定义枚举的常量值
const (
    StatusUnknown   Status = iota // 0
    StatusPending                 // 1
    StatusApproved                // 2
    StatusRejected                // 3
)

// String 方法实现了 fmt.Stringer 接口，提供枚举值的字符串表示
func (s Status) String() string {
    switch s {
    case StatusPending:
        return "待处理"
    case StatusApproved:
        return "已批准"
    case StatusRejected:
        return "已拒绝"
    case StatusUnknown:
        return "未知状态"
    default:
        // 对于无效值，String方法也能提供有用的信息
        return fmt.Sprintf("无效状态(%d)", s)
    }
}

// IsValid 方法用于判断枚举值是否有效
func (s Status) IsValid() bool {
    switch s {
    case StatusPending, StatusApproved, StatusRejected, StatusUnknown:
        return true
    default:
        return false
    }
}

// ValidatableEnum 是一个通用接口，要求枚举类型实现 String() 和 IsValid() 方法
type ValidatableEnum interface {
    String() string
    IsValid() bool
}

// ValidateEnumByReflection 使用反射校验枚举值
// 参数 val 预期是一个实现了 ValidatableEnum 接口的值
func ValidateEnumByReflection(val interface{}) error {
    v := reflect.ValueOf(val)
    t := reflect.TypeOf(val)

    // 如果传入的是指针，我们需要获取其指向的元素
    if v.Kind() == reflect.Ptr {
        v = v.Elem()
        t = t.Elem()
    }

    // 检查类型是否实现了 ValidatableEnum 接口
    enumInterfaceType := reflect.TypeOf((*ValidatableEnum)(nil)).Elem()
    if !t.Implements(enumInterfaceType) {
        return fmt.Errorf("类型 %s (Kind: %s) 未实现 ValidatableEnum 接口，无法进行通用枚举校验", t.Name(), t.Kind())
    }

    // 通过反射调用 IsValid() 方法
    isValidMethod := v.MethodByName("IsValid")
    if !isValidMethod.IsValid() {
        // 理论上如果 Implements 检查通过，这里不应该失败
        return fmt.Errorf("类型 %s 缺少 IsValid 方法，但已声明实现 ValidatableEnum 接口", t.Name())
    }

    // 调用 IsValid 方法，并获取结果
    // Call 方法的参数是 []reflect.Value，这里没有参数所以是 nil
    results := isValidMethod.Call(nil)
    if len(results) == 0 || results[0].Kind() != reflect.Bool {
        return fmt.Errorf("IsValid 方法返回类型不正确，预期为 bool")
    }

    if !results[0].Bool() {
        // 如果 IsValid 返回 false，尝试调用 String() 方法获取更详细的错误信息
        stringMethod := v.MethodByName("String")
        if stringMethod.IsValid() && stringMethod.Type().NumOut() == 1 && stringMethod.Type().Out(0).Kind() == reflect.String {
            strResults := stringMethod.Call(nil)
            return fmt.Errorf("无效的枚举值: %s", strResults[0].String())
        }
        return fmt.Errorf("无效的枚举值: %v", val) // Fallback到原始值
    }

    return nil // 校验通过
}

func main() {
    // 校验有效枚举值
    err1 := ValidateEnumByReflection(StatusApproved)
    fmt.Printf("校验 StatusApproved (有效): %v\n", err1) // Output: nil

    // 校验无效枚举值
    err2 := ValidateEnumByReflection(Status(99))
    fmt.Printf("校验 Status(99) (无效): %v\n", err2) // Output: 无效的枚举值: 无效状态(99)

    // 校验另一个类型 (未实现接口)
    type MyInt int
    var mi MyInt = 10
    err3 := ValidateEnumByReflection(mi)
    fmt.Printf("校验 MyInt (未实现接口): %v\n", err3) // Output: 类型 MyInt (Kind: int) 未实现 ValidatableEnum 接口...

    // 校验指针类型
    sPtr := StatusApproved
    err4 := ValidateEnumByReflection(&sPtr)
    fmt.Printf("校验 &StatusApproved (指针): %v\n", err4) // Output: nil

    // 校验无效指针类型
    invalidSPtr := Status(100)
    err5 := ValidateEnumByReflection(&invalidSPtr)
    fmt.Printf("校验 &Status(100) (无效指针): %v\n", err5) // Output: 无效的枚举值: 无效状态(100)
}

const

iota

switch

IsValid()

String()

ValidatableEnum

String()

String()

Status

99

String()

fmt.Sprintf("无效状态(%d)", s)

String()

String()

IsValid()