java 接口返回json数据封装

最新推荐文章于 2024-07-26 12:28:02 发布
最新推荐文章于 2024-07-26 12:28:02 发布
阅读量6.2k 收藏 32
点赞数 8
分类专栏： json 文章标签： java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u014295903/article/details/105863132
版权

前言

首先，采用的是springboot，在controller中使用了@RestController或者@ResponseBody注解，返回的数据本身就是json格式。但是这样的json串在前后端分离使用中并不满足实际的效果，因此需要进行相应的封装，以满足前端能够正确处理获取的数据。

一、准备

1.1 使用的是fastjson，因此需要pom文件引入包

版本随你

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.58</version>
</dependency>

1.2 统一的返回规范必不可少

一般情况下，状态、信息、数据这三项已经满足大部分需要。如果需求特殊可以自己修改。
序列化
值得说一下的是重写tostring时就将其转换为json串JSON.toJSONString(this);。本文所用的返回类进行了实例化，因此采用JSON.方法，也可以通过JSONObject（已经实现序列化，返回类不需要再次序列化）的方发进行转换。
在这里插入图片描述
为空处理
利用fastjson自带的注解来处理返回时无值得情况，统一显示为null。@JSONField(serialzeFeatures = {SerializerFeature.WriteMapNullValue})

import java.io.Serializable;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.annotation.JSONField;
import com.alibaba.fastjson.serializer.SerializerFeature;

/**
 * 
 * @Description: 统一API响应结果封装
 * @author ZhiPengyu
 * @date: 2020年4月29日 下午2:48:18
 */
public class ResponseBody implements Serializable {
 
    /**
	 * 
	 */
	private static final long serialVersionUID = 1886106011131539131L;
	
	private String code;
    private String message;
    @JSONField(serialzeFeatures = {SerializerFeature.WriteMapNullValue})
    private Object data;
    
	/* set and get */
    public String getCode() {
        return code;
    }
 
    public void setCode(String code) {
        this.code = code;
    }
 
    public String getMessage() {
        return message;
    }
 
    public void setMessage(String message) {
        this.message = message;
    }
 
    public Object getData() {
        return data;
    }
 
    public void setData(Object data) {
        this.data = data;
    }
    
	/* 构造 */
    public ResponseBody() {
		super();
		// TODO Auto-generated constructor stub
	}

    public ResponseBody(String code, String message, Object data) {
		super();
		this.code = code;
		this.message = message;
		this.data = data;
	}

	/**
     * 默认成功或者失败,无数据
     * @param resultCode
     */
	public ResponseBody(ResultCode resultCode) {
        this.code = resultCode.getCode();
        this.message = resultCode.getMessage();
    }
	
	/**
	 * 枚举结果以及获取数据
	 * @param resultCode
	 * @param data
	 */
	public ResponseBody(ResultCode resultCode,String message) {
        this.code = resultCode.getCode();
        this.message = message;
    }
	
	/**
	 * 枚举结果以及获取数据
	 * @param resultCode
	 * @param data
	 */
	public ResponseBody(ResultCode resultCode,Object data) {
        this.code = resultCode.getCode();
        this.message = resultCode.getMessage();
        this.data = data;
    }
	
	@Override
	public String toString() {
		return JSON.toJSONString(this);
	}

}

二、封装

为了更好的进行操作，将操作细节隐藏封装。

2.1枚举

就是状态码的统一操作，这样是更加规范的，对前端也一样。

/**
 * 
 * @Description: 响应码枚举，参考HTTP状态码的语义
 * @author ZhiPengyu
 * @date: 2020年4月29日 上午9:27:40
 */
public enum ResultCode {
    /* 成功 */
    SUCCESS("200", "Success!"),
    /* 失败 */
    FAIL("400", "Failure!"),
    
	/* 参考HTTP状态码 */
    NO_PERMISSION("403", "Need Authorities!"),//没有权限
    LOGIN_NO("402", "Need Login!"),//未登录
    LOGIN_FAIL("401", "Login Failure!"),//登录失败
    LOGIN_SUCCESS("200", "Login Success!"),//登录成功
    LOGOUT_SUCCESS("200", "Logout Success!"),//退出登录
    SESSION_EXPIRES("101", "Session Expires!"),//会话到期
    SESSION_EXPIRES_OTHER_LOGIN("101", "Session Expires!Other users login！"),//会话到期,其他用户登录
    
    
    private String code;
    private String message;
    
    public String getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

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

	/**
	 * 
	 * @param code
	 * @param message
	 */
    ResultCode(String code, String message) {
        this.code = code;
        this.message = message;
    }

}

2.2封装

利用**@Component**注解简化用户在返回数据是复杂复制操作，同时减少自定义的使用，以枚举为主，可以不断添加。

import org.springframework.stereotype.Component;

@Component
public class ResultGenerator{

	/**
	 * 默认成功,无数据
	 * @return
	 */
	public ResponseBody getSuccessResult() {
        return new ResponseBody(ResultCode.SUCCESS);
    }
	/**
	 * 默认成功,有数据
	 * @param data
	 * @return
	 */
	public ResponseBody getSuccessResult(Object data) {
        return new ResponseBody(ResultCode.SUCCESS,data);
    }
	/**
	 * 默认失败,无数据
	 * @return
	 */
	public ResponseBody getFailResult() {
        return new ResponseBody(ResultCode.FAIL);
    }
	/**
	 * 默认失败
	 * @param message 自定义失败信息
	 * @return
	 */
	public ResponseBody getFailResult(String message) {
        return new ResponseBody(ResultCode.FAIL,message);
    }
	
	/**
	 * 采用枚举中的状态无数据返回
	 * @param resultCode 响应码枚举
	 * @param data
	 * @return
	 */
	public ResponseBody getFreeResult(ResultCode resultCode) {
        return new ResponseBody(resultCode);
    }
	
	/**
	 * 采用枚举中的状态带数据返回
	 * @param resultCode 响应码枚举
	 * @param data
	 * @return
	 */
	public ResponseBody getFreeResult(ResultCode resultCode, Object data) {
        return new ResponseBody(resultCode, data);
    }

	/**
	 * 自定义返回信息
	 * @param code 响应码
	 * @param message 自定义失败信息
	 * @param data
	 * @return
	 */
	public ResponseBody getFreeResult(String code, String message, Object data) {
        return new ResponseBody(code, message, data);
    }

}

三、使用

以往都是在controller进行new操作同时，此时可以通过**@Autowired**注解调用并直接赋值返回。
在这里插入图片描述
如上图所示，通过不同的方式进行对比。

3.1未完全封装

@PreAuthorize("hasRole('ROLE_admin')")
	@RequestMapping(value = "getSysUserAdmin")
	public ResponseBody getSysUserAdmin() {
		ResponseBody responseBody = new ResponseBody();
	    responseBody.setCode("200");
	    responseBody.setMessage("Sccess!");
		List<SysUser> sysUser = sysUserService.select(null, null);
		responseBody.setData(JSON.toJSONString(sysUser));
		
		return responseBody;
	}

{
    "code": "200",
    "message": "Sccess!",
    "data": "[{\"company\":\"科研诚信\",\"createtime\":1586942036000,\"parentName\":\"admin\",\"password\":\"$2a$10$XlftNY9T52IbLlVAT6Nx7ezyYlcSFkVzC.3n3h5jihyzo1g/KtAPa\",\"pwdRole\":1,\"role\":2,\"status\":1,\"uploadAmount\":3,\"uploadResidue\":0,\"userId\":27,\"userIp\":\"89\",\"username\":\"admin1\"}]"
}

3.2完全封装

可以看出差距还是不小的。

@Autowired
	ResultGenerator resultGenerator;

	@RequestMapping(value = "testjson")
	public ResponseBody testjson() {
		List<SysUser> sysUser = sysUserService.selectSysUserByUnameOrCompany(null, null);
		return resultGenerator.getSuccessResult(sysUser);
	}

{
    "code": "200",
    "message": "Success!",
    "data": [
        {
            "userId": 27,
            "username": "admin1",
            "password": "$2a$10$XlftNY9T52IbLlVAT6Nx7ezyYlcSFkVzC.3n3h5jihyzo1g/KtAPa",
            "parentName": "admin",
            "company": "科研诚信",
            "cpyBranch": null,
            "userIp": "89",
            "uploadAmount": 3,
            "uploadResidue": 0,
            "status": 1,
            "role": 2,
            "pwdRole": 1,
            "createtime": "2020-04-15T09:13:56.000+0000",
            "startTime": null,
            "endTime": null,
            "phoneNumber": null,
            "mail": null,
            "remark": null
        }
    ]
}

四、总结

此文是在查看一些文章之后的总结修改，大同小异，方式多种多样。再次仅说了一种，那些地方说不不对，还请留言矫正啊。

herozhi0821
关注
  • 8
    点赞
  • 踩
  • 32
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
java中后端json数据封装_java 接口返回json数据封装
weixin_29731583的博客
03-02 1961
前言首先，采用的是springboot，在controller中使用了@RestController或者@ResponseBody注解，返回的数据本身就是json格式。但是这样的json串在前后端分离使用中并不满足实际的效果，因此需要进行相应的封装，以满足前端能够正确处理获取的数据。一、准备1.1 使用的是fastjson，因此需要pom文件引入包版本随你com.alibabafastjson1....
java怎么封装json数据_如何封装JSON数据
weixin_39520204的博客
02-25 1694
最近在写接口，用到的请求报文和响应报文都是json数据，因为项目中的json对象都是封装好的，为了弄懂其中的原理，所以就写代码理解一下，这个随笔非常基础，肯定有很多不足，主要是为了记录一下自己的学习过程。如果有这样一个需求,应该怎么用代码处理？要创建这样一个JSON文本 ：{"person"：{"phone" :["12345678", "87654321"], //数组"name" :"yua...
java 后台封装json数据
lip86的专栏
03-23 1816
一、数据封装 1. List集合转换成json代码 List list = new ArrayList(); list.add( "first" ); list.add( "second" ); JSONArray jsonArray2 = JSONArray.fromObject( list ); 2. Map集合转换成json代码 Map map = new HashMap();
Java基础22（JSON解析 注解）
qq_52897007的博客
05-23 1488
JSON是一种轻量级的数据交换格式。在使用Java进行应用程序的开发中，我们会面临类似“将Java对象转换成JSON格式”或者“将JSON格式的数据转换成Java对象“的需求，所以我们需要掌握如何使用第三方库来进行JSON格式数据的解析。fastjson 是阿里巴巴的开源JSON解析库，它可以解析 JSON 格式的字符串，支持将 Java Bean 序列化为 JSON 字符串，也可以从 JSON 字符串反序列化到 JavaBean。所以，开发Web应用的时候，使用JSON作为数据传输，在浏览器端非常方便。
java获取接口返回json数据_java读取其他服务接口返回的json数据示例代码
weixin_32514497的博客
03-02 667
前言现在开发大部分都是服务化或者微服务，数据交换都是跨服务的，这里记录java调取其他接口的方法，下面话不多说了，来一起看看详细的介绍吧。java代码如下：/****类描述：接口读取工具。*/public class ReadUrlUtil {public static JSONObject readJsonFromUrl(String url) throws IOException, JSONE...
java json数据封装_java中如何将数据封装为JSON包？
weixin_35173650的博客
02-12 575
展开全部java中将数据封装为JSON包，可以使用java提供的jsonArray这个工具类进行转换，代码如下：packagecom.json;importjava.io.IOException;importjava.util.ArrayList;importjava.util.Collection;importjava.util.HashMap;importjava.util.Ite...
java后端封装接口返回统一数据格式(json格式)
m0_53428367的博客
10-31 447
java后端封装接口返回统一数据格式(json格式)
Java封装JSON数据
weixin_45956167的博客
02-28 2265
Java封装JSON数据 创建util包 JsonArrory： package utils; import java.io.Serializable; /** * 返回json数组 */ public class JsonArray implements Serializable { private int code; private String msg; private String data = null; public JsonArray(int cod
使用Java完成Json格式数据的封装
qq_45495315的博客
10-11 894
(1)、JSONObject只是一种数据结构，可以理解为JSON格式的数据结构（key-value 结构），可以使用put方法给json对象添加元素。JSONObject可以很方便的转换成字符串，也可以很方便的把其他对象转换成JSONObject对象。(2)、JSON（JavaScript Object Notation的首字母缩写）是一种轻量级数据交换格式，最常用于客户端 - 服务器通信。它既易于读/写，又与语言无关。
java后端通用返回json结果封装
飞奔的小强
11-04 1156
Response 类 public class Response { /**** * 成功响应Msg中的信息 **/ private final static String SUCCESS = "success"; /**** * 失败响应Msg中的信息 **/ private final static String FAILED = "failed"; public static <T> Res.
使用java请求json接口数据
03-28
这里我们将深入探讨如何使用Java来获取指定接口的JSON数据，并涉及`HttpServletRquest`类的重要作用。 首先，理解JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，它基于JavaScript的一个子集，...
SSH封装接口返回Json数据
03-26
在这个场景中，"SSH封装接口返回Json数据"意味着我们有一个接口，该接口在执行SSH任务后会返回结构化的Json数据。Json（JavaScript Object Notation）是一种轻量级的数据交换格式，因其易读、易写、易解析的特点，在...
Android 实用的数据json数据解析封装类
10-08
本篇文章将详细介绍如何创建一个实用的JSON数据解析封装类，以便快速有效地处理各种形式的JSON数据。 首先，我们需要引入一个JSON库，Android SDK本身包含了org.json库，但为了更强大的功能和更好的性能，推荐使用...
HttpConfigUtil.zip_访问外部接口转换成json数据
09-24
在IT行业中，与"HttpConfigUtil.zip_访问外部接口转换成json数据"相关的知识点主要集中在如何通过编程方式从网络调用API接口，并将接收到的数据转换为JSON格式。JSON（JavaScript Object Notation）是一种轻量级的...
Vue请求java服务端并返回数据代码实例
10-15
在现代Web应用开发中，前端框架...同时，Java服务端可能会使用更复杂的对象模型，以及使用如Jackson或Gson库来自动序列化和反序列化JSON数据。理解这一基础交互流程，对于开发Vue.js与Java服务端结合的应用至关重要。
golang 接口
m0_70982551的博客
07-24 872
接口定义了一组方法，这些方法没有具体的实现。接口类型的变量可以存储任何实现了这些方法的类型的值。// 更多方法...在Go语言中，接口值是指存储了实现某个接口的具体类型值的变量。接口值由两部分组成：1.动态类型：这是接口值当前存储的实际类型。2.动态值：这是实际存储的值，该值必须实现了接口中定义的所有方法。
Swagger使用Map接受参数时，页面如何显示具体参数及说
最新发布
a1058926697的博客
07-26 460
后端使用Map接受参数，要求在swagger页面上显示具体的参数名称、类型及说明。当Map接受参数数量少时，可以使用Swagger自带的注解。自定义注解 @ApiGlobalModel。编写处理注解对应的插件。
springboot之自动装配
weixin_50153914的博客
07-23 566
Spring Boot 通过一系列注解和条件配置实现了自动装配机制，使得开发者无需手动配置大量的 XML 文件或 Java 配置类。自动配置机制利用文件中的自动配置类，并结合条件注解和组件扫描，实现了灵活且强大的自动装配功能。这样，开发者可以专注于业务逻辑的实现，而无需处理繁琐的配置细节。
SSM编写http接口返回JSON格式数据
06-07
好的，以下是一个简单的SSM框架编写http接口返回JSON格式数据的示例代码： 1. 首先定义一个JavaBean类，作为接口返回的JSON数据结构。 ``` public class ResponseData { private int code; private String message; private Object data; // 省略getter和setter方法 } ``` 2. 在Controller中编写接口方法，使用@ResponseBody注解将方法返回值转换为JSON格式，并使用ResponseData类封装数据。 ``` @Controller @RequestMapping("/api") public class ApiController { @RequestMapping("/data") @ResponseBody public ResponseData getData() { // 查询数据 List<String> dataList = someService.getDataList(); // 封装数据到ResponseData对象中 ResponseData responseData = new ResponseData(); responseData.setCode(200); responseData.setMessage("success"); responseData.setData(dataList); return responseData; } } ``` 3. 配置Jackson依赖，使Spring MVC能够自动将Java对象转换为JSON格式。 ``` <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>${jackson.version}</version> </dependency> ``` 4. 在Spring MVC配置文件中开启注解驱动，启用自动转换为JSON格式。 ``` <mvc:annotation-driven /> ``` 5. 启动项目后，访问接口地址，即可返回JSON格式的数据。 ``` http://localhost:8080/api/data ``` 以上示例代码仅供参考，具体实现方式还需根据具体需求进行调整。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值