Skip to content

枚举值说明 ​

后端枚举统一定义在 server_api/internal/common/enums,按模块分文件管理;接口参数校验使用枚举集合(IsValidXxx)判断,不使用数值范围。下表三列依次为:枚举值、枚举值文件、枚举说明。

会员 ​

枚举值枚举值文件枚举说明
性别:1 男 / 2 女 / 3 未知server_api/internal/common/enums/member.go会员 gender 字段;用户端「修改资料」用 IsValidGender 校验,不传表示不修改
注册来源:1 微信小程序 / 2 微信公众号 / 3 iOS / 4 Android / 5 H5 / 6 支付宝小程序 / 7 百度小程序 / 8 抖音小程序 / 9 QQ小程序 / 10 快手小程序server_api/internal/common/enums/member.go会员 register_source 字段;同时用于用户端请求头 X-Platform-Source 和支付配置用户端渠道

文件存储 ​

枚举值枚举值文件枚举说明
存储渠道:local 本地 / alioss 阿里云OSS / cos 腾讯云COS / qiniu 七牛云Kodo / minio MinIOserver_api/internal/common/enums/storage.go管理端「存储渠道」新增或修改时,用 IsValidStorageChannel 校验,不在枚举内返回业务错误
默认渠道标志:0 否 / 1 是server_api/internal/common/enums/storage.go全局仅允许一个默认渠道,禁用状态的渠道不能设为默认

通用状态 ​

枚举值枚举值文件枚举说明
启用状态:1 启用 / 2 禁用server_api/internal/common/enums/base.go管理员、角色等通用 status 字段

菜单 ​

枚举值枚举值文件枚举说明
菜单类型:1 目录 / 2 菜单页面 / 3 按钮server_api/internal/common/enums/menu.go菜单三级权限资源,按钮级用于接口权限控制
菜单状态:1 显示 / 2 隐藏server_api/internal/common/enums/menu.go控制菜单在前端侧边栏是否展示

登录与客户端 ​

枚举值枚举值文件枚举说明
登录状态:1 在线 / 2 已退出 / 3 被踢下线或禁用server_api/internal/common/enums/login.go登录流水状态,管理端可查看并强制下线
客户端类型:admin 管理端 / api 用户端server_api/internal/common/enums/login.go双端登录态隔离,令牌不可跨端使用
超级管理员标志:0 否 / 1 是server_api/internal/common/enums/login.go超级管理员受保护,不可删除或禁用

渠道配置 ​

枚举值枚举值文件枚举说明
短信服务商:1 阿里云 / 2 腾讯云 / 3 短信宝 / 4 SMS.cn / 5 云片server_api/internal/common/enums/channel.go短信渠道配置
短信默认渠道:0 否 / 1 是server_api/internal/common/enums/channel.go多个渠道可启用,但只能有一个启用的默认渠道
短信模板类型:1 验证码 / 2 通知 / 3 营销server_api/internal/common/enums/channel.go模板类型决定下发场景与限流策略
短信发送状态:1 待发送 / 2 成功 / 3 失败server_api/internal/common/enums/channel.go短信发送记录状态,供管理端审计
微信应用类型:1 公众号 / 2 开放平台 / 3 小程序server_api/internal/common/enums/channel.go微信配置类型
支付渠道:1 微信支付 / 2 支付宝server_api/internal/common/enums/payment.go支付配置、支付尝试和财务订单支付渠道
支付场景:1 微信小程序 / 2 微信JSAPI / 3 微信H5 / 4 微信APP / 5 支付宝小程序 / 6 支付宝H5 / 7 支付宝APPserver_api/internal/common/enums/payment.go根据当前用户端和浏览器环境筛选可用支付产品
支付单状态:1 待支付 / 2 支付中 / 3 已支付 / 4 已关闭 / 5 部分退款 / 6 已退款server_api/internal/common/enums/payment.go核心统一支付单状态机
支付尝试状态:1 已初始化 / 2 待支付 / 3 成功 / 4 失败 / 5 关闭server_api/internal/common/enums/payment.go每次渠道选择对应一条支付尝试
支付回调状态:1 已接收 / 2 已验签 / 3 已处理 / 4 失败server_api/internal/common/enums/payment.go第三方支付回调审计状态

平台配置 ​

枚举值枚举值文件枚举说明
平台类型:1 管理端 / 2 用户端server_api/internal/common/enums/platform.go平台基础配置按端隔离(名称、Logo、用户端默认资料等)

消息 ​

枚举值枚举值文件枚举说明
消息类型:system 系统通知 / order 订单通知 / marketing 营销消息 / interactive 互动消息 / service 客服消息server_api/internal/common/enums/message.go消息业务分类,字符串编码,用于列表筛选与推送策略
消息跳转类型:0 不跳转 / 1 站内页 / 2 H5链接 / 3 小程序页面server_api/internal/common/enums/message.go消息与模板的跳转方式,0 表示不跳转
消息发送来源:1 系统自动 / 2 后台手动发送 / 3 业务触发server_api/internal/common/enums/message.go站内消息 send_source 字段
消息阅读状态:0 未读 / 1 已读server_api/internal/common/enums/message.go站内消息 is_read 字段,0/1 标志位
推送渠道:1 微信小程序 / 6 支付宝小程序 / 7 百度小程序 / 8 抖音小程序 / 9 QQ小程序 / 10 快手小程序server_api/internal/common/enums/message.go小程序订阅消息推送渠道,取值与会员注册来源一致;站内消息本身由 sys_message 承载,不属于推送渠道
推送状态:1 待发送 / 2 成功 / 3 失败server_api/internal/common/enums/message.go小程序推送记录状态,供管理端审计

插件 ​

枚举值枚举值文件枚举说明
插件状态:1 启用 / 2 停用server_api/internal/common/enums/plugin.go已安装插件的启停状态
插件迁移执行状态:1 成功 / 2 失败server_api/internal/common/enums/plugin.go安装或升级时 SQL 迁移执行结果
插件安装操作类型:1 安装 / 2 升级server_api/internal/common/enums/plugin.go安装记录的操作类型
插件安装执行状态:1 成功 / 2 失败server_api/internal/common/enums/plugin.go安装记录的执行结果
插件菜单父级来源:1 清单默认 / 2 管理员自定义server_api/internal/common/enums/plugin.go决定插件菜单挂载位置

业务响应码 ​

枚举值枚举值文件枚举说明
0 成功 / 400 参数错误 / 401 未登录或登录失效 / 403 无权限 / 500 业务失败 / 503 依赖服务不可用server_api/pkg/response/response.go统一响应体 code 字段;HTTP 状态码恒为 200(鉴权与权限中间件另返回 401/403/503),客户端以 code 判断业务结果

维护约定 ​

  1. 新增枚举:在 enums 包对应文件添加常量,并登记到 ValidXxx 集合;
  2. 校验:参数校验调用 IsValidXxx,禁止使用数值范围判断;