# 约定

# 后端

# 编码规范

后端开发请遵循 开发规范, 建议Idea安装代码检查 Alibaba Java Coding Guidelines 插件,使用方法 (opens new window)

# 约定

为统一后端返回给前端的数据格式,方便前端做统一错误处理,Controller统一使用自定义注解 @ResponseResult 对后端返回数据进行包装, 以统一数据格式。

{
    success: boolean; // 是否成功
    timeStamp: number; // 时间戳
    data?: any; // 响应数据
    errorCode?: string; // 错误码
    errorMessage?: string; // 错误信息
    showType?: number; // 错误显示方式:0 静默 ; 1 notification.info; 2 notification.warning; 3 notification.error; 9 page
    traceId?: string; // 方便后端故障排除:唯一的请求ID,保留字段
    host?: string; // 方便后端故障排除:当前访问服务器的主机,保留字段
}

TIP

? 表示该属性可能不存在

# 前端

Ant Design 设计规范 (opens new window)

Last Updated: 2/23/2022, 2:09:37 PM