up:: SpringBoot电商项目用户模块枚举类和枚举数据类型
说明：
（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";
public ApiRestResponse(Integer status, String msg, T data) {
this.status = status;
this.msg = msg;
this.data = data;
}
public ApiRestResponse(Integer status, String msg) {
this.status = status;
this.msg = msg;
}
public ApiRestResponse() {
this(OK_CODE, OK_MSG);
}
/**
* 处理成功，但接口没有返回数据（即，data是null）；
* @param <T>
* @return
*/
public static <T> ApiRestResponse<T> success() {
return new ApiRestResponse<>();
}
/**
* 处理成功，而且接口返回了数据（即，data是有数据的）；
* @param result
* @param <T>
* @return
*/
public static <T> ApiRestResponse<T> success(T result) {
ApiRestResponse<T> response = new ApiRestResponse<>();
response.setData(result);
return response;
}
/**
* 处理失败；（接口处理失败了，自然data为空，即没有返回数据的）
* @param code
* @param msg
* @param <T>
* @return
*/
public static <T> ApiRestResponse<T> error(Integer code, String msg) {
return new ApiRestResponse<>(code, msg);
}
/**
* 处理失败；（接口处理失败了，自然data为空，即没有返回数据的）；同时，这儿使用了异常枚举类
* @param ex
* @param <T>
* @return
*/
public static <T> ApiRestResponse<T> error(ImoocMallExceptionEnum ex) {
return new ApiRestResponse<>(ex.getCode(), ex.getMsg());
}
public Integer getStatus() {
return status;
}
public void setStatus(Integer status) {
this.status = status;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
public static int getOkCode() {
return OK_CODE;
}
public static String getOkMeg() {
return OK_MSG;
}
@Override
public String toString() {
return "ApiRestResponse{" +
"status=" + status +
", msg='" + msg + '\'' +
", data=" + data +
'}';
}
}说明：
（1） 因为返回中的“data”类型不固定，所以【统一返回对象】类设为了一个泛型类，“data”属性的类型设置为了泛型类型；
有关自定义泛型类的内容，如有需要可以参考【自定义泛型类】及附近相关文章；
（2） 因为，大部分情况下，前端请求接口时，都是成功的；所以，这儿我们就先定义了【请求接口成功时，“status”和“msg”应该有的值】；
（3） 根据业务情况，创建构造函数；
（4） 创建方法来应对：接口处理成功，且接口没有返回数据，即“data”为null的情况；
有关自定义泛型方法的内容，如有需要可以参考【自定义泛型方法】及附近相关文章；
（5） 创建方法来应对：接口处理成功，且接口有返回数据，即“data”有值的情况；
（6） 创建方法来应对：接口处理失败时的情况；（这儿是，没有使用枚举类的情况；所以，这种方式不推荐）
（7） 但是，这种失败时，直接传入失败时的code和msg的方式，不推荐使用；因为这种自己写方式，有点麻烦，而且非常不利于维护（比如都是“密码错误”这个错误，A程序员可能写成【code=10001,msg=“密码错误”】，B程序员可能写成【code=80019,msg=“密码不正确”】）；我们更希望把一些常见的错误给统一一下，放在一个地方；这样的话，我们遇到某个错误时，直接去拿就行了，而不用自己去写了；而，我们可以利用枚举类来做这个事情；
ImoocMallExceptionEnum枚举类：
package com.imooc.mall.exception;
/**
* 描述： 异常枚举
*/
public enum ImoocMallExceptionEnum {
NEED_USER_NAME(10001,"用户名不能为空"),
NEED_PASSWORD(10002,"密码不能为空"),
PASSWORD_TOO_SHORT(10003,"密码长度不能小于8位");
/**
* 异常码
*/
Integer code;
/**
* 异常信息
*/
String msg;
ImoocMallExceptionEnum(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}因为这个枚举类的作用是，用来定义【接口处理失败时，错误码和错误信息】的，所以这个枚举类定义了“code”和“msg”两个属性；并且，这儿先定义了几个常见的错误情况的枚举；自然，这个枚举类需要有有参构造和set和get方法；
有关枚举和枚举类的内容，可以参考【SpringBoot电商项目用户模块枚举类和枚举数据类型】中的内容；
（8） 创建方法来应对：接口处理失败时的情况；（这儿是，使用了枚举类的情况；所以，推荐使用这种方式）
能够感受到，这种通过枚举类来统一管理错误信息的方式，十分规整，不易出错；程序规范性好，而且效率也高；
（9） 有的时候，在调试的时候，我们需要看看ApiRestResponse对象的内容；所以，这儿我们重写了toString()方法；
