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 "返回数据";
    }
}

浏览器访问如下图

 

测试成功~

总结

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

相关文章

  • 手把手教你如何在Idea中下载jar包

    手把手教你如何在Idea中下载jar包

    maven依赖的jar包,很多时候同一个jar包会存在多个版本,删除其中一个后,重新编译,会把旧jar由加载回来了,下面这篇文章主要给大家介绍了关于如何在Idea中下载jar包的相关资料,需要的朋友可以参考下
    2023-06-06
  • Java lambda 循环累加求和代码

    Java lambda 循环累加求和代码

    这篇文章主要介绍了Java lambda 循环累加求和代码,具有很的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Java搜索与图论之DFS和BFS算法详解

    Java搜索与图论之DFS和BFS算法详解

    DFS指在进行算法运算时,优先将该路径的当前路径执行完毕,执行完毕或失败后向上回溯尝试其他途径。BFS指在进行算法运算时,优先将当前路径点的所有情况罗列出来,然后根据罗列出来的情况罗列下一层。本文介绍了二者的实现与应用,需要的可以参考一下
    2022-11-11
  • Java超详细讲解抽象类的原理与用法

    Java超详细讲解抽象类的原理与用法

    对于面向对象编程来说,抽象是它的一大特征之一,在Java中可以通过两种形式来体现OOP的抽象:接口和抽象类,下面这篇文章主要给大家介绍了关于Java抽象类相关资料,需要的朋友可以参考下
    2022-05-05
  • 关于JSONObject.toJSONString出现地址引用问题

    关于JSONObject.toJSONString出现地址引用问题

    这篇文章主要介绍了关于JSONObject.toJSONString出现地址引用问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • mybatis 自定义实现拦截器插件Interceptor示例

    mybatis 自定义实现拦截器插件Interceptor示例

    这篇文章主要介绍了mybatis 自定义实现拦截器插件Interceptor,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • Java多线程下的其他组件之CyclicBarrier、Callable、Future和FutureTask详解

    Java多线程下的其他组件之CyclicBarrier、Callable、Future和FutureTask详解

    这篇文章主要介绍了Java多线程下的其他组件之CyclicBarrier、Callable、Future和FutureTask详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 一文带你掌握Java SPI的原理和实践

    一文带你掌握Java SPI的原理和实践

    在Java中,我们经常会提到面向接口编程,这样减少了模块之间的耦合,更加灵活,Java SPI (Service Provider Interface)就提供了这样的机制,本文就来讲讲它的原理与具体使用吧
    2023-05-05
  • Java多线程 ReentrantReadWriteLock原理及实例详解

    Java多线程 ReentrantReadWriteLock原理及实例详解

    这篇文章主要介绍了Java多线程 ReentrantReadWriteLock原理及实例详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-09-09
  • MyBatis官方代码生成工具给力(解放双手)

    MyBatis官方代码生成工具给力(解放双手)

    这篇文章主要介绍了MyBatis官方代码生成工具给力(解放双手),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12

最新评论