详解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中使用Inputstream流导致中文乱码解决方法

    idea中使用Inputstream流导致中文乱码解决方法

    很多朋友遇到一个措手不及的问题当idea中使用Inputstream流导致中文乱码及Java FileInputStream读中文乱码问题,针对这两个问题很多朋友不知道该如何解决,下面小编把解决方案分享给大家供大家参考
    2021-05-05
  • 解决Eclipse打开.java文件异常,提示用系统工具打开的问题

    解决Eclipse打开.java文件异常,提示用系统工具打开的问题

    这篇文章主要介绍了解决Eclipse打开.java文件异常,提示用系统工具打开的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • Java网络编程UDP实现消息发送及聊天

    Java网络编程UDP实现消息发送及聊天

    这篇文章主要为大家详细介绍了Java网络编程UDP实现消息发送及聊天,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • 深入了解java Lombok的使用方法

    深入了解java Lombok的使用方法

    这篇文章主要介绍了深入了解java Lombok的使用,Lombok是一个通过注解以达到减少代码的Java库,如通过注解的方式减少get,set方法,构造方法等,需要的朋友可以参考下
    2019-06-06
  • springboot使用消息中间件

    springboot使用消息中间件

    这篇文章主要介绍了springboot使用消息中间件,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • Java编程用栈来求解汉诺塔问题的代码实例(非递归)

    Java编程用栈来求解汉诺塔问题的代码实例(非递归)

    这篇文章主要介绍了Java编程用栈来求解汉诺塔问题的代码实例(非递归),具有一定参考价值,这里给大家分享下,供朋友们参考。
    2017-10-10
  • HttpClient详细使用示例代码

    HttpClient详细使用示例代码

    这篇文章主要介绍了HttpClient详细使用示例,包括导入依赖,使用工具类的详细代码,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • 基于@MapperScan和@ComponentScan的使用区别

    基于@MapperScan和@ComponentScan的使用区别

    这篇文章主要介绍了@MapperScan和@ComponentScan的使用区别,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • SpringBoot Cache 二级缓存的使用

    SpringBoot Cache 二级缓存的使用

    本文主要介绍了SpringBoot Cache 二级缓存的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-06-06
  • Java项目开发中实现分页的三种方式总结

    Java项目开发中实现分页的三种方式总结

    这篇文章主要给大家介绍了关于Java项目开发中实现分页的三种方式,通过这一篇文章可以很快的学会java分页功能,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-02-02

最新评论