【Spring boot】第四弹-Spring Boot 设计接口的统一返回对象

该系列糖(wen)果(zhang)建议对Java有一定了解的小伙伴愉快进食。
不大篇幅介绍Spring Boot了,直接上干货吧。

第四弹-Spring Boot 设计接口的统一返回对象

上一弹我们写了自己的第一个接口,我们返回的值是字符串,在日常开发中,我们对外返回的接口应该具备统一的规范,方便其他人使用我们接口。

接下来我们就一起来设计我们自己的统一返回对象咯。

1.结构体设计

先思考一下,我们目前和前端(含web端、移动端)交互的话,一般采用Json格式进行数据交互;那我们先来设计一个统一返回的结构体;
下面是常用的响应结构体:

{
    "code" : "响应code,做请求成功与否的判定",
    "msg" : "返回业务描述信息",
    "data" : "返回数据结果"
}

在一般情况下,使用这样的规范,是完全足够的。

2.代码实现

1>. 创建 base 包
在这里插入图片描述
2>.创建Result.java
在这里插入图片描述
3>.定义响应属性

package org.demo.base;

import java.io.Serializable;

/**
 * @Description:
 * @author: 夜七天
 * @create: 2021/08/06 16:10
 */
public class Result<T> implements Serializable {

    private Integer code;

    private String msg;

    private T date;

    public Result() {

    }

    public Result(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.date = data;
    }

    public Result(ResultCode resultCode, T data) {
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    public T getDate() {
        return date;
    }

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

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

    public void setDate(T date) {
        this.date = date;
    }
}

4>. 定义ResultCode枚举类

package org.demo.base;

/**
 * @Description:
 * @author: 夜七天
 * @create: 2021/08/07 15:07
 */
public enum ResultCode {

    SUCCESS(200, "成功"),
    ;

    private Integer code;

    private String msg;

    public Integer getCode() {
        return this.code;
    }

    public String getMsg() {
        return this.msg;
    }

    ResultCode(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

5>.改造HelloWorldController
在这里插入图片描述

3.启动项目访问接口

启动项目之后,访问http://localhost:8081/helloWorld
在这里插入图片描述

本篇文章真的就只是利用Spring Boot设计接口的统一返回对象。

第一弹-创建Spring Boot项目
第二弹-启动Spring Boot项目
第三弹-利用Spring Boot开发第一个接口
第四弹-Spring Boot 接口的统一返回设计

  • 1
    点赞
  • 3
    收藏
  • 打赏
    打赏
  • 4
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页
评论 4

打赏作者

夜七天

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值