新项目代码规范

Result类

结构

{
  "code": 0,
  "msg": "ok",
  "data": null
}
  • code:为错误编码,只能是int
  • msg:为错误信息,只能是字符串
  • data:为数据,可以是任何类型

code的定义

说明
0成功
大于0为业务错误,可直接将msg展示给前端
小于0为系统错误,不应将msg展示给前端

性别

  • 字段名:gender
说明
0未知
1
2

版本号

字符串格式

<major>.<minor>.<patch> 或 v<major>.<minor>.<patch>

三段必须都有,不能省略,如:v1.0.0,v1.2.3,2.5.7

  • major为大版本,升级major时可不向下兼容
  • minor为功能版本,升级minor时应尽可能向下兼容
  • patch为补丁版本,升级patch时必须向下兼容,升级patch版本时不应提供新功能或新接口

数字格式

正整数,最后三位代表patch,中间三位代表minor,最前面的若干位代表major

如:1000000为v1.0.0,21001134代表v21.1.134

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注