【8】SpringBoot统一接口返回的标准格式R.java

最新推荐文章于 2024-07-29 09:05:28 发布
最新推荐文章于 2024-07-29 09:05:28 发布
阅读量1k 收藏 2
点赞数
文章标签： java spring boot 开发语言
原文链接：https://www.kuangstudy.com/
版权

SpringBoot统一接口返回的标准格式R.java

文章目录

01、分析

在后续我们会项目实战，项目实战一种前后端分离的开发方式。我们会通过swagger来进行接口测试。这个时候就会出现一个问题？

一个小团队：1~11人

大的开发团队：20+

  • 每个开发者，对自己的代码都有一套自己的逻辑和哲学，返回值就千变万化。
  • 带来的问题很明显，接口的调用者，就开始尝试一个错觉或者不明确的想象。

怎么办？

统一返回处理

格式如下

# 成功的状态
{
   code:200,
   data:{id:"1",name:"yykkk"},
   message:"success"
}

# 失败
{
   code:401,
   data:"",
   message:"用户名和账号有误"
}

{
   code:500,
   data:"",
   message:"服务器出错!!"
}

02、封装统一返回的R类-基础封装认识

在企业中，有些公司命名：R.java、Result.java 、 ServerResponse 等。其实都是一个意思。

封装如下：

import lombok.Data;

/**
 * # 成功的状态
 * {
 *    code:200,
 *    data:{id:"1",name:"yykkk"},
 *    message:"success"
 * }
*/

@Data
public class R {

    // 返回的编号
    private Integer code;
    // 返回的数据,数据类型N中，
    private Object data;
    // 返回的信息
    private String message;

}

使用如下：

@RestController
@Slf4j
public class RegController {


    @Autowired
    private RegService regService;

    /**
     * @Author xuke
     * @Description 用户注册
     * @Date 20:11 2021/6/23
     * @Param []
     * @return java.lang.String
    **/
    @GetMapping("/reg")
    public R reguser(){
        // 1: 注册用户 10ms
        log.info("新用户注册");
        //userService.save(user);

        // 2: 发送短信 5s
        log.info("发送短信");
        regService.sendMsg();

        // 3: 添加积分 5s
        log.info("添加积分");
        regService.addScore();


        R r = new R();
        r.setCode(200);
        r.setData("ok");
        r.setMessage("注册成功!");

        return r;
    }
}

启动

访问：http://localhost:9999/reg，结果如下：

{"code":200,"data":"ok","message":"注册成功!"}

问题：

频繁的创建R类，是不是有点不妥呢，第一会增加：内存开销，第二：代码臃肿和冗余。

03、封装统一返回的R类-静态方法封装

优化思考：

用静态方法方法去优化和封装，

开始优化

记住：在开发中成功只有一种情况，失败有N中情况。所有成功封装的逻辑是如下：

/**
 * # 成功的状态
 * {
 * code:200,
 * data:{id:"1",name:"yykkk"},
 * message:"success"
 * }
 **/

@Data
public class R {

    // 返回的编号
    private Integer code;
    // 返回的数据,数据类型N中，
    private Object data;
    // 返回的信息
    private String message;

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data, String message) {
        R r = new R();
        r.setCode(200);
        r.setData(data);
        r.setMessage(message);
        return r;
    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data) {
        return success(data, "");
    }
}

启动

访问：http://localhost:9999/reg，结果如下：

{"code":200,"data":"ok","message":"注册成功!"}

解决的问题：

代码臃肿和冗余。

04、封装统一返回的R类-失败的封装

记住：在开发中成功只有一种情况，失败有N中情况。所有成功封装的逻辑是如下：

/**
 * # 失败
 * {
 * code:401,
 * data:"",
 * message:"用户名和账号有误"
 * }
 **/


@Data
public class R {

    // 返回的编号
    private Integer code;
    // 返回的数据,数据类型N中，
    private Object data;
    // 返回的信息
    private String message;

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data, String message) {
        R r = new R();
        r.setCode(200);
        r.setData(data);
        r.setMessage(message);
        return r;
    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data) {
        return success(data, "");
    }


    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description
     * @Date 22:03 2021/6/23
     * @Param [code 失败的状态, message 失败的原因]
     **/
    public static R fail(Integer code, String message) {
        R r = new R();
        r.setCode(code);
        r.setData(null);
        r.setMessage(message);
        return r;
    }
}

测试如下：

@GetMapping("/reg2")
public R reguser2(Integer flag) {
    if (flag.equals(1)) {
        return R.fail(401, "用户名和密码错误!!!");
    }
    if (flag.equals(2)) {
        return R.fail(402, "密码和确认密码不一致!!!");
    }
    // 1: 注册用户 10ms
    log.info("新用户注册");
    //userService.save(user);

    // 2: 发送短信 5s
    log.info("发送短信");
    regService.sendMsg();

    // 3: 添加积分 5s
    log.info("添加积分");
    regService.addScore();

    return R.success("ok");
}

测试结果：

http://localhost:9999/reg2?flag=0 正常返回

{"code":200,"data":"ok","message":""}

http://localhost:9999/reg2?flag=1 失败返回

{"code":401,"data":null,"message":"用户名和密码错误!!!"}

http://localhost:9999/reg2?flag=2 正常返回

{"code":402,"data":null,"message":"密码和确认密码不一致!!!"}

05、封装统一返回的R类-把构造函数私有化

为什么要要构造函数私有化呢？

答案：当调用的过程变得单一，只允许用用类去调用方法，不允许用new去调用。

@Data
public class R {

    // 返回的编号
    private Integer code;
    // 返回的数据,数据类型N中，
    private Object data;
    // 返回的信息
    private String message;

    private R (){

    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data, String message) {
        R r = new R();
        r.setCode(200);
        r.setData(data);
        r.setMessage(message);
        return r;
    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data) {
        return success(data, "");
    }


    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description
     * @Date 22:03 2021/6/23
     * @Param [code 失败的状态, message 失败的原因]
     **/
    public static R fail(Integer code, String message) {
        R r = new R();
        r.setCode(code);
        r.setData(null);
        r.setMessage(message);
        return r;
    }
}

06、封装统一返回的R类-统一返回状态的维护和message的维护问题

如下代码，如果在实际的开发和生产中，这样的编写的话，肯定是会技术leader骂死的，一般早期可以为了完成任务或者业务，可能这样写是没问题。但是随着团队和业务越来越复杂。下面这个就一定要进行统一处理。（集中管理）

if (flag.equals(1)) {
  return R.fail(401, "用户名和密码错误!!!");
}
if (flag.equals(2)) {
  return R.fail(402, "密码和确认密码不一致!!!");
}

集中管理的解决方案

1：用接口或者常量类：比如

public class RConstants {

    // 用户名和密码错误信息和状态
    public static final Integer USER_REG_USER_PASSWORD_CODE = 401;
    public static final String USER_REG_USER_PASSWORD_ERROR = "用户名和密码错误!";

    // 密码和确认密码错误信息和状态
    public static final Integer USER_REG_USER_PASSWORD_CONFIRM_CODE = 402;
    public static final String USER_REG_USER_PASSWORD_CONFIRM_ERROR = "密码和确认密码不一致!";

}

if (flag.equals(1)) {
    return R.fail(RConstants.USER_REG_USER_PASSWORD_CODE,RConstants.USER_REG_USER_PASSWORD_ERROR);
}
if (flag.equals(2)) {
    return R.fail(RConstants.USER_REG_USER_PASSWORD_CONFIRM_CODE,RConstants.USER_REG_USER_PASSWORD_CONFIRM_ERROR);
}

通过常量类：其实并不明确，当我们的错误状态和信息越来越多的时候，这个它的可维护就出现很多问题。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KLiweuFl-1653404158205)(assets/1624457916519.png)]

2：使用枚举

/**
 * @description: 统一返回的常量类
 * 对内修改开放，对外修改关闭---枚举
 * @author: xuke
 * @time: 2021/6/23 22:12
 */
public enum ResponseEnum {

    USER_REG_USER_PASSWORD_CODE(401,"用户名和密码错误"),
    USER_REG_USER_PASSWORD_CONFIRM(402,"密码和确认密码不一致");

    private Integer code;
    private String message;

    ResponseEnum(Integer code,String mesage){
        this.code = code;
        this.message =mesage;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

修改如下：

if (flag.equals(1)) {
  return R.fail(ResponseEnum.USER_REG_USER_PASSWORD_CODE.getCode(),
                ResponseEnum.USER_REG_USER_PASSWORD_CODE.getMessage());
}
if (flag.equals(2)) {
  return R.fail(ResponseEnum.USER_REG_USER_PASSWORD_CONFIRM.getCode(),
                ResponseEnum.USER_REG_USER_PASSWORD_CONFIRM.getMessage());
}

07、封装统一返回的R类-统一枚举的最终方案

@Data
public class R {

    // 返回的编号
    private Integer code;
    // 返回的数据,数据类型N中，
    private Object data;
    // 返回的信息
    private String message;

    private R() {

    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data, String message) {
        R r = new R();
        r.setCode(ResponseEnum.SUCCESS.getCode());
        r.setData(data);
        r.setMessage(message == null ? ResponseEnum.SUCCESS.getMessage() : message);
        return r;
    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description 成功返回
     * @Date 21:55 2021/6/23
     * @Param []
     **/
    public static R success(Object data) {
        return success(data, null);
    }


    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description
     * @Date 22:03 2021/6/23
     * @Param [code 失败的状态, message 失败的原因]
     **/
    public static R fail(Integer code, String message) {
        R r = new R();
        r.setCode(code);
        r.setData(null);
        r.setMessage(message);
        return r;
    }

    /**
     * @return com.kuangstudy.common.R
     * @Author xuke
     * @Description
     * @Date 22:03 2021/6/23
     * @Param [code 失败的状态, message 失败的原因]
     **/
    public static R fail(ResponseEnum responseEnum) {
        R r = new R();
        r.setCode(responseEnum.getCode());
        r.setData(null);
        r.setMessage(responseEnum.getMessage());
        return r;
    }
}

传递枚举引用

package com.kuangstudy.common;

/**
 * @description: 统一返回的常量类
 * 对内修改开放，对外修改关闭---枚举
 * @author: xuke
 * @time: 2021/6/23 22:12
 */
public enum ResponseEnum {

    SUCCESS(200,"成功!"),

    USER_REG_USER_PASSWORD_CODE(401,"用户名和密码错误"),
    USER_REG_USER_PASSWORD_CONFIRM(402,"密码和确认密码不一致"),
    ORDER_FAIL(601,"订单失败"),
    ORDER_MESSAGE_FAIL(602,"订单发送消息失败") ;

    private Integer code;
    private String message;

    ResponseEnum(Integer code,String mesage){
        this.code = code;
        this.message =mesage;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

调用


    /**
     * @return java.lang.String
     * @Author xuke
     * @Description 用户注册
     * @Date 20:11 2021/6/23
     * @Param []
     **/
    @GetMapping("/reg2")
    public R reguser2(Integer flag) {
        if (flag.equals(1)) {
            return R.fail(ResponseEnum.USER_REG_USER_PASSWORD_CODE);
        }
        if (flag.equals(2)) {
            return R.fail(ResponseEnum.USER_REG_USER_PASSWORD_CONFIRM);
        }
        // 1: 注册用户 10ms
        log.info("新用户注册");
        //userService.save(user);

        // 2: 发送短信 5s
        log.info("发送短信");
        regService.sendMsg();

        // 3: 添加积分 5s
        log.info("添加积分");
        regService.addScore();

        return R.success("ok");
    }

08、统一返回的参考来源

参考：

1、mybatis-plus–R类

2、springmvc中有一个：ResponseEntity和HttpStatus一个枚举类，如下：

@GetMapping("/reg2")
public ResponseEntity reguser2(Integer flag) {
    // 1: 注册用户 10ms
    log.info("新用户注册");
    //userService.save(user);

    // 2: 发送短信 5s
    log.info("发送短信");
    regService.sendMsg();

    // 3: 添加积分 5s
    log.info("添加积分");
    regService.addScore();
    // 这是失败的
    //return ResponseEntity.status(HttpStatus.BAD_GATEWAY);
    // 这是成功
    return ResponseEntity.ok("success");
}

为什么在开发中，我们不使用springMvc提供好的，还多此一举自己的去定义和实现一个R和一个枚举呢？

答案：

  • 因为springmvc这些满足不了我们的业务开发需求

  • 还有里面的状态的控制和返回，都和业务可能没有什么太大匹配关系。不明确

DisguiseR6
关注
公共服务响应：SpringBoot 统一后端返回格式、处理全局异常
iOS逆向与安全
03-26 586
status 状态值：由后端统一定义各种返回结果的状态码message 描述：本次接口调用的结果描述data 数据：本次返回的数据。sign ： 签名信息@Getter@Setter@ApiModelProperty(value = "请求结果状态000000成功 其他是失败")@ApiModelProperty(value = "附加消息")@ApiModelProperty(value = "返回签名")@ApiModelProperty(value = "数据")
【微服务】springboot 实现动态修改接口返回值
最新发布
congge
09-28 8206
springboot 实现动态修改接口返回值
spring boot 统一JSON格式的接口返回结果的实现
10-16
主要介绍了spring boot 统一JSON格式的接口返回结果的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot统一返回R类
Joker_DJ
09-09 5624
在项目开发过程中，很难避免返回各种各样的结果，就会导致前端渲染时造成混乱，怎么统一返回呢？ 编写R.java Object /** * @Author Joker DJ * @Date 2021/8/7 20:58 * @Version 1.0 */ public class R { /** *标识返回状态 */ private Integer code; /** * 标识返回内容 */ private Object da
统一返回结果类
Small_Pang的博客
09-22 802
记录下自己用过的统一返回结果集 其中有swagger注解，没有的可以删去 import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.HashMap; import java.util.Map; /** * 统一返回结果类 */ @Data public class R { @ApiModelProperty(value = "是否成功") private Boolean.
8、SpringBoot中的统一返回R类和统一异常处理02
qq_41978323的博客
01-16 2319
01、为什么学习统一返回？ 在企业其实大部分的程序开发，或者接口开发，其实都返回一种所谓的JSON格式。而json格式是通过java面向对象的方式进行封装而得。 在统一异常处理的时候，我们使用的是@RestControllerAdvice是controller后置增强处理。使用@RestControllerAdvice后置处理可以达到 在前后端分离的项目架构中，全部都是异步返回@RestController 也全部都是@ResponseBody的方法。以为你没有页面也没有所谓的freemarker。所以在
SpringBoot统一接口返回的标准格式R.java
mutf7的博客
07-21 1164
SpringBoot统一接口返回的标准格式R.java 1、分析 前后端分离的开发方式，通过swagger来进行接口测试。 每个开发者，对自己的代码都有一套自己的逻辑和哲学，返回值就千变万化。接口的调用者，对于返回值的不理解。 解决方法：统一返回处理 2、格式 # 成功的状态 { code:200, data:{id:"1",name:"yykkk"}, message:"success" } # 失败 { code:401, data:"", message:"用户名
前后端分离开发：Spring Boot返回统一的数据格式
Java技术工坊
10-17 2752
项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一， 使前端(iOS Android, Web)对数据的操作更一致、轻松。 一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容 ...
告别混乱代码：SpringBoot 后端接口规范
2301_78588786的博客
07-15 267
因为 HTTP 协议是无状态的，Token 的设计方案是用户在客户端使用用户名和密码登录后，服务器会给客户端返回一个 Token，并将 Token 以键值对的形式存放在缓存（一般是 Redis）中，后续客户端对需要授权模块的所有操作都要带上这个 Token，服务器端接收到请求后进行 Token 验证，如果 Token 存在，说明是授权的请求。如果在缓存中的签名失效的情况下，有人使用同一个 URL 再次访问，则会被时间戳超时机制拦截，这就是为什么要求 sign 的超时时间要设定为跟时间戳的超时时间一致。
Spring Boot 统一数据返回格式
qq_45875349的博客
05-28 2041
使用@ControllerAdvice和@ResponseBodyAdvice统一API数据返回格式
R1.java——接口返回规范（code，data，message）
10-12
接口返回规范，其中包含（code状态码，data承载数据，message返回消息）
Java统一返回类型R
台南没有木的博客
07-12 9398
为什么使用 项目中我们会将响应封装成JSON返回，一般我们会将所有接口的数据格式统一， 使前端对数据的操作更一致、轻松。 一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数 据就可以。但是一般会包含状态码、返回消息、数据这几部分内容 一. 统一返回数据格式 { "success": 布尔, //响应是否成功 "code": 数字, //响应码 "message": 字符串, //返回消息 "data": HashMap //返回数据，放在键值对中 } 二 .
【Spring Boot】统一数据返回，直接使用
热门推荐
weixin_44976692的博客
07-07 3万+
在Web应用程序开发中，统一数据返回格式对于前后端分离项目尤为重要。通过统一的数据返回格式，可以大大简化前端数据解析的复杂度，提高代码的可维护性和一致性。本文将介绍如何在Spring Boot项目中实现统一的数据返回格式。
SpringBoot 如何统一后端返回格式？老鸟们都是这样玩的！
飘渺Jam的博客
07-07 4737
大家好，我是飘渺Jam，今天我们来聊聊分布式事务，以及常见的几种解决方式。 分布式事务基础 事务 事务指的就是一个操作单元，在这个操作单元中的所有操作最终要保持一致的行为，要么所有操作都成功，要么所有的操作都被撤销。简单地说，事务提供一种“要么什么都不做，要么做全套”机制。 本地事务 本地事务其实可以认为是数据库提供的事务机制。说到数据库事务就不得不说，数据库事务中的四大特性: A：原子性(Atomicity)，一个事务中的所有操作，要么全部完成，要么全部不完成 C：一致性(Consistency)，在一个
SpringBoot实用性Controller类返回参数
weixin_44641729的博客
03-22 499
SpringBoot实用性Controller类返回参数 import java.util.ArrayList; import java.util.HashMap; import java.util.Map; import org.apache.http.HttpStatus; public class R extends HashMap<String, Object> { pr...
精简高效：深入探究SpringBoot中的R类
繁依Fanyi的博客
07-29 1752
SpringBoot 是基于 Spring 框架的一种快速应用开发框架，它通过简化配置和开发过程，使得构建独立、生产级的 Spring 应用变得更加容易。SpringBoot 提供了一系列开箱即用的功能，包括自动配置、嵌入式服务器、生产就绪特性等，这些都让开发者能够专注于业务逻辑，而不是繁琐的配置和环境搭建。在构建 Web 应用时，我们经常需要与前端进行数据交互。传统上，后端 API 的响应格式可能各不相同，这不仅增加了前端处理响应数据的复杂度，还容易引发维护和调试方面的问题。
统一接口的返回-R类
zhuiQingran的博客
09-29 956
统一接口的返回-R类 从而统一返回结构的格式-封装统一返回的R类。 第一步，我们需要定义一个R类，来确定返回的格式，成功就一种情况，但是失败有很多情况，所以此时就需要第二步，定义一个枚举类，来统一管理错误的code和message。 package com.xiaochu.qingning.common.utils; import org.apache.http.HttpStatus; import java.util.HashMap; import java.util.Map; /** * @de
springboot基本配置和接口开发标准返回类
weixin_58473601的博客
07-16 642
springboot基本配置和接口开发标准返回类
java统一返回值类
qq_42449963的博客
08-27 559
java统一返回值类
springboot统一返回格式
03-09
SpringBoot 统一返回格式是通过定义一个统一的数据结构来实现的，一般称之为 ResponseBody。在 SpringBoot 中，我们可以使用 @RestController 注解来标记一个控制器类，然后在方法上使用 @ResponseBody 注解来指定...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值