SpringBoot全局Controller返回值格式统一

更新时间：2021年07月29日 15:13:12 作者：TianXinCoord

本文主要介绍了SpringBoot全局Controller返回值格式统一，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

一、返回值格式统一

1.返回值介绍

在使用controller对外提供服务的时候，很多时候都需要统一返回值格式，例如

{
	"status": true,
	"message": null,
	"code": "200",
	"data": {
		"name": "json",
		"desc": "json返回值"
	}
}

如果不使用全局统一返回，就需要写一个工具类，然后controller返回对应的对象

@Data
public class ResponseData {
    private boolean status;
    private String message;
    private String code;
    private Object data;
}

@RequestMapping("/foo")
public ResponseData foo() {
    // 或者使用工具类返回，根据业务设置值
    return new ResponseData();
}

除了上述方法，可以对返回值进行统一处理，不需要对所有controller都使用一个返回值，controller只需要返回原始值，处理器会对返回值进行封装

同时也可以添加自定义注解，此注解用于忽略返回值封装，按照controller原始值返回

2.基础类功能

org.springframework.web.method.support.HandlerMethodReturnValueHandler

使用不同策略处理从调用处理程序方法的返回值
策略处理顶层接口，自定义返回值格式需要实现此接口
supportsReturnType：设置支持返回值类型
handleReturnValue：处理返回值基础参数

在这里插入图片描述

org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter

请求映射处理适配，包含了参数、返回值处理器等信息
HandlerMethodReturnValueHandlerComposite内部维护了HandlerMethodReturnValueHandler列表

在这里插入图片描述

可以自定义注解，用于类或者方法级别忽略返回值封装

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface IgnoreResponseWrapper {

}

org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor

属于HandlerMethodReturnValueHandler子类
主要功能是对请求和响应体的做处理的方法
所有属于RequestResponseBodyMethodProcessor的子类都需要替换为自定义返回值处理

实现原理就是，在bean初始化的时候，获取到所有处理器数组，然后将所有是RequestResponseBodyMethodProcessor处理器子类对返回值处理的过程替换为自定义处理器

处理这样当调用对应返回值处理器时，将会使用到自定义的返回值处理器，也就是所有返回值都会按照规定的进行处理

3.基础实现

创建普通springboot项目，项目创建在此不做说明

创建类实现HandlerMethodReturnValueHandler接口，主要用于实现自定义返回值内容，不需要注入容器

import com.codecoord.unifyreturn.annotation.IgnoreResponseWrapper;
import com.codecoord.unifyreturn.domain.ResponseBase;
import org.springframework.core.MethodParameter;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.method.support.ModelAndViewContainer;

public class ResponseBodyWrapHandler implements HandlerMethodReturnValueHandler {
    private final HandlerMethodReturnValueHandler delegate;

    public ResponseBodyWrapHandler(HandlerMethodReturnValueHandler delegate) {
        this.delegate = delegate;
    }

    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return delegate.supportsReturnType(returnType);
    }

    @Override
    public void handleReturnValue(Object returnValue,
                                  MethodParameter returnType,
                                  ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest) throws Exception {
        // 如果类或者方法含有不包装注解则忽略包装
        IgnoreResponseWrapper wrapper = returnType.getDeclaringClass().getAnnotation(IgnoreResponseWrapper.class);
        if (wrapper != null) {
            delegate.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
            return;
        }
        wrapper = returnType.getMethodAnnotation(IgnoreResponseWrapper.class);
        if (wrapper != null) {
            delegate.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
            return;
        }
        
        // 自定义返回格式
        ResponseBase responseBase = new ResponseBase();
        responseBase.setStatus(true);
        responseBase.setCode("200");
        responseBase.setData(returnValue);
        delegate.handleReturnValue(responseBase, returnType, mavContainer, webRequest);
    }
}

创建类实现InitializingBean，在初始化时调用，需要注入到容器中，否则Spring无法管理

import java.util.ArrayList;
import java.util.List;

@Component
public class ResponseBodyWrapFactoryBean implements InitializingBean {
    private final RequestMappingHandlerAdapter adapter;

    @Autowired
    public ResponseBodyWrapFactoryBean(RequestMappingHandlerAdapter adapter) {
        this.adapter = adapter;
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        List<HandlerMethodReturnValueHandler> returnValueHandlers = adapter.getReturnValueHandlers();
        if (returnValueHandlers.size() > 0) {
        	// 将内置的返回值处理器进行替换
            List<HandlerMethodReturnValueHandler> handlers = new ArrayList<>(returnValueHandlers);
            decorateHandlers(handlers);
            adapter.setReturnValueHandlers(handlers);
        }
    }

    /** 
     * 将所有RequestResponseBodyMethodProcessor返回值处理器替换为自定义的返回值处理器
     *
     * @author tianxincode@163.com
     * @since 2020/10/12
     */
    private void decorateHandlers(List<HandlerMethodReturnValueHandler> handlers) {
        for (HandlerMethodReturnValueHandler handler : handlers) {
            if (handler instanceof RequestResponseBodyMethodProcessor) {
            	// 替换为自定义返回值处理器
                ResponseBodyWrapHandler decorator = new ResponseBodyWrapHandler(handler);
                int index = handlers.indexOf(handler);
                handlers.set(index, decorator);
                break;
            }
        }
    }
}

创建controller信息，例如此处map不需要封装，按照原来格式响应

@RestController
@RequestMapping("/unify")
public class UnifyReturnValueController {

    @RequestMapping("string")
    public String stringHandler(){
        return "接收成功了";
    }

    @RequestMapping("/json")
    public JSONObject jsonHandler(){
        JSONObject object = new JSONObject();
        object.put("name", "json");
        object.put("desc", "json返回值");
        return object;
    }

    @RequestMapping("/map")
    @IgnoreResponseWrapper
    public Map<String, Object> mapHandler(){
        Map<String, Object> map = new HashMap<>(10);
        map.put("name", "map");
        map.put("desc", "map返回值");
        return map;
    }

    @RequestMapping("/list")
    public List<Object> listHandler(){
        List<Object> data = new ArrayList<>();
        data.add(100);
        data.add(95);
        data.add(99);
        return data;
    }
}

4.测试信息测试json(有封装)

{
	"status": true,
	"message": null,
	"code": "200",
	"data": {
		"name": "json",
		"desc": "json返回值"
	}
}

测试map(无封装)

{
	"name": "map",
	"desc": "map返回值"
}

别的方法测试一样

二、附录说明

项目结构参考红框部分，别的忽略

在这里插入图片描述

除了对返回值进行全局统一，也可以对异常进行全局处理和按照统一格式返回

到此这篇关于SpringBoot全局Controller返回值格式统一的文章就介绍到这了,更多相关SpringBoot返回值格式统一内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java实现的权重算法（按权重展现广告）
这篇文章主要介绍了Java实现的权重算法（按权重展现广告）,本文讲解了算法实现原理和实现代码,需要的朋友可以参考下
2015-04-04
Java并发编程信号量Semapher
这篇文章主要介绍了Java并发编程信号量Semapher，Semapher信号量也是Java中的一个同步器，下文关于信号量Semapher的更多内容介绍，需要的小伙伴可以参考下面文章
2022-04-04
Java 17新特性详细讲解与代码实例
这篇文章主要给大家介绍了关于Java 17新特性详细讲解与代码实例的相关资料,Java 17是2021年9月发布的最新版本,其中包含了很多新特性和改进,这些新特性和改进将进一步提高 Java 语言的性能和可用性,需要的朋友可以参考下
2023-09-09
Java struts2捕获404错误的方法汇总
这篇文章主要为大家详细汇总了Java struts2捕获404错误的常用方法，感兴趣的小伙伴们可以参考一下
2016-05-05
java报错之springboot3+vue2项目web服务层报错总结
java入门学习，随手记录一下开发过程中产生的报错，有些错误是网上搜索再加上自己尝试，随手引用了一些其他人的记录，也是留给自己看的，或是希望能对其他初学者有帮助
2023-06-06
Spring中的FactoryBean与BeanFactory详细解析
这篇文章主要介绍了Spring中的FactoryBean与BeanFactory详细解析,在Spring框架中,FactoryBean和BeanFactory是两个关键的接口,用于创建和管理对象实例,它们在Spring的IoC(Inversion of Control,控制反转)容器中发挥着重要的作用,需要的朋友可以参考下
2023-11-11
Java中的@Builder注解问题详解
这篇文章主要介绍了Java中的@Builder注解详解,@Builder 注解的其中一个大坑会导致默认值失效,这是使用此注解出现的一个问题,总的来说,不推荐再使用 @Builder 注解,接下来讲重点介绍其原因和替代方案,需要的朋友可以参考下
2023-10-10
java实现爬取知乎用户基本信息
这篇文章主要为大家介绍了一个基于JAVA的知乎爬虫，抓取知乎用户基本信息，感兴趣的小伙伴们可以参考一下
2016-05-05
使用Idea快速搭建SpringMVC项目的详细步骤记录
这篇文章主要给大家介绍了关于使用Idea快速搭建SpringMVC项目的详细步骤,Spring MVC是一种基于MVC模式的框架,它是Spring框架的一部分,它提供了一种更简单和更有效的方式来构建Web应用程序,需要的朋友可以参考下
2024-05-05
Java生成PDF文件的实例代码
Java生成PDF文件的实例代码，需要的朋友可以参考一下
2013-05-05