SpringBoot如何统一JSON信息返回

更新时间：2024年08月09日 09:33:53 作者：广州的程序猿

这篇文章主要介绍了SpringBoot如何统一JSON信息返回问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

SpringBoot统一JSON信息返回

调用后端服务后的返回结果有多种类型

如：String，Integer，Boolean，List，Map等，

在一个项目中，为了保持统一性，我们方法返回结果可以全部使用JSON数据格式

如下：

{
    "code":200,
    "msg":"成功",
    "data":"JSON数据"
}

其中code 是本次请求处理结果对应的状态码，msg是状态码对应的解释信息，data是要返回的数据内容，可以是任意一个对象。

封装响应信息对象

public class ResponseEntity<T> implements Serializable {

    private static final long serialVersionUID = 3595741978061989861L;
    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;
    }
}

状态码，Http请求状态码有多种，使用枚举列举

如下示例：

public enum ResponseEnum {

    SUCCESS(200, "成功"),
    FAIL(-1, "失败"),
    ERROR_400(400, "错误的请求"),
    ERROR_404(404, "访问资源不存在"),
    ERROR_500(500, "服务器异常");


    private Integer code;
    private String msg;


    ResponseEnum(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;
    }
}

创建一个公共类，生成响应对象

public class ResponseUtil {

    /**
     * 成功返回
     * @param object 返回数据
     * @return
     */
    public static ResponseEntity success(Object object){
        ResponseEntity resp = new ResponseEntity();
        resp.setCode(ResponseEnum.SUCCESS.getCode());
        resp.setMsg(ResponseEnum.SUCCESS.getMsg());
        resp.setData(object);
        return resp;
    }


    /**
     * 成功返回  无数据
     * @return
     */
    public static ResponseEntity success(){
        return success(null);
    }


    /**
     * 失败返回
     * @param responseEnum 响应标识
     * @return
     */
    public static ResponseEntity error(ResponseEnum responseEnum){
        ResponseEntity resp = new ResponseEntity();
        resp.setCode(responseEnum.getCode());
        resp.setMsg(responseEnum.getMsg());
        return resp;
    }
}

Spring中的控制器可以用 @Controller 和 @RestController注解来声明，其中@Controller标识当前控制器是SpringMvc的控制器，要返回JSON对象数据，需要和@ResponseBody注解联合使用；

@RestController主要用来构建Restful风格接口，返回客户端的请求数据，相当于同时使用@Controller和@ResponseBody注解。

创建Pojo包及对应的实体类

public class DemoEntity {

    private Integer id;
    private String name;


    public Integer getId() {
        return id;
    }


    public void setId(Integer id) {
        this.id = id;
    }


    public String getName() {
        return name;
    }


    public void setName(String name) {
        this.name = name;
    }
}

创建控制器

@Controller

@Controller
public class DemoController {

    @RequestMapping(value = "/users", method= RequestMethod.GET)
    @ResponseBody
    public ResponseEntity users(){
        List<DemoEntity> list = new ArrayList<DemoEntity>();
        DemoEntity demo = new DemoEntity();
        demo.setId(1);
        demo.setName("蜗牛");
        list.add(demo);
        DemoEntity demo1 = new DemoEntity();
        demo1.setId(2);
        demo1.setName("葡萄");
        list.add(demo1);
        return ResponseUtil.success(list);
    }
}

测试：

启动服务后，在浏览器地址栏输入http://localhost:8080/users，可以看到页面上的输出信息

{"code":200,"msg":"成功","data":[{"id":1,"name":"蜗牛"},{"id":2,"name":"葡萄"}]}

@RestController

@RestController
public class DemoRestController {

    @RequestMapping(value = "/users1", method= RequestMethod.GET)
    public ResponseEntity users(){
        List<DemoEntity> list = new ArrayList<DemoEntity>();
        DemoEntity demo = new DemoEntity();
        demo.setId(1);
        demo.setName("蜗牛");
        list.add(demo);
        DemoEntity demo1 = new DemoEntity();
        demo1.setId(2);
        demo1.setName("葡萄");
        list.add(demo1);
        return ResponseUtil.success(list);
    }
}

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

搜索一文入门ElasticSearch(节点分片 CRUD 倒排索引分词)
这篇文章主要为大家介绍了搜索一文入门ElasticSearch(节点分片 CRUD 倒排索引分词)的基础详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-03-03
使用jvm sandbox对三层嵌套类型的改造示例
这篇文章主要为大家介绍了使用jvm sandbox对三层嵌套类型的改造示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-08-08
springmvc+shiro自定义过滤器的实现代码
这篇文章主要介绍了springmvc+shiro自定义过滤器的实现方法，本文通过实例代码给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
2018-10-10
Spring DI依赖注入过程解析
依赖注入是由“依赖”和“注入”两个词汇组合而成，那么我们再一次顺藤摸瓜，分别分析这两个词语，这篇文章主要介绍了Spring DI依赖注入详解,需要的朋友可以参考下
2022-11-11
Java面向对象基础知识之数组和链表
这篇文章主要介绍了Java面向对象的之数组和链表,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有很好的帮助,需要的朋友可以参考下
2021-11-11
Spring配置文件解析之BeanDefinitionReader详解
这篇文章主要介绍了Spring配置文件解析之BeanDefinitionReader详解,ApplicationContext.xml配置文件解析成Document对象,真正对xml中元素解析的类是在BeanDefinitionDocumentReader的实现类中来完成的,需要的朋友可以参考下
2024-02-02
Java Session会话追踪原理深入分析
web开发阶段我们主要是浏览器和服务器之间来进行交互。浏览器和服务器之间的交互就像人和人之间进行交流一样，但是对于机器来说，在一次请求之间只是会携带着本次请求的数据的，但是可能多次请求之间是会有联系的，所以提供了会话机制
2022-11-11
java文件操作之Path,Paths,Files
Java7中文件IO发生了很大的变化，专门引入了很多新的类，下面给大家分享用Files作为一个操作类的实例，需要的朋友可以参考
2017-04-04
Java判断文件或者文件夹是否存在的功能(不存在创建,存在删除)
在Java中,要判断文件或文件夹是否存在,并根据判断结果来执行创建或删除操作,你可以使用java.io.File类或者java.nio.file包中的类,本文介绍Java判断文件或者文件夹是否存在,不存在创建,存在删除,感兴趣的朋友一起看看吧
2025-03-03
SpringMVC实现Controller的三种方式总结
这篇文章主要介绍了SpringMVC实现Controller的三种方式总结，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-02-02