开发中对返回结果类的封装

最新推荐文章于 2024-07-10 02:47:43 发布
最新推荐文章于 2024-07-10 02:47:43 发布
阅读量3.3k 收藏 8
点赞数
分类专栏： 工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43575868/article/details/108855788
版权

文章目录

BigDevil_—JsonResult

import java.util.List;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * 自定义响应结构
 */
public class JsonResult {

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

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

    // 响应消息
    private String msg;

    // 响应中的数据
    private Object data;

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

    public static JsonResult ok(Object data) {
        return new JsonResult(data);
    }

    public static JsonResult ok() {
        return new JsonResult(null);
    }

    public JsonResult() {

    }

    public static JsonResult build(Integer status, String msg) {
        return new JsonResult(status, msg, null);
    }

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

    public JsonResult(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;
    }

    /**
     * 将json结果集转化为JsonResult 
     * @param jsonData json数据
     * @param clazz JsonResult中的object类型
     * @return
     */
    public static JsonResult formatToPojo(String jsonData, Class<?> clazz) {
        try {
            if (clazz == null) {
                return MAPPER.readValue(jsonData, JsonResult.class);
            }
            JsonNode jsonNode = MAPPER.readTree(jsonData);
            JsonNode data = jsonNode.get("data");
            Object obj = null;
            if (clazz != null) {
                if (data.isObject()) {
                    obj = MAPPER.readValue(data.traverse(), clazz);
                } else if (data.isTextual()) {
                    obj = MAPPER.readValue(data.asText(), clazz);
                }
            }
            return build(jsonNode.get("status").intValue(), jsonNode.get("msg").asText(), obj);
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 没有object对象的转化
     * 
     * @param json
     * @return
     */
    public static JsonResult format(String json) {
        try {
            return MAPPER.readValue(json, JsonResult.class);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * Object是集合 转化
     * 
     * @param jsonData json数据
     * @param clazz 集合中的类型
     * @return
     */
    public static JsonResult formatToList(String jsonData, Class<?> clazz) {
        try {
            JsonNode jsonNode = MAPPER.readTree(jsonData);
            JsonNode data = jsonNode.get("data");
            Object obj = null;
            if (data.isArray() && data.size() > 0) {
                obj = MAPPER.readValue(data.traverse(),
                        MAPPER.getTypeFactory().constructCollectionType(List.class, clazz));
            }
            return build(jsonNode.get("status").intValue(), jsonNode.get("msg").asText(), obj);
        } catch (Exception e) {
            return null;
        }
    }

}

毕设使用—JSONResultUtil

public class JSONResultUtil {
	private boolean success;
	private Object data;
	private String msg;
	public boolean isSuccess() {
		return success;
	}
	public void setSuccess(boolean success) {
		this.success = success;
	}
	public Object getData() {
		return data;
	}
	public void setData(Object data) {
		this.data = data;
	}
	public String getMsg() {
		return msg;
	}
	public void setMsg(String msg) {
		this.msg = msg;
	}
	public JSONResultUtil() {
		super();
	}
	public JSONResultUtil(boolean success) {
		super();
		this.success = success;
	}
	
	public JSONResultUtil(boolean success, String msg) {
		super();
		this.success = success;
		this.msg = msg;
	}
	
	/**
	 * 返回正确结果不带数据
	 * @return
	 */
	public static JSONResultUtil ok() {
		return new JSONResultUtil(true);
	}
	
	/**
	 * 返回错误结果带错误信息
	 * @param msg
	 * @return
	 */
	public static JSONResultUtil error(String msg) {
		return new JSONResultUtil(false, msg);
	}
}

SSM项目使用—ResultEntity

package com.study.util;

import java.util.HashMap;
import java.util.Map;

/**
 * @author:发则韩
 * @description:统一返回结果实体类
 *              使用案例： ResultEntity.success().put("page",pageInfo)
 *                          .put("requestURI",request.getRequestURI());
 *              返回状态码200，消息为操作成功，分页的信息，请求URI
 */
public class ResultEntity {
    private Map<String,Object> map = new HashMap<>();

    /**
     * @author 发则韩
     * @description 成功后返回状态码200，消息为操作成功，
     *              返回一个ResultEntity为了继续调用put方法
     */
    public static ResultEntity success(){
        ResultEntity resultEntity = new ResultEntity();
        resultEntity.map.put("statusCode", 200);
        resultEntity.map.put("message", "操作成功");
        return resultEntity;
    }

    /**
     * @author 发则韩
     * @description 成功后返回状态码500，消息为操作失败，
     *              返回一个ResultEntity为了继续调用put方法
     */
    public static ResultEntity error(){
        ResultEntity resultEntity = new ResultEntity();
        resultEntity.map.put("statusCode", 500);
        resultEntity.map.put("message", "操作失败");
        return resultEntity;
    }

    /**
     * @author 发则韩
     * @description 往当前ResultEntity的map继续添加key-value，
     *              如分页数据 put("page",pageInfo)
     */
    public ResultEntity put(String key,Object value){
        this.map.put(key, value);
        return this;
    }

    public Map<String, Object> getMap() {
        return map;
    }

    public void setMap(Map<String, Object> map) {
        this.map = map;
    }
}

这个方法的返回结果样式：

{
	"map":{
		"statusCode":500,
		"message":"操作失败"
	}
}

很明显会多一层map，因此需要优化。

优化后的实体类

import com.fasterxml.jackson.annotation.JsonInclude;

import java.util.HashMap;
import java.util.Map;

/**
 * 统一返回结果实体类
 */
@JsonInclude(JsonInclude.Include.NON_NULL) //如果data为null，则不显示
public class ResultEntity {
    private Integer code;

    private String message;

    private Map<String,Object> data;

    /**
     * 返回状态码200，消息自定义
     * 返回一个ResultEntity为了继续调用put方法
     */
    public static ResultEntity success(String message){
        ResultEntity resultEntity = new ResultEntity();
        resultEntity.code = 200;
        resultEntity.message = message;
        return resultEntity;
    }

    /**
     * 返回状态码500，消息自定义
     * 返回一个ResultEntity为了继续调用put方法
     */
    public static ResultEntity error(String message){
        ResultEntity resultEntity = new ResultEntity();
        resultEntity.code = 500;
        resultEntity.message = message;
        return resultEntity;
    }

    /**
     * 返回状态码自定义，消息自定义
     * 返回一个ResultEntity为了继续调用put方法
     */
    public static ResultEntity error(Integer code, String message){
        ResultEntity resultEntity = new ResultEntity();
        resultEntity.code = code;
        resultEntity.message = message;
        return resultEntity;
    }

    /**
     * 往当前ResultEntity的map继续添加key-value
     */
    public ResultEntity put(String key,Object value){
        if(this.data == null){
            this.data = new HashMap<>();
        }
        this.data.put(key, value);
        return this;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

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

    public void setData(Map<String,Object> data) {
        this.data = data;
    }

    public java.util.Map<String, Object> getData() {
        return data;
    }
}

Spring Boot项目使用—AppResponse与枚举类

创建一个泛型类AppResponse<T>，定义三个私有成员变量code(Integer型)、msg(String型)、data(T型)，分别的作用是响应码，响应消息以及响应数据。定义两个静态方法ok(T data)和fail(T data)，用于快速返回响应成功或失败，成功和失败的响应码以及响应信息从枚举类ResponseCodeEnum中获取，响应的数据通过参数传递进来后设置到变量data中。

AppResponse.java

import com.study.common.enums.ResponseCodeEnum;

/**
 * 应用统一返回结果数据封装类
 * @author Administrator
 * @param <T> 返回结果数据类型
 */
public class AppResponse<T> {

    private Integer code;
    private String msg;
    private T data;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

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

    /**
     * 快速响应成功
     * @param data
     * @return
     */
    public static<T> AppResponse<T> ok(T data){
        AppResponse<T> resp = new AppResponse<T>();
        // 对应枚举类中的 0
        resp.setCode(ResponseCodeEnum.SUCCESS.getCode());
        // 对应枚举类中的 "操作成功"
        resp.setMsg(ResponseCodeEnum.SUCCESS.getMsg());
        resp.setData(data);
        return resp;
    }

    /**
     * 快速响应失败
     */
    public static<T> AppResponse<T> fail(T data){
        AppResponse<T> resp = new AppResponse<T>();
        // 对应枚举类中的 1
        resp.setCode(ResponseCodeEnum.FAIL.getCode());
        // 对应枚举类中的 "服务器异常"
        resp.setMsg(ResponseCodeEnum.FAIL.getMsg());
        resp.setData(data);
        return resp;
    }
}

枚举类ResponseCodeEnum.java

public enum ResponseCodeEnum {

    SUCCESS(0,"操作成功"),
    FAIL(1,"服务器异常"),
    PARAM_INVAILD(400,"提交参数非法"),
    NOT_AUTHED(403,"无权限，访问拒绝"),
    NOT_FOUND(404,"资源未找到");

    private Integer code;
    private String msg;


    private ResponseCodeEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }

}

多提一嘴，枚举类用于定义多个固定值来对应某个业务的多个场景，比如订单状态OrderStatusEnum、项目状态ProjectStatusEnum等。

public enum OrderStatusEnumes {
	
	UNPAY((byte)0,"未支付"),
	CANCEL((byte)1,"已取消"),
	PAYED((byte)2,"支付成功"),
	WAITING((byte)3,"等待发货"),
	SEND((byte)4,"已发货"),
	SENDED((byte)5,"已送达"),
	SUCCESS((byte)6,"交易完成"),
	FAIL((byte)7,"交易未完成");
	
	private byte code;
	private String status;
	public byte getCode() {
		return code;
	}
	public void setCode(byte code) {
		this.code = code;
	}
	public String getStatus() {
		return status;
	}
	public void setStatus(String status) {
		this.status = status;
	}
	private OrderStatusEnumes(byte code, String status) {
		this.code = code;
		this.status = status;
	}
}

--------------------------分割线------------------------

/**
 * 项目状态
 */
public enum ProjectStatusEnume {

    DRAFT((byte)0,"草稿"),
    SUBMIT_AUTH((byte)1,"提交审核申请"),
    AUTHING((byte)2,"后台正在审核"),
    AUTHED((byte)3,"后台审核通过"),
    AUTHFAIL((byte)4,"审核失败"),
    STARTING((byte)5,"开始众筹"),//新增众筹项目一些状态
    SUCCESS((byte)6,"众筹成功"),
    FINISHED((byte)7,"众筹完成"),
    FAIL((byte)8,"众筹失败");

    private byte code;
    private String status;
    public byte getCode() {
        return code;
    }
    public void setCode(byte code) {
        this.code = code;
    }
    public String getStatus() {
        return status;
    }
    public void setStatus(String status) {
        this.status = status;
    }
    private ProjectStatusEnume(byte code, String status) {
        this.code = code;
        this.status = status;
    }
}
发则韩
关注
  • 0
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Mybatis 连表查询，返回结果封装为Map
vili_sky的博客
06-15 4万+
在SSM的项目中，数据的持久化操作都使用Mybatis实现，Mybatis抢的Mapper配置文件，可以让我们灵活得编写SQL语句。在我们需要进行连表查询时，需要传入的参数可能不止一个，这个时候我们将参数封装至一个自定义的对象，或者存储到一个Map之中，查询结果同样可以封装至一个自定义的对象或者Map。
Java返回分页结果集的封装代码实例
08-25
在Java开发中，返回分页结果集的封装是常见的需求，尤其在大数据量的Web应用中，为了提高用户体验，通常需要实现数据的分页展示。本篇将详细讲解如何在Java中封装一个分页结果集类，并通过示例代码进行说明。 首先...
封装MyBatis输出结果-简单类型，对象类型，map,resulemap,模糊查询
weixin_48370579的博客
11-07 802
封装 MyBatis 输出结果 resultType: 执行 sql 得到 ResultSet 转换的类型，使用类型的完全限定名或别名。 注意如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身。resultType 和 resultMap，不能同时使用。 1.对象类型 在实体类中不仅表对应的实体类可以拿到数据库中的值，只要字段名字对应还可以赋值给其他类、 定义一个类 packa...
java 封装返回
最新发布
weixin_31238185的博客
07-10 19
封装相关视频讲解：C语言程序设计入门之环境安装DLL动态链接库创建C++设计模式：观察者模式的实用工程技术Java封装返回值 在Java编程中，封装是面向对象编程中的重要概念之一。封装可以帮助我们隐藏对象的内部细节，只暴露必要的接口给外部使用。在某些情况下，我们需要封装一些数据，并通过返回值的方式将其传递给其他部分。...
mybatis group by 分组查询：将返回结果封装为map
热门推荐
qq_43842093的博客
05-03 1万+
文章目录1. 最简单但性能最差的做法2. 使用group by分组查询，将查询结果封装成类3.group by分组查询，将结果封装为map。直接封装为map？List1. 最简单但性能最差的做法 在逻辑层分多次对数据库进行查询。伪代码如下。 List<String> nameList ; List<Integer> countList; for(String name: nameList){ countList.add(xxDao.countByName(name)); } map
利用结果集元数据将查询结果封装成Map
xiueer
10-02 358
package cn.itcast.jdbc;import java.sql.Connection; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.ResultSetMetaData; import java.sql.SQLException; import java.util.ArrayL
mybatis查询结果封装成map类型
一个想法
07-21 7667
mybatis查询实现返回List类型数据操作； mybatis将查询结果装入map，用于快速检索。
使用ADO封装类的数据库程序开发实例.zip
06-19
在实际开发中，为了提高代码的可重用性和可维护性，通常会将ADO操作封装到类中。本实例将探讨如何使用ADO封装类来构建数据库应用程序。 首先，我们需要了解ADO的基本组件。ADO主要由Connection对象、Command对象、...
微信企业号 根据错误码返回错误信息类封装
09-01
在微信企业号的开发过程中，错误处理是必...总之，微信企业号的错误信息类封装是一种提高开发效率和代码质量的有效手段，它帮助开发者更好地理解和应对微信API在使用过程中可能遇到的问题，降低了开发和维护的复杂度。
详解Android开发技巧之PagerAdapter实现类的封装
08-28
Android开发中，ViewPager是一个非常重要的组件，它允许用户通过左右滑动来浏览多个页面。PagerAdapter是ViewPager的核心，负责管理页面的创建和销毁，以优化内存使用。在这个问题中，我们将深入探讨如何封装...
请求返回数据封装类
04-23
在IT行业中，网络请求是应用程序与服务器之间交互的基础，尤其在网络化的前端应用中更是不可或缺。...在实际开发中，可以根据项目需求定制自己的数据封装类，以满足各种场景下的数据处理和交互需求。
将JPA查询结果封装成Map返回以及Map排序
一位不想写代码偏偏还在挣扎的万年小白
10-18 2347
jpa中将查询的字段返回为Map键值对类型 Java8 对 Map 排序
mysql map 结果集封装_mybatis 使用Map封装查询的结果
weixin_42298969的博客
02-02 764
有时我们厌倦了为每个查询写一个Entity类，这时Map开始发挥它的功效。对于要返回“学号，班级，姓名”结果的查询，可以这样写Mapper:select s.code as sNo , s.name as sName, c.name as cNamefrom xStudent s, xClass cwhere s.cID = c.ID如下声明我们的dao方法：public List> sel...
MyBatis笔记-基础的查询参数和查询结果封装
hjyp的博客
11-11 2230
使用MyBatis个人认为分为以下几大块配置，包括所扫描的mapper位置、是否开启驼峰、数据库连接池信息等如何使用查询参数如何处理返回结果动态SQL，方便编写查询条件和批量操作其中如何使用查询参数和处理返回结果部分都在xml文件中进行定义。直接传入一个对象;传入多个字段；第一种情况我们不需要任何注解，直接在mapper方法中传入对象，然后在sql语句中直接使用该对象的属性即可;// 接口声明，根据实体查询会议 Meet queryByMeet(Meet meet);
Map集合的keySet()方法：返回map集合中的所有key对象，并封装返回为Set集合
qq_43118674的博客
06-11 1290
Map集合的keySet()方法：返回map集合中的所有key对象，并封装返回为Set集合
Map的常用方法测试
Aylwang的博客
03-27 1097
Map的常用方法测试 package com.neu.Collection; import com.sun.activation.registries.MailcapParseException; import java.util.Collection; import java.util.HashMap; import java.util.Iterator; import java.util.Map; import java.util.Set; /** * @author 王永利 * @date
jdbc的简单封装（使用map处理结果集）
专注做分享
11-08 6547
在上一片篇博客中，我们在查询的时候，是采用实现IResultSetHandler这个类的handle方法来处理查询返回的数据的，但是这样做有一个缺点，查询不同的表，每次都要实现这个handle方法，增大了工作量，而且用起来也差强人意，所以这次使用map对象来处理返回的数据：工具类的代码如下：package JDBCUtils;import java.sql.Connection; import ja
使用Map集合作为封装SQL查询结果的场景和注意事项
m0_68201836的博客
12-17 2269
使用Map集合作为封装SQL查询结果的场景和注意事项
springmvc rest框架搭建中遇到的问题-xml转换错误
天道酬勤
01-18 141
  .bean to xml显示的xml不是我往ModelAndView中塞的bean 怎么说呢， Task task = taskManager.getTaskById(id); ModelAndView result = new ModelAndView(); result.addObject("task",task); 结果应该是这样的。。。 &lt;task&gt;&lt;...
iOS音频工具类封装与控制器间高效数据传输
在iOS开发中，音频工具类的封装和音乐播放器的细节控制是一个关键的话题，它涉及到控制器间的数据传递和模块化设计原则。本文首先讨论了四种不同的控制器间数据传递策略： 1. 直接赋值：通过`music[indexPath.row]`...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值