SpringBoot全局处理统一返回类型方式

 更新时间:2023年07月21日 14:38:59   作者:Ray丿雷  
这篇文章主要介绍了SpringBoot全局处理统一返回类型方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

SpringBoot全局处理统一返回类型

在日常开发中,我们会定义各种各样的返回类型,不便于后期维护,也不便于前台进行数据处理;有些项目会封装一个统一的返回类型,让开发人员用这个封装类返回,但是随着项目人员的变更,如果没有统一的要求规范,后期也会变得不可控,而且代码的耦合度也太高。

基于此场景,我们封装了一个统一返回类型(响应状态、返回数据等),并设置全局统一处理。

接口调用返回如下所示:

{
	"code": 200,   //响应状态
	"cost": 0,     //请求耗时,在本文章不做演示
	"data": "test",//返回数据
	"msg": "成功"   //响应描述
}

需要的依赖     

首先添加需要的依赖

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.9</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

Result(返回类)

然后,我们定义一个返回类,全局返回统一采用本模板返回,包含一个前端常用字段,还有一些初始化对象的方法。

package com.gml.springboot2.entity;
import com.gml.springboot2.enums.ResultEnum;
import lombok.Data;
import java.io.Serializable;
/**
 * @author gml
 * @description  全局统一返回类型
 * @date 2019/11/29
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result<T> implements Serializable {
    /**
     * 成功数据
     */
    private T data;
    /**
     * 响应编码200为成功
     */
    private Integer code;
    /**
     * 请求消耗时间
     */
    private long cost;
    /**
     * 描述
     */
    private String msg;
    /**
     * 请求id
     */
    private String requestId;
    public Result(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public static Result create(Integer code, String msg){
        Result result = new Result(code, msg);
        return result;
    }
    /**
     * 无数据返回成功
     * @return
     */
    public static Result createSuccess() {
        return create(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMsg());
    }
    /**
     * 有数据返回成功
     * @param data
     * @param <T>
     * @return
     */
    public static <T> Result<T> createSuccess(T data) {
        return createSuccess().setData(data);
    }
    /**
     * 无描述返回失败
     * @return
     */
    public static Result createFail() {
        return create(ResultEnum.Fail.getCode(), ResultEnum.Fail.getMsg());
    }
    /**
     * 自定义返回失败描述
     * @param code
     * @param msg
     * @return
     */
    public static Result createFail(Integer code, String msg) {
        return create(code, msg);
    }
    public Result setData(T data){
        this.data = data;
        return this;
    }
}

全局设置

实现ResponseBodyAdvice接口,ResponseBodyAdvice是Spring4.1新加入的接口,在消息体被HttpMessageConverter写入之前允许Controller中的方法调整响应中的内容,比如做一些返回处理。

ResponseBodyAdvice接口里面一共定义了两个方法

  • supports:进行一些逻辑判断是否需要进行后续的beforeBodyWrite的方法
  • beforeBodyWrite进行一些返回处理

然后一定一个类实现ResponseBodyAdvice接口,代码如下:

package com.gml.springboot2.config;
import com.alibaba.fastjson.JSONObject;
import com.gml.springboot2.entity.Result;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import java.util.Objects;
/**
 * @author gml
 * @description
 * @date 2019/11/29
 */
@RestControllerAdvice
public class CommonResponseAdvice implements ResponseBodyAdvice {
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return filter(methodParameter);
    }
    /**
     * 根据返回类型来判断是否需要进行后续操作
     * @param methodParameter
     * @return
     */
    private boolean filter(MethodParameter methodParameter) {
        return true;
    }
    /**
     *
     * @param returnValue           返回值
     * @param methodParameter       Controller方法返回类型
     * @param mediaType
     * @param aClass
     * @param serverHttpRequest
     * @param serverHttpResponse
     * @return
     */
    @Override
    public Object beforeBodyWrite(Object returnValue, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        Result result;
        //获取返回值类型
        String returnClassType = returnType.getParameterType().getSimpleName();
        //如果返回值类型为void,则默认返回成功
        if("void".equals(returnClassType)){
            result = Result.createSuccess();
        }else if ("Result".equals(returnClassType)){
            result = (Result) returnValue;
        }else if ("String".equals(returnClassType)){
            //json的转换会出问题
            result = Result.createSuccess(returnValue);
            result.setCost(cost);
            return JSON.toJSONString(result);
        }else {
            if (Objects.isNull(returnValue)){
                result = Result.createSuccess();
            }else {
                result = Result.createSuccess(returnValue);
            }
        }
        //一定要转换为String,否则会报错
        return result;
    }
}

测试

写一个Controller,测试一下返回值

package com.gml.springboot2.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author gml
 * @description
 * @date 2019/11/29
 */
@RestController
public class TestController {
    @RequestMapping("/test")
    public String test(){
        return "返回数据";
    }
}

浏览器访问如下图

 

测试成功~

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Postman实现传List<String>集合

    Postman实现传List<String>集合

    这篇文章主要介绍了Postman实现传List<String>集合方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • 使用Java程序化地在Excel工作表中应用各种条件格式

    使用Java程序化地在Excel工作表中应用各种条件格式

    在数据分析和报表制作过程中,快速识别关键数据、异常值和趋势是提高工作效率的关键,本文将介绍如何使用 Java 程序化地在 Excel 工作表中应用各种条件格式,需要的朋友可以参考下
    2026-04-04
  • 浅析java消息摘要与数字签名

    浅析java消息摘要与数字签名

    这篇文章给大家分析了关于java消息摘要与数字签名的相关知识点内容,有兴趣的朋友们可以学习下。
    2018-08-08
  • 图文讲解Java中实现quickSort快速排序算法的方法

    图文讲解Java中实现quickSort快速排序算法的方法

    这篇文章主要介绍了Java中实现quickSort快速排序算法的方法,文章最后还介绍了一种单向扫描的实现方法,需要的朋友可以参考下
    2016-05-05
  • springboot定时任务@Scheduled执行多次的问题

    springboot定时任务@Scheduled执行多次的问题

    这篇文章主要介绍了springboot定时任务@Scheduled执行多次问题的解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • mybatis执行任意SQL问题

    mybatis执行任意SQL问题

    文章主要介绍了使用MyBatis执行任意SQL的方法,包括声明接口、使用注解调用等步骤,并提到尝试使用泛型进行结果集处理时遇到的问题,最后给出一种改进后的解决方案
    2026-05-05
  • Java中的HashMap弱引用之WeakHashMap详解

    Java中的HashMap弱引用之WeakHashMap详解

    这篇文章主要介绍了Java中的HashMap弱引用之WeakHashMap详解,当内存空间不足,Java虚拟机宁愿抛出OutOfMemoryError错误,使程序异常终止,也不会靠随意回收具有强引用的对象来解决内存不足的问题,需要的朋友可以参考下
    2023-09-09
  • SpringBoot后端接收参数优化代码示例(统一处理前端参数)

    SpringBoot后端接收参数优化代码示例(统一处理前端参数)

    使用Spring Boot开发API的时候,读取请求参数是服务端编码中最基本的一项操作,下面这篇文章主要给大家介绍了关于SpringBoot后端接收参数优化(统一处理前端参数)的相关资料,需要的朋友可以参考下
    2024-07-07
  • spring MVC实现简单登录功能

    spring MVC实现简单登录功能

    这篇文章主要为大家详细介绍了spring MVC实现简单登录功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-09-09
  • Java编程实现用hash方法切割文件

    Java编程实现用hash方法切割文件

    这篇文章主要介绍了Java编程实现用hash方法切割文件,简单介绍了hash的概念,然后分享了使用方法示例,具有一定借鉴价值,需要的朋友可以了解下。
    2017-12-12

最新评论