Springboot2.x tutorial básico: interfaz para lograr un formato de retorno unificado

La interacción de datos de front-end y back-end a menudo está involucrada en el proyecto SpringBoot. En la actualidad, la interacción de datos basada en el formato json es más popular. Pero json es solo el formato del mensaje, y el contenido debe ser diseñado por nosotros mismos. Independientemente de si se trata de la interfaz HTTP o la interfaz RPC, es importante mantener un formato de valor de retorno uniforme, lo que reducirá en gran medida el costo de la depuración conjunta de front-end y back-end.

Formato específico de interfaz definido

{
	#返回状态码
	"code":integer类型,
	#返回信息描述
	"msg":string,
	#返回值
	"data":object
}

Se proporcionan herramientas tipo R

@Data
public class R<T> {
    private int code;
    private T data;
    private String msg;
    public R() {
    }
    public static <T> R<T> ok(T data) {
        return fill(data,ApiCommonCodeEnum.OK);
    }
    public static <T> R<T> failed(String msg) {
        return fill( null, ApiCommonCodeEnum.FAIL);
    }
    public static <T> R<T> failed(ApiCommonCodeEnum apiEnum) {
        return fill( null, apiEnum);
    }
    public static <T> R<T> fill(T data, ApiCommonCodeEnum apiEnum) {
        return fill(apiEnum.getCode(),data,apiEnum.getMsg());
    }
    public static <T> R<T> fill(int code,T data,String msg) {
        R R = new R();
        R.setCode(code);
        R.setData(data);
        R.setMsg(msg);
        return R;
    }
}
//使用举例
@PostMapping("/login")
public R<UserInfoVO> login(@RequestBody LoginDTO loginDTO){
	UserInfoVO userInfoVO=new UserInfoVO();
	userInfoVO.setNickname("编程之家");
	userInfoVO.setToken("xxx");
	return R.ok(userInfoVO);
}

Diseño de código de estado

Aquí podemos referirnos al diseño del código de estado Http. Cada tipo de negocio define un intervalo de código de estado, que se extrae y se coloca en la clase de enumeración

public enum  ApiCommonCodeEnum {
    FAIL(1,"调用出错"),
    OK(0,"调用成功"),
	USER_EXISIT(100,"用户不存在"),
	USER_PASSWORD_ERROR(101,"用户密码错误"),
	//....
	NO_PERM(300,"无权限");
	//....
    int code;
    String msg;
    ApiCommonCodeEnum(int code,String msg){
        this.code=code;
        this.msg=msg;
    }
    public int getCode() {
        return code;
    }
    private void setCode(int code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    private void setMsg(String msg) {
        this.msg = msg;
    }
}

Mil millas comienzan con un solo paso. Aquí está el segundo artículo de la serie de tutoriales SpringBoot. Todos los códigos fuente del proyecto se pueden descargar en mi GitHub .