阿里巴巴状态码

阿里巴巴状态码规范

1.状态码分类

• 2xx 成功类

  • 200 OK: 请求成功
  • 201 Created: 资源创建成功

• 4xx 客户端错误类

  • 400 Bad Request: 参数校验失败
  • 401 Unauthorized: 未登录或token过期
  • 403 Forbidden: 权限不足
  • 404 Not Found: 资源不存在
  • 429 Too Many Requests: 请求频次超限

• 5xx 服务端错误类

  • 500 Internal Server Error: 系统内部异常
  • 503 Service Unavailable: 服务不可用
  • 504 Gateway Timeout: 网关超时

2.阿里巴巴特有状态码

• 业务异常码: 通常以A开头的四位数字
  • A001: 业务参数错误
  • A002: 业务逻辑异常

3.最佳实践

• 使用统一的 [Result](file://D:\Desktop\ai_wei\projects\F-XA-01\code\f-xa-01-api\f-xa-01-api-common\src\main\java\com\aiwei\common\result\Result.java#L10-L41) 对象封装响应
• 通过 [code](file://D:\Desktop\ai_wei\projects\F-XA-01\code\f-xa-01-api\f-xa-01-api-pojo\src\main\java\com\aiwei\pojo\entity\Role.java#L37-L39) 字段表示状态码
• message字段提供错误描述
• [data](file://D:\Desktop\ai_wei\projects\F-XA-01\code\f-xa-01-api\f-xa-01-api-common\src\main\java\com\aiwei\common\result\Result.java#L15-L15) 字段承载业务数据