1. 概述

在编写接口时,我们一般使用JsonResult 对象对数据进行返回,这样在前端,我们可以统一进行数据的处理。

2. 代码定义

package com.redxun.common.base.entity;

import com.alibaba.fastjson.JSONObject;
import com.redxun.common.utils.ExceptionUtil;
import lombok.Data;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;

import java.io.Serializable;

/**
 * 返回前台响应的数据对象。
 *
 */
@Accessors(chain = true)
@Data
@Slf4j
public class JsonResult<T extends Object> implements  Serializable {
    /**
     * 返回的成功状态=200
     */
    public final static int SUCESS_CODE=200;
    /**
     * 返回的失败状态=500
     */
    public final static int FAIL_CODE=500;

    /**
     * 是否成功
     */
    private boolean success=true;

    /**
     * 返回的消息。
     */
    private String message="";


    /**
     * 在浏览器端的默认信息中是否显示。
     */
    private boolean show=true;

  /**
     * 成功:200
     * 失败:
     * 500 : 异常
     * 403 : 没有权限
     * 401 : 未登录
     */
    private  int code=SUCESS_CODE;


    /**
     * 需要返回的数据。
     */
    private T data;

    public JsonResult() {

    }

    public JsonResult (boolean success){
        this.success=success;
        if(success){
            this.code=SUCESS_CODE;
        }else{
            this.code=FAIL_CODE;
        }
    }

    /**
     * 返回的成功的响应实例
     * @param message
     * @return
     */
    public static JsonResult Success(String message){
        JsonResult result=new JsonResult(true,message);
        return result;
    }

    /**
     * 返回的成功的响应实例
     * @return
     */
    public static JsonResult Success(){
        JsonResult result=new JsonResult(true);
        return result;
    }


    public static JsonResult Fail(String message){
        JsonResult result=new JsonResult(false,message);
        return result;
    }
    public static JsonResult Fail(){
        JsonResult result=new JsonResult(false);
        return result;
    }


    public JsonResult (boolean success, String message ){
        this.success=success;
        this.message=message;
        if(success){
            this.code=SUCESS_CODE;
        }else{
            this.code=FAIL_CODE;
        }
    }


    public JsonResult(boolean success,T data ,String message){
        this.success=success;
        if(success){
            this.code=SUCESS_CODE;
        }else{
            this.code=FAIL_CODE;
        }
        this.data=data;
        this.message=message;
    }


    public JsonResult(int code,T data ,String message){
        if(code == SUCESS_CODE){
            this.success=Boolean.TRUE;
        }else{
            this.success=Boolean.FALSE;
        }
        this.data=data;
        this.message=message;
    }

    public void setException(Throwable exception){
        String msg= ExceptionUtil.getExceptionMessage(exception);
        this.data= (T) msg;
        log.error(msg);

    }


    public static JsonResult getSuccessResult(String msg) {
        return getSuccessResult(null, SUCESS_CODE, msg);
    }

    public static <T> JsonResult getSuccessResult(T data, String msg) {
        return getSuccessResult(data, SUCESS_CODE, msg);
    }

    public static <T> JsonResult getSuccessResult(T data) {
        return getSuccessResult(data, SUCESS_CODE, "");
    }

    public static <T> JsonResult getSuccessResult(T data ,Integer code, String msg){
        JsonResult<T> result=new JsonResult<T>();
        result.setSuccess(true);
        result.setData(data);
        result.setCode(SUCESS_CODE);
        result.setMessage(msg);
        return result;
    }

    /**
     * 获取错误结果对象。
     * @param msg
     * @return
     */
    public static JsonResult getFailResult(String msg){
        return getFailResult(null, FAIL_CODE, msg);
    }

    public static JsonResult getFailResult(String msg,int code){
        return getFailResult(null, code, msg);
    }

    public static <T> JsonResult getFailResult(T data, String msg) {
        return getFailResult(data, FAIL_CODE, msg);
    }

    public static  <T> JsonResult getFailResult(T data ,Integer code, String msg){
        JsonResult<T> result=new JsonResult<T>();
        result.setSuccess(false);
        result.setData(data);
        result.setCode(code);
        result.setMessage(msg);
        return result;
    }

    @Override
    public String toString() {
        return JSONObject.toJSONString(this);
    }

    public static void main(String[] args) {
        JsonResult out=JsonResult.Fail("aaa");
        System.err.println(out);
    }
}

属性定义:

属性 备注
success 返回是否成功, true or false
message 提示的消息
data 返回的数据,这个数据可以是任意的数据对象
show 在前端是否默认显示消息,默认为true
code 返回编码,默认为200 ,这个可以在返回前端时 前后端双方协定好做一些判断
文档更新时间: 2021-03-17 09:52   作者:zyg