自定义响应返回结构

前言

规范的自定义返回结构无疑会增强代码的可读性，今天就给大家晒一个模板,可提供给 H5/ios/安卓/公众号/小程序 使用,前端接受此类数据（json object)后，可自行根据业务去实现相关功能.

代码

package com.my.utils;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * 
 * @Title: MyJSONResult.java
 * @Package com.My.utils
 * @Description: 自定义响应数据结构
 * 				本类可提供给 H5/ios/安卓/公众号/小程序 使用
 * 				前端接受此类数据（json object)后，可自行根据业务去实现相关功能
 * 
 * 				200：表示成功
 * 				500：表示错误，错误信息在msg字段中
 * 				501：bean验证错误，不管多少个错误都以map形式返回
 * 				502：拦截器拦截到用户token出错
 * 				555：异常抛出信息
 * 				556: 用户qq校验异常
 * @Copyright: Copyright (c) 2020
 * @Company: www.My.com
 * @author Chamption-Dai
 * @version V1.0
 */
public class MyJSONResult {

    // 定义jackson对象
    private static final ObjectMapper MAPPER = new ObjectMapper();

    // 响应业务状态
    private Integer status;

    // 响应消息
    private String msg;

    // 响应中的数据
    private Object data;
    
    @JsonIgnore
    private String ok;	// 不使用

    public static MyJSONResult build(Integer status, String msg, Object data) {
        return new MyJSONResult(status, msg, data);
    }

    public static MyJSONResult build(Integer status, String msg, Object data, String ok) {
        return new MyJSONResult(status, msg, data, ok);
    }
    
    public static MyJSONResult ok(Object data) {
        return new MyJSONResult(data);
    }

    public static MyJSONResult ok() {
        return new MyJSONResult(null);
    }
    
    public static MyJSONResult errorMsg(String msg) {
        return new MyJSONResult(500, msg, null);
    }
    
    public static MyJSONResult errorMap(Object data) {
        return new MyJSONResult(501, "error", data);
    }
    
    public static MyJSONResult errorTokenMsg(String msg) {
        return new MyJSONResult(502, msg, null);
    }
    
    public static MyJSONResult errorException(String msg) {
        return new MyJSONResult(555, msg, null);
    }
    
    public static MyJSONResult errorUserQQ(String msg) {
        return new MyJSONResult(556, msg, null);
    }

    public MyJSONResult() {

    }

    public MyJSONResult(Integer status, String msg, Object data) {
        this.status = status;
        this.msg = msg;
        this.data = data;
    }
    
    public MyJSONResult(Integer status, String msg, Object data, String ok) {
        this.status = status;
        this.msg = msg;
        this.data = data;
        this.ok = ok;
    }

    public MyJSONResult(Object data) {
        this.status = 200;
        this.msg = "OK";
        this.data = data;
    }

    public Boolean isOK() {
        return this.status == 200;
    }

    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 Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

	public String getOk() {
		return ok;
	}

	public void setOk(String ok) {
		this.ok = ok;
	}

}

结束语

代码不止，奋斗不息。