Spring Boot电商项目14：用户模块三：API统一返回对象；（其中，涉及了【使用枚举类，来管理接口请求失败时，将要向前端返回的（状态码）和（错误信息）】；）

原创

已于 2022-02-16 07:06:32 修改 · 1.5k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #后端 #java

于 2022-02-15 05:04:41 首次发布

说明：

（1）本篇博客合理性说明：【首先，项目的接口，无论处理成功与否，都会返回一些东西】→【而，接口的返回格式，是要求统一的】→【为此，既然接口的返回格式是统一的，那么我们就可以创建一个统一返回对象】→【那么，以后当我们在处理接口返回的时候，就可以使用这个统一返回对象】→【这样做，既规范，效率也高】；

（2）本篇博客需要注意点：

● 【API统一返回对象】的编写，十分重要；

● 使用枚举类，来管理接口返回错误的策略，十分重要；

1.【接口的返回】要求格式统一；

其中：

（1）“status”是一个状态码，是一个数字；不同的数字，代表不同的情况；后面我们也会用不同的状态码，去代表不同的异常；

（2）“msg”是一个描述信息，可以明确的告诉前端【这次请求后端接口，是成功了还是失败了】；

（3）“data”是最重要的部分，“data”是接口返回的信息；

2.为此，我们可以创建一个【统一返回对象】：ApiRestResponse类；

ApiRestResponse类：

package com.imooc.mall.common;

import com.imooc.mall.exception.ImoocMallExceptionEnum;

/**
 * 描述：   API统一（通用）返回对象；
 */
public class ApiRestResponse<T> {
    private Integer status;//状态码
    private String msg;//描述信息
    private T data;//接口返回的数据

    private static final int OK_CODE = 10000;
    private static final String OK_MSG = "SUCCESS";