【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. 统一了规范标准
相关推荐
Jonathan Star8 分钟前
MediaPipe 在Python中实现人体运动识别,最常用且高效的方案是结合**姿态估计**(提取人体关键点)和**动作分类**(识别具体运动)
开发语言·python·分类
滨HI020 分钟前
C++ opencv拟合直线
开发语言·c++·opencv
沐浴露z30 分钟前
详解JDK21新特性【虚拟线程】
java·开发语言·jvm
艾莉丝努力练剑43 分钟前
【C++:红黑树】深入理解红黑树的平衡之道:从原理、变色、旋转到完整实现代码
大数据·开发语言·c++·人工智能·红黑树
No0d1es1 小时前
电子学会青少年软件编程(C/C++)1级等级考试真题试卷(2025年9月)
java·c语言·c++·青少年编程·电子学会·真题·一级
l1t1 小时前
利用DeepSeek优化SQLite求解数独SQL用于DuckDB
开发语言·数据库·sql·sqlite·duckdb
_OP_CHEN1 小时前
C++进阶:(七)红黑树深度解析与 C++ 实现
开发语言·数据结构·c++·stl·红黑树·红黑树的旋转·红黑树的平衡调整
9号达人1 小时前
普通公司对账系统的现实困境与解决方案
java·后端·面试
硅农深芯1 小时前
如何使用ptqt5实现进度条的动态显示
开发语言·python·qt
超级苦力怕1 小时前
Java 为何 long a = 999999999 能过;long a = 9999999999 报错?一文讲透“宽化转换”
java