【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. 统一了规范标准
相关推荐
专注API从业者44 分钟前
Open Claw 京东商品监控选品实战:一键抓取、实时监控、高效选品
java·服务器·数据库
CHANG_THE_WORLD1 小时前
python 批量终止进程exe
开发语言·python
摇滚侠1 小时前
DBeaver 导入数据库 导入 SQL 文件 MySQL 备份恢复
java·数据库·mysql
古城小栈1 小时前
从 cargo-whero 库中,找到提升 rust 的契机
开发语言·后端·rust
keep one's resolveY1 小时前
SpringBoot实现重试机制的四种方案
java·spring boot·后端
天空属于哈夫克32 小时前
企业微信API常见的错误和解决方案
java·数据库·企业微信
Gary Studio2 小时前
安卓HAL C++基础-智能指针
开发语言·c++
啧不应该啊3 小时前
Day1 Python 与 C 的类型区别
c语言·开发语言
摇滚侠3 小时前
VMvare 虚拟机 Oracle19c 安装步骤,远程连接 Oracle19c,百度网盘安装包
java·oracle
梁萌3 小时前
idea报错找不到XX包的解决方法
java·intellij-idea·启动报错·缺少包