规范
开发
为了开发上高效、容错、有协作性,提高代码质量并降低维护成本,请遵循阿里巴巴编码规范,建议idea安装Alibaba Java Coding Guidelines插件
HttpStatus
为了方便接口统一管理,前、后端异常处理请遵循以下规则
状态码 | 名称 |
---|---|
200 | 请求成功 |
400 | 请求参数有误 eg:后端表单验证未通过 |
401 | 会话失效 eg:登录失败、被踢出,在其他地方登录,管理员踢出 |
403 | 已登录,无权访问 eg:无权限 |
500 | 错误 |
响应码
结构
代码 | 长度 | 说明 |
---|---|---|
A | 1 | 消息级别,eg: 0-成功、1-信息、2-警告、3-错误 |
BB | 2 | 模块代码 |
CCC | 3 | 具体代码,其中000 表示成功 |
公用响应码
以下为框架中定义的公用响应码,并在EUtil.ajax
中默认处理
响应码 | 说明 |
---|---|
000000 | 成功 |
300400 | 语义有误,当前请求无法被服务器理解。除非进行修改,否则客户端不应该重复提交这个请求 请求参数有误 |
300401 | 表示用户没有权限(令牌、用户名、密码错误) |
300403 | 表示用户得到授权(与401错误相对),但是访问是被禁止的 |
300404 | 用户发出的请求针对的是不存在的记录,服务器没有进行操作 |
100500 | info 级别提示 |
200500 | warn 级别提示 |
300500 | error 级别提示 |
版本号
版本格式:主版本号.次版本号.修订号,版本号递增规则如下:
主版本号:当你做了不兼容的 API 修改,
次版本号:当你做了向下兼容的功能性新增,
修订号:当你做了向下兼容的问题修正。
先行版本号及版本编译元数据可以加到“主版本号.次版本号.修订号”的后面,作为延伸。
版本号同时用于静态资源缓存失效规则,避免让用户手动清理缓存