该功能特性为实验性特性,从v2.4版本开始提供。

基本介绍

该命令用于分析指定代码目录源码,按照规范生成枚举值信息以及Go代码文件,主要用以完善OpenAPIv3文档中的枚举值维护

解决痛点

痛点描述

  • API文档中枚举值类型参数不展示枚举值可选项的问题。
  • API文档中的枚举值维护困难的问题,代码与文档脱离维护的问题。降低了与调用端,特别是前后端的协作效率

例如,以下接口定义中,任务包含多种状态,这些状态都是枚举值,如果后端来维护成本比较高,并且容易遗漏状态的维护,造成状态枚举值不完整。

痛点解决

通过工具解析源码,将枚举值解析生成到启动包Go文件中,在服务运行时自动加载枚举值,降低手工维护成本,避免枚举值遗漏维护问题。

例如,在以下接口定义中,通过工具来维护枚举值,提高了开发效率。

命令使用

$ gf gen enums -h
USAGE
    gf gen enums [OPTION]

OPTION
    -s, --src        source folder path to be parsed
    -p, --path       output go file path storing enums content
    -x, --prefixes   only exports packages that starts with specified prefixes
    -h, --help       more information about this command

EXAMPLE
    gf gen enums
    gf gen enums -p internal/boot/boot_enums.go
    gf gen enums -p internal/boot/boot_enums.go -s .
    gf gen enums -x github.com/gogf

参数说明:

名称必须默认值含义
src.指定分析的源码目录路径,默认为当前项目根目录
pathinternal/boot/boot_enums.go指定生成的枚举值注册Go代码文件路径
prefixes-只会生成包名称前缀的带有指定关键字的枚举值,支持多个前缀配置

生成文件的使用

执行gf gen enums命令生成枚举分析文件internal/boot/boot_enums.go,生成文件之后,需要在项目入口文件匿名引入:

import (
    _ "项目模块名/internal/boot"
)

如何规范定义枚举值

请参考章节:Golang枚举值管理

如何对枚举值进行校验

如果规范化定义了枚举值,并且通过命令生成了枚举值维护文件,那么在参数校验中可以使用enums规则对枚举值字段进行校验,具体规则介绍请参考章节:数据校验-校验规则






Content Menu

  • No labels

13 Comments

  1. 这个是怎么用的? 郭强 

    请参考章节:Golang枚举值管理

    在 枚举值管理 中又说参考这里??

    1. 一个是枚举值的介绍,一个是工具的介绍。

      1. 使用方式?看了两三遍没看明白 郭强 

        1. 先按枚举值管理里面的介绍,定义枚举值,文件可以自行组织,然后用这个工具去生成,然后就可以了

  2. 目前不能在request验证中使用吗?

    "enums" validation rule can only be used in struct validation currently

      1. 但是我现在在request中验证enums会报错

        type SendSmsReq struct {
        g.Meta `path:"/send-sms" method:"post" tags:"公共接口" sm:"发送短信验证码"`
        SmsType types.SmsType `p:"smsType" v:"enums"`
        Mobile string `p:"mobile"`
        }
        type SmsType string

        const (
        SmsTypeLogin SmsType = "login" // 登录
        SmsTypeUpdateMobile SmsType = "update-mobile" // 修改手机号
        )
        报出的错误:"enums" validation rule can only be used in struct validation currently
  3. 我也遇到了  

    报出的错误:"enums" validation rule can only be used in struct validation currently 

    如何解决?
  4. hwh

    同样是这个问题怎么解决

  5. 示例中 一图和二图是  string<string>   , 不太理解不定义别名是怎么生成enum的, 莫非是 type string string  ?

    另外

    validation rule can only be used in struct validation currently   如何使用结构体呢?

  6. proto文件写规则的时候是不是就用不了enums了呢?@郭强

  7. type GetOneRes struct {
        Id     uint64 `json:"id"`
        Name   string `json:"name"`
        Status Str    `json:"status"`
    }
    
    type Str string
    
    const (
        StrTest  Str = "test"
        StrTest2 Str = "test2"
        StrTest3 Str = "test3"
    )
    
    

    然后执行`gf gen enums`,在main.go中匿名引入`internal/boot`即可实现枚举维护。