SpringBoot全局Controller返回值格式統(tǒng)一

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

本文主要介紹了SpringBoot全局Controller返回值格式統(tǒng)一，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

一、返回值格式統(tǒng)一

1.返回值介紹

在使用controller對外提供服務的時候，很多時候都需要統(tǒng)一返回值格式，例如

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

如果不使用全局統(tǒng)一返回，就需要寫一個工具類，然后controller返回對應的對象

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

@RequestMapping("/foo")
public ResponseData foo() {
    // 或者使用工具類返回，根據(jù)業(yè)務設置值
    return new ResponseData();
}

除了上述方法，可以對返回值進行統(tǒng)一處理，不需要對所有controller都使用一個返回值，controller只需要返回原始值，處理器會對返回值進行封裝

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

2.基礎類功能

org.springframework.web.method.support.HandlerMethodReturnValueHandler

使用不同策略處理從調用處理程序方法的返回值
策略處理頂層接口，自定義返回值格式需要實現(xiàn)此接口
supportsReturnType：設置支持返回值類型
handleReturnValue：處理返回值基礎參數(shù)

在這里插入圖片描述

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

請求映射處理適配，包含了參數(shù)、返回值處理器等信息
HandlerMethodReturnValueHandlerComposite內部維護了HandlerMethodReturnValueHandler列表

在這里插入圖片描述

可以自定義注解，用于類或者方法級別忽略返回值封裝

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

}

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

屬于HandlerMethodReturnValueHandler子類
主要功能是對請求和響應體的做處理的方法
所有屬于RequestResponseBodyMethodProcessor的子類都需要替換為自定義返回值處理

實現(xiàn)原理就是，在bean初始化的時候，獲取到所有處理器數(shù)組，然后將所有是RequestResponseBodyMethodProcessor處理器子類對返回值處理的過程替換為自定義處理器

處理這樣當調用對應返回值處理器時，將會使用到自定義的返回值處理器，也就是所有返回值都會按照規(guī)定的進行處理

3.基礎實現(xiàn)

創(chuàng)建普通springboot項目，項目創(chuàng)建在此不做說明

創(chuàng)建類實現(xiàn)HandlerMethodReturnValueHandler接口，主要用于實現(xiàn)自定義返回值內容，不需要注入容器

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);
    }
}

創(chuàng)建類實現(xiàn)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;
            }
        }
    }
}

創(chuàng)建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返回值"
}

別的方法測試一樣

二、附錄說明

項目結構參考紅框部分，別的忽略

在這里插入圖片描述

除了對返回值進行全局統(tǒng)一，也可以對異常進行全局處理和按照統(tǒng)一格式返回

到此這篇關于SpringBoot全局Controller返回值格式統(tǒng)一的文章就介紹到這了,更多相關SpringBoot返回值格式統(tǒng)一內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

Java實現(xiàn)的權重算法（按權重展現(xiàn)廣告）
這篇文章主要介紹了Java實現(xiàn)的權重算法（按權重展現(xiàn)廣告）,本文講解了算法實現(xiàn)原理和實現(xiàn)代碼,需要的朋友可以參考下
2015-04-04
Java并發(fā)編程信號量Semapher
這篇文章主要介紹了Java并發(fā)編程信號量Semapher，Semapher信號量也是Java中的一個同步器，下文關于信號量Semapher的更多內容介紹，需要的小伙伴可以參考下面文章
2022-04-04
Java?17新特性詳細講解與代碼實例
這篇文章主要給大家介紹了關于Java?17新特性詳細講解與代碼實例的相關資料,Java 17是2021年9月發(fā)布的最新版本,其中包含了很多新特性和改進,這些新特性和改進將進一步提高 Java 語言的性能和可用性,需要的朋友可以參考下
2023-09-09
Java struts2捕獲404錯誤的方法匯總
這篇文章主要為大家詳細匯總了Java struts2捕獲404錯誤的常用方法，感興趣的小伙伴們可以參考一下
2016-05-05
java報錯之springboot3+vue2項目web服務層報錯總結
java入門學習，隨手記錄一下開發(fā)過程中產生的報錯，有些錯誤是網(wǎng)上搜索再加上自己嘗試，隨手引用了一些其他人的記錄，也是留給自己看的，或是希望能對其他初學者有幫助
2023-06-06
Spring中的FactoryBean與BeanFactory詳細解析
這篇文章主要介紹了Spring中的FactoryBean與BeanFactory詳細解析,在Spring框架中,FactoryBean和BeanFactory是兩個關鍵的接口,用于創(chuàng)建和管理對象實例,它們在Spring的IoC(Inversion of Control,控制反轉)容器中發(fā)揮著重要的作用,需要的朋友可以參考下
2023-11-11
Java中的@Builder注解問題詳解
這篇文章主要介紹了Java中的@Builder注解詳解,@Builder 注解的其中一個大坑會導致默認值失效,這是使用此注解出現(xiàn)的一個問題,總的來說,不推薦再使用 @Builder 注解,接下來講重點介紹其原因和替代方案,需要的朋友可以參考下
2023-10-10
java實現(xiàn)爬取知乎用戶基本信息
這篇文章主要為大家介紹了一個基于JAVA的知乎爬蟲，抓取知乎用戶基本信息，感興趣的小伙伴們可以參考一下
2016-05-05
使用Idea快速搭建SpringMVC項目的詳細步驟記錄
這篇文章主要給大家介紹了關于使用Idea快速搭建SpringMVC項目的詳細步驟,Spring?MVC是一種基于MVC模式的框架,它是Spring框架的一部分,它提供了一種更簡單和更有效的方式來構建Web應用程序,需要的朋友可以參考下
2024-05-05
Java生成PDF文件的實例代碼
Java生成PDF文件的實例代碼，需要的朋友可以參考一下
2013-05-05