zl程序教程

您现在的位置是:首页 >  Java

当前栏目

统一ajax请求返回格式

2023-02-18 16:37:33 时间

# 封装ajax请求返回的格式

在项目开发中,为了方便统一管理ajax请求返回数据的格式,这里我们可以封装一个工具类来控制

package top.dimples.util;

/**
 *统一整个项目中的ajax请求返回的结果(未来也可以用于分布式架构各个模块间调用时返回统一类型)
 * @param <T>
 */
public class ResultEntity<T> {

    public static final String SUCCESS = "SUCCESS";
    public static final String FAILED = "FAILED";

    // 用来封装请求是否成功
    private String result;

    // 请求处理失败的放回信息
    private String message;

    // 要返回的数据
    private T data;

    /*
    * 请求成功且不需要返回数据的方法
    * */
    public static <Type> ResultEntity<Type> successWithoutData(){
        return new ResultEntity<Type>(SUCCESS,null,null);
    }

    /**
     * 请求成功且返回数据的方法
     * */
    public static <Type> ResultEntity<Type> successWithData(Type data){
        return new ResultEntity<Type>(SUCCESS,null,data);
    }

    /**
     * 请求失败的方法
     * @param message
     * @param <Type>
     * @return
     */
    public static <Type> ResultEntity<Type> failed(String message){
        return new ResultEntity<Type>(FAILED,message,null);
    }


    public ResultEntity() {
    }

    public ResultEntity(String result, String message, T data) {
        this.result = result;
        this.message = message;
        this.data = data;
    }

    public String getResult() {
        return result;
    }

    public void setResult(String result) {
        this.result = result;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

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

    @Override
    public String toString() {
        return "ResultEntity{" +
                "result='" + result + '\'' +
                ", message='" + message + '\'' +
                ", data=" + data +
                '}';
    }
}

验证发送请求后返回的内容

调用方法的方式

 @GetMapping("/get/all")
    public ResultEntity<List<Card>> getAll(){

        List<Card> cards = cardService.queryAll();

        return ResultEntity.successWithData(cards);

}