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

浏览器访问如下图

 

测试成功~

总结

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

相关文章

  • Java微信公众平台之素材管理

    Java微信公众平台之素材管理

    这篇文章主要为大家详细介绍了Java微信公众平台之素材管理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-05-05
  • java微信红包实现算法

    java微信红包实现算法

    这篇文章主要为大家详细介绍了java微信红包实现算法,列出红包的核心算法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-02-02
  • Maven根据不同环境打包不同配置文件的方法

    Maven根据不同环境打包不同配置文件的方法

    这篇文章主要介绍了Maven根据不同环境打包不同配置文件的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • SpringCloud zookeeper作为注册中心使用介绍

    SpringCloud zookeeper作为注册中心使用介绍

    ZooKeeper由雅虎研究院开发,是Google Chubby的开源实现,后来托管到Apache,于2010年11月正式成为Apache的顶级项目。ZooKeeper是一个经典的分布式数据一致性解决方案,致力于为分布式应用提供一个高性能、高可用,且具有严格顺序访问控制能力的分布式协调服务
    2022-11-11
  • Java hashCode() 方法详细解读

    Java hashCode() 方法详细解读

    Java.lang.Object 有一个hashCode()和一个equals()方法,这两个方法在软件设计中扮演着举足轻重的角色,本文对hashCode()方法深入理解,希望能帮助大家
    2016-07-07
  • java简单实现斗地主发牌功能

    java简单实现斗地主发牌功能

    这篇文章主要为大家详细介绍了java简单实现斗地主发牌功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-06-06
  • Mybatis在insert插入操作后如何返回主键id问题

    Mybatis在insert插入操作后如何返回主键id问题

    这篇文章主要介绍了Mybatis在insert插入操作后如何返回主键id问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • SpringBoot2新特性 自定义端点详解

    SpringBoot2新特性 自定义端点详解

    这篇文章主要介绍了SpringBoot2新特性 自定义端点详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • MyBatis的mapper.xml文件中入参和返回值的实现

    MyBatis的mapper.xml文件中入参和返回值的实现

    这篇文章主要介绍了MyBatis的mapper.xml文件中入参和返回值的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-01-01
  • 在Java 8中将List转换为Map对象方法

    在Java 8中将List转换为Map对象方法

    这篇文章主要介绍了在Java 8中将List转换为Map对象方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-11-11

最新评论