一文教你处理SpringBoot统一返回格式

最新推荐文章于 2024-08-07 14:56:40 发布

肥肥技术宅

最新推荐文章于 2024-08-07 14:56:40 发布

阅读量2.2k

点赞数 2

本文链接：https://blog.csdn.net/m0_71777195/article/details/126284110

版权

背景

相信大部分后端开发人员在日常开发中都需要和前端对接，当然前后端都是你自己一个人搞的话可以想怎么玩就怎么玩，但是我们还是要做到一定的规范性。在前后端分离的项目中后端返回的格式一定要友好，并且固定，不能经常变来变去，不然会对前端的开发人员带来很多的工作量。

SpringBoot Controller 常见的返回格式

String

@PostMapping("/test")
public String test(){
    return "Hello World";
}
复制代码

postman调用结果：

自定义对象

正常返回

    @PostMapping("/getUser")
    public ActionResult getUser(){
        User user = new User();
        user.setId(UUID.randomUUID().toString());
        user.setName("MrDong");
        user.setAge(20);
        return ActionResult.defaultOk(user);
    }
复制代码

postman调用结果：

错误返回

   @PostMapping("/error")
    public ActionResult error(){
        return ActionResult.defaultFail(1000,"服务器异常，请联系管理员");
    }
复制代码

postman调用结果：

定义返回对象

我定义两个ActionResult这个对象来对返回值进行封装，可以根据自己公司实际情况修改：

package com.wxd.entity;

import com.wxd.enums.ResultCodeEnum;
import lombok.Data;

/**
 * @ClassName ActionResult
 * @Description 统一返回值封装
 * @Author Mr Dong
 * @Date 2022/7/26 14:51
 */
@Data
public class ActionResult {

    private Integer code;
    private String msg;
    private Integer count;
    private Object data;

    public static ActionResult defaultOk(Integer code, String msg,