详解SpringBoot如何统一处理返回的信息

 更新时间:2023年06月06日 09:14:12   作者:Jimmy  
现在的项目是前后端开发的居多,那么我们怎么定义接口返回的数据,怎么使用 Spring Boot 来统一处理返回的信息呢,本文就来和大家简单讲讲

现在的项目是前后端开发的居多,那么,后端的开发只需要返回相关的接口就行了。那么,我们怎么定义接口返回的数据,怎么使用 Spring Boot 来统一处理返回的信息呢?

开发环境如下:

  • IntelliJ IDEA 2021.2.2 (Ultimate Edition)
  • macOS Monterey - Apple M1
  • Java version - 17.0.7
  • Spring Boot - 3.1.0

定义返回的信息格式

一个合理的信息返回格式,至少包含下面三个字段:

{
  "code": "0",
  "message": "请求成功",
  "data": {
    "name": "Jimmy"
  }
  ""
}

code 表示返回的状态,我们这个可以自行定义,10000 代表成功; 20000 代表某某等;message 表示接口返回的信息,是否成功了,失败的理由是什么等;data 是表示请求成功后,返回的数据,可以是数组也可以是对象等。

信息返回格式,是否应该有其他字段,按照需求调整。

实践

我们使用 Spring Boot 来实践一下,通过 IDEA 新建一个名为 jimmy-response 的项目:

添加 lombok

Lombok 是一个插件,其主要的用途是提供了简单注释的形式来帮助我们简化消除一些必须有但是显得很臃肿的 java 代码,提高编码效率,使代码更加简洁。

pom.xml 中添加依赖:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

如果并没有自动安装。点击 pom.xml 文件右上角同步图案即可。

定义返回的对象

我们在 ResultData.java 中定义返回的类:

// ResultData.java
package com.example.jimmyresponse;
import lombok.Data;
@Data
public class ResultData<T> {
    private String code;
    private String message;
    private T data;
    // 扩展字段,比如接口请求时间
    private long accessTimestamp;
    // 构造函数
    public ResultData() {
        this.accessTimestamp = System.currentTimeMillis();
    }
    // 成功返回
    public static <T> ResultData<T> success(T data) {
        ResultData<T> resultData = new ResultData<>();
        resultData.setCode("10000");
        resultData.setMessage(("请求成功!"));
        resultData.setData(data);
        return resultData;
    }
    // 失败返回
    public static <T> ResultData<T> fail(String code, String message) {
        ResultData<T> resultData = new ResultData<>();
        resultData.setCode(code);
        resultData.setMessage(message);
        return resultData;
    }
}

模拟数据

我们定义一个类来模拟用户的数据:

package com.example.jimmyresponse;
public class User {
    public String name;
    public User(String name) {
        this.name = name; // 用户名
    }
}

调用

最后,我们调用定义好的返回对象:

// ApiControll.java
package com.example.jimmyresponse;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ApiController<T> {
    @GetMapping("/")
    public T getList() {
        // 模拟用户数据
        User users[] = {
                new User("Jimmy"),
                new User("Ivy")
        };
        return (T) ResultData.success(users); // 信息成功返回
    }
}

结果的如下:

到此这篇关于详解SpringBoot如何统一处理返回的信息的文章就介绍到这了,更多相关SpringBoot统一处理返回信息内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • idea如何解决maven依赖冲突

    idea如何解决maven依赖冲突

    这篇文章主要介绍了idea如何解决maven依赖冲突问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • Spring mvc工作原理_动力节点Java学院整理

    Spring mvc工作原理_动力节点Java学院整理

    这篇文章主要为大家详细介绍了Spring mvc工作原理的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-08-08
  • Java编程中的防转义和转义技巧汇总

    Java编程中的防转义和转义技巧汇总

    在编程过程中,我们常常需要处理特殊字符和特定上下文,以确保生成的内容在正确的环境中能够被解析和显示,本文将介绍一些常见的防转义或者转义处理的编程技巧,需要的可以参考一下
    2023-07-07
  • Java连接超时的几种情况以及读取代码

    Java连接超时的几种情况以及读取代码

    在Java编程中连接超时异常是指在建立网络连接时,无法在给定的时间内成功建立连接的异常,这篇文章主要给大家介绍了关于Java连接超时的几种情况以及读取的相关资料,需要的朋友可以参考下
    2024-02-02
  • mybatis一对一查询功能

    mybatis一对一查询功能

    所谓的一对一查询,就是说我们在查询一个表的数据的时候,需要关联查询其他表的数据。这篇文章主要介绍了mybatis一对一查询功能,需要的朋友可以参考下
    2017-02-02
  • SpringCloudStream中的消息分区数详解

    SpringCloudStream中的消息分区数详解

    这篇文章主要介绍了SpringCloudStream中的消息分区数,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • SpringBoot实战项目之谷歌浏览器全屏效果实现

    SpringBoot实战项目之谷歌浏览器全屏效果实现

    这篇文章主要介绍了通过 Java SpringBoot来实现谷歌浏览器的全屏效果,希望页面展示时可以实现全屏效果以提高用户体验。感兴趣的小伙伴跟着小编往下看吧
    2021-09-09
  • java裁剪图片并保存的示例分享

    java裁剪图片并保存的示例分享

    在这篇文章中我们将学习如何用Java 对图像进行剪裁并将剪裁出来的部分单独保存到文件中
    2014-01-01
  • java实现ATM取款项目

    java实现ATM取款项目

    这篇文章主要为大家详细介绍了java实现ATM取款项目的实现代码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • java中URLEncoder.encode与URLDecoder.decode处理url特殊参数的方法

    java中URLEncoder.encode与URLDecoder.decode处理url特殊参数的方法

    这篇文章主要给大家介绍了关于java中URLEncoder.encode与URLDecoder.decode处理url特殊参数的方法,文中介绍的非常详细,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-03-03

最新评论