解析springboot包装controller返回值问题

 更新时间:2021年12月22日 08:33:19   作者:hui008  
这篇文章主要介绍了springboot包装controller返回值问题,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

1、springboot项目统一包装返回值,通常返回结果包含code、message、data,结构如下

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class ResponseResult<T> {
    private int code;
    private String message;
    private T data;
 
    public ResponseResult(T data) {
        this.data = data;
        this.code = 0;
        this.message = "success";
    }
}

2、基于ControllerAdvice和HttpMessageConverter实现

定义类ResponseAdvisor实现ResponseBodyAdvice接口,重写supports跟beforeBodyWrite方法

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
 
@ControllerAdvice
public class ResponseAdvisor implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }
 
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType,
                                  Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest,
                                  ServerHttpResponse serverHttpResponse) {
        if(o instanceof ResponseResult){
            return o;
        }
        return new ResponseResult<>(o);
    }

3、接口测试

3.1 测试返回Object类型:

@RestController
@RequestMapping("/test")
public class TestController {
 
    @GetMapping("/test")
    public Test test(){
        return new Test("test", 10);
    }
}

执行结果如下:

3.2 测试返回String类型:

@RestController
@RequestMapping("/test")
public class TestController {
 
    @GetMapping("/test")
    public Test test(){
        return new Test("test", 10);
    }
 
    @GetMapping("/test1")
    public String test1(){
        return "test";
    }
}

执行结果如下:

3.3 如果Controller类的返回值没有String类型的,仅有上面这个类就够了。如果有String类型的返回值,就有可能遇到类型不匹配的问题。HttpMessageConverter是根据Controller的原始返回值类型进行处理的,而我们在ResponseAdvisor中改变了返回值的类型。如果HttpMessageConverter处理的目标类型是Object还好说,如果是其它类型就会出现问题,其中最容易出现问题的就是String类型,因为在所有的HttpMessageConverter实例集合中,StringHttpMessageConverter要比其它的Converter排得靠前一些。我们需要尝试将处理Object类型的HttpMessageConverter放得靠前一些,这可以在一个Configuration类中完成:

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration;
 
import java.util.List;
 
@Configuration
public class ResponseResultConfig extends DelegatingWebMvcConfiguration {
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(0, new MappingJackson2HttpMessageConverter());
        super.configureMessageConverters(converters);
    }
}

3.4 重启服务后再次测试返回String类型,返回结果如下:

 3.5 测试返回其他基本数据类型,也都没问题。

下篇写全局业务异常封装,加油!

到此这篇关于springboot包装controller返回值的文章就介绍到这了,更多相关springboot包装controller返回值内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java文件操作工具类

    java文件操作工具类

    这篇文章主要为大家介绍了一个非常详细的java文件操作工具类,具有很强的实用性,感兴趣的小伙伴们可以参考一下
    2016-05-05
  • Java的几个重要版本_动力节点Java学院整理

    Java的几个重要版本_动力节点Java学院整理

    jdk8 将在2014年3月份发布,迄今为止,可能是最大更新的java版本,也是令人期待的一个版本,在Java中引入闭包概念对Java程序开发方法的影响甚至会大于Java5中引入的泛型特征对编程方式带来的影响
    2017-06-06
  • 解决Error:(1, 1) java: 非法字符: '\ufeff'问题

    解决Error:(1, 1) java: 非法字符: '\ufeff'问题

    这篇文章主要介绍了解决Error:(1, 1) java: 非法字符: '\ufeff'问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • HttpUtils 发送http请求工具类(实例讲解)

    HttpUtils 发送http请求工具类(实例讲解)

    下面小编就为大家带来一篇HttpUtils 发送http请求工具类(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • JetBrains 发布下一代 IDE无比轻量几秒就能启动干活

    JetBrains 发布下一代 IDE无比轻量几秒就能启动干活

    虽然 JetBrains 公司说 Fleet 的定位和目标并不是代替其他 IDE,但个人觉得, 如果 Fleet 火起来了,其他 IDE 就会黯然失色,特别是多语言开发者,谁愿意装多个 IDE 呢?到时候,可能 JetBrains 以后的所有 IDE 要一统江湖了
    2021-12-12
  • Maven的安装和环境变量配置过程

    Maven的安装和环境变量配置过程

    文章介绍了如何下载、安装和配置Maven,包括环境变量配置和阿里云镜像的可选配置,此外,还展示了如何在IntelliJ IDEA中新建一个Maven项目
    2024-11-11
  • 详解Java 集合系列(三)—— LinkedList

    详解Java 集合系列(三)—— LinkedList

    这篇文章主要介绍了Java 集合系列(三)—— LinkedList,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • 详解Lombok安装及Spring Boot集成Lombok

    详解Lombok安装及Spring Boot集成Lombok

    这篇文章主要介绍了详解Lombok安装及Spring Boot集成Lombok,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Elasticsearch外部词库文件更新及使用

    Elasticsearch外部词库文件更新及使用

    这篇文章主要为大家介绍了Elasticsearch外部词库文件更新及使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Spring boot配置 swagger的示例代码

    Spring boot配置 swagger的示例代码

    Swagger是一组开源项目,Spring 基于swagger规范,可以将基于SpringMVC和Spring Boot项目的项目代码,自动生成JSON格式的描述文件,接下来通过本文给大家介绍Spring boot配置 swagger的示例代码,一起看看吧
    2021-09-09

最新评论