【Java】---- SpringBoot 统一数据返回格式

目录

  • [1. 统一数据返回格式介绍](#1. 统一数据返回格式介绍)
  • [2. 实际应用](#2. 实际应用)
    • [2.1 添加前后的返回结果区别](#2.1 添加前后的返回结果区别)
    • [2.2 存在问题](#2.2 存在问题)
  • [3. 统一数据返回格式的优点](#3. 统一数据返回格式的优点)

1. 统一数据返回格式介绍

通过使用@ControllerAdvice和引用ResponseBodyAdvice接口来进行实现。

ResponseBodyAdvice这个接口里面有两个方法,分别是:

  • supports方法:判断是否要执行下面的beforeBodyWrite方法。true为执行,false不执行。通过该方法可以选择哪些类或哪些方法的response是否要进行统一返回格式处理。
  • beforeBodyWrite方法:对response方法进行具体的统一返回格式操作。

2. 实际应用

2.1 添加前后的返回结果区别

下面实际应用和测试是基于图书管理系统下进行的,在结果类Result中:

java 复制代码
package com.example.book.model;

import com.example.book.enums.ResultStatus;
import lombok.Data;

@Data
public class Result<T> {
    private ResultStatus code; //业务码:不是http状态码  200:成功,-2:失败, -1:未登录
    private String errMsg;// 错误信息,如果业务成功,errMsg为空
    private T data;

    public static <T> Result success(T data) {
        Result result = new Result<>();
        result.setCode(ResultStatus.SUCCESS);
        result.setData(data);
        return result;
    }

    public static Result nologin() {
        Result result = new Result<>();
        result.setCode(ResultStatus.NOLOGIN);
        result.setErrMsg("用户未登录");
        return result; //result.setData(null);
    }

    public static Result fail(String msg) {
        Result result = new Result<>();
        result.setCode(ResultStatus.FAIL);
        result.setErrMsg(msg);
        return result;
    }

    public static Result fail(ResultStatus resultStatus,String msg) {
        Result result = new Result<>();
        result.setCode(resultStatus);
        result.setErrMsg(msg);
        return result;
    }
}
  • 添加统一数据返回格式之前:
  • 添加统一数据返回格式之后

2.2 存在问题

  1. 一些方法返回的结果已经是Result类型,那就直接返回Result类型的结果即可
  2. 测试多种不同的返回结果,当返回结果为String类型时会出现后端接口会返回结果显示,发送内部错误,当查看数据库的时候,发现数据操作成功。
    测试接口:
    查看数据库时:
    查看日志:
  • 解决方法:
    使用springBoot内置提供的Jackson来实现信息的序列化

3. 统一数据返回格式的优点

  1. 有利于项目统一数据的维护和修改
  2. 方便前端更好的接收和解析后端接口返回的数据
  3. 统一了规范标准
相关推荐
老胖闲聊1 分钟前
Python Copilot【代码辅助工具】 简介
开发语言·python·copilot
Blossom.1185 分钟前
使用Python和Scikit-Learn实现机器学习模型调优
开发语言·人工智能·python·深度学习·目标检测·机器学习·scikit-learn
Mr_Air_Boy32 分钟前
SpringBoot使用dynamic配置多数据源时使用@Transactional事务在非primary的数据源上遇到的问题
java·spring boot·后端
曹勖之35 分钟前
基于ROS2,撰写python脚本,根据给定的舵-桨动力学模型实现动力学更新
开发语言·python·机器人·ros2
豆沙沙包?1 小时前
2025年- H77-Lc185--45.跳跃游戏II(贪心)--Java版
java·开发语言·游戏
军训猫猫头1 小时前
96.如何使用C#实现串口发送? C#例子
开发语言·c#
年老体衰按不动键盘1 小时前
快速部署和启动Vue3项目
java·javascript·vue
咖啡啡不加糖2 小时前
Redis大key产生、排查与优化实践
java·数据库·redis·后端·缓存
liuyang-neu2 小时前
java内存模型JMM
java·开发语言
UFIT2 小时前
NoSQL之redis哨兵
java·前端·算法