针对自有系统交互,统一使用以下数据格式:

    1. {
    2. code: null
    3. data: {}
    4. errors: null
    5. message: "操作成功"
    6. showType: 0
    7. sign: null
    8. success: true
    9. }

    与前端交互统一采用 CommonMvcResult 类来返回,其具体定义如下:

    1. public class CommonMvcResult<T> extends ToString {
    2. /** 是代表业务是否处理成功,
    3. 注意:我们对外的api只有一个状态:业务处理成功,
    4. 没有 接口调用成功 的状态
    5. 如果是收费类的接,那么 success 字段就可以用来做收费标示字段使用
    6. */
    7. private boolean success = false;
    8. /** 业务代码:在success:false时有值,前台发现请求失败了,
    9. 那么可以使用此code来实别具体的细节 **/
    10. private String code;
    11. /** 业务返回数据 **/
    12. private T data;
    13. /** 调用说明 **/
    14. private Object message;
    15. /** 更清晰的错误信息 **/
    16. private Object errors;
    17. /** 异常反馈:0:tost,1: 弹窗,理论上,前台的展示应该由后台来引导 **/
    18. private Integer showType = 0;
    19. /** 签名信息 */
    20. private String sign;
    21. }