脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → springboot包装controller返回值

解析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在网页上面抓取邮件地址的方法,是比较典型的Java正则匹配应用实例,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-11-11
  • Component和Configuration注解区别实例详解

    Component和Configuration注解区别实例详解

    这篇文章主要为大家介绍了Component和Configuration注解区别实例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-11-11
  • Java中实现Unicode编码解码的方法

    Java中实现Unicode编码解码的方法

    在Java编程中,Unicode编码解码是一项基本的操作,Unicode是一种用于表示文字字符的标准编码,它包含了世界上几乎所有的字符,包括各种语言的字母、符号和表情符号等,在Java中通过Unicode编码,我们可以将任意字符转换为字节流进行传输和存储
    2024-02-02
  • java程序运行时内存分配详解

    java程序运行时内存分配详解

    这篇文章主要介绍了java程序运行时内存分配详解 ,需要的朋友可以参考下
    2016-07-07
  • 老生常谈JVM的内存溢出说明及参数调整

    老生常谈JVM的内存溢出说明及参数调整

    下面小编就为大家带来一篇老生常谈JVM的内存溢出说明及参数调整。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-03-03
  • Java泛型T,E,K,V,N,?与Object区别和含义

    Java泛型T,E,K,V,N,?与Object区别和含义

    Java 泛型（generics）是 JDK 5 中引入的一个新特性, 泛型提供了编译时类型安全检测机制，该机制允许程序员在编译时检测到非法的类型。本文将详细讲讲Java泛型T、E、K、V、N、?和Object区别和含义，需要发可以参考一下
    2022-03-03
  • Mac Maven环境搭建安装和配置超详细步骤

    Mac Maven环境搭建安装和配置超详细步骤

    这篇文章主要给大家介绍了关于Mac Maven环境搭建安装和配置的超详细步骤,Maven是一种常用的Java构建工具,它可以自动化构建、测试和打包Java项目,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-10-10
  • 一篇文章带你深入了解Java基础

    一篇文章带你深入了解Java基础

    这篇文章主要给大家介绍了关于Java中方法使用的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-08-08
  • springboot2.5.6集成RabbitMq实现Topic主题模式(推荐)

    springboot2.5.6集成RabbitMq实现Topic主题模式(推荐)

    这篇文章主要介绍了springboot2.5.6集成RabbitMq实现Topic主题模式(推荐)，pom.xml引入依赖和常量类创建，本文通过实例代码给大家介绍的非常详细，需要的朋友参考下吧
    2021-11-11
  • MyBatis之foreach标签的用法及多种循环问题

    MyBatis之foreach标签的用法及多种循环问题

    这篇文章主要介绍了MyBatis之foreach标签的用法及多种循环问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11

最新评论