tutorial básico springboot2.x: interface para obter um retorno de formato unificado

A interação de dados de front-end e back-end costuma estar envolvida no projeto SpringBoot. Atualmente, a interação de dados baseada no formato json é mais popular. Mas json é apenas o formato da mensagem, e o conteúdo dela precisa ser projetado por nós mesmos. Independentemente de ser a interface HTTP ou a interface RPC, é importante manter um formato de valor de retorno uniforme, o que reduzirá muito o custo da depuração conjunta de front-end e back-end.

Formato específico da interface definida

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

Ferramentas tipo R fornecidas

@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);
}

Design do código de status

Aqui, podemos nos referir ao design do código de status Http. Cada tipo de negócio define um intervalo de código de status, que é extraído e colocado na classe de enumeração

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 milhas começam com um único passo. Aqui está o segundo artigo da série de tutoriais SpringBoot. Todos os códigos-fonte do projeto podem ser baixados em meu GitHub .