SpringMVC MethodArgumentResolver的作用與實現(xiàn)

更新時間：2023年04月11日 10:42:17 作者：這堆干貨有點猛

這篇文章主要介紹了SpringMVC MethodArgumentResolver的作用與實現(xiàn)，MethodArgumentResolver采用一種策略模式，在Handler的方法被調(diào)用前，Spring MVC會自動將HTTP請求中的參數(shù)轉換成方法參數(shù)

昨天的文章我們學習 MethodArgumentResolver ，它是采用一種策略模式，在 Handler 的方法被調(diào)用前，將 HTTP 請求中的參數(shù)轉換成 Handler 方法的參數(shù)，今天我們將學習另外一種組件 MethodReturnValueHandler，用于將 Handler 返回的數(shù)據(jù)轉換為 HTTP 響應。

作用

在Spring MVC中，當一個控制器方法執(zhí)行完成后，它會返回一個數(shù)據(jù)對象，這個數(shù)據(jù)對象可以是任何類型，如對象、集合、數(shù)組、字符串等等。MethodReturnValueHandler 就是負責將這個數(shù)據(jù)對象轉換為HTTP響應的。

源碼實現(xiàn)

在Spring MVC中，MethodReturnValueHandler 是一個接口，它有多個實現(xiàn)類，每個實現(xiàn)類都可以處理不同類型的數(shù)據(jù)對象。下面是一個簡單的 MethodReturnValueHandler 的實現(xiàn)類示例：

public class MyReturnValueHandler implements MethodReturnValueHandler {
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return returnType.getParameterType().equals(MyData.class);
    }
    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        MyData myData = (MyData) returnValue;
        // do something with myData
        HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
        response.getWriter().write("hello world");
    }
}

這個實現(xiàn)類可以將 MyData 類型的數(shù)據(jù)對象轉換為 HTTP 響應。

supportsReturnType 方法用于判斷該實現(xiàn)類是否支持處理指定類型的返回值。

handleReturnValue 方法用于將數(shù)據(jù)對象轉換為 HTTP 響應。

在Spring MVC中，MethodReturnValueHandler 由 RequestMappingHandlerAdapter 類負責管理。

RequestMappingHandlerAdapter 會維護一個 MethodReturnValueHandler 列表，當控制器方法執(zhí)行完成后，它會遍歷這個列表，找到第一個支持處理當前返回值類型的 MethodReturnValueHandler，并調(diào)用它的 handleReturnValue 方法。

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter {
    private final List<MethodReturnValueHandler> returnValueHandlers = new ArrayList<>();
    @Override
    public void afterPropertiesSet() {
        super.afterPropertiesSet();
        this.returnValueHandlers.add(new MyReturnValueHandler());
    }
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        for (MethodReturnValueHandler handler : this.returnValueHandlers) {
            if (handler.supportsReturnType(returnType)) {
                return true;
            }
        }
        return false;
    }
    @Override
    protected ModelAndView handleInternal(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
        Object returnValue = handlerMethod.getMethod().invoke(handlerMethod.getBean(), handlerMethod.getMethodParameters());
        MethodParameter returnType = handlerMethod.getReturnType();
        for (MethodReturnValueHandler handler : this.returnValueHandlers) {
            if (handler.supportsReturnType(returnType)) {
                ModelAndViewContainer mavContainer = new ModelAndViewContainer();
                handler.handleReturnValue(returnValue, returnType, mavContainer, new ServletWebRequest(request, response));
                return mavContainer.getModelAndView();
            }
        }
        return null;
    }
}

在 RequestMappingHandlerAdapter 的 afterPropertiesSet 方法中，我們可以向returnValueHandlers 列表中添加自定義的 MethodReturnValueHandler 實現(xiàn)類。

supportsReturnType 方法用于判斷當前返回值類型是否有對應的 MethodReturnValueHandler實現(xiàn)類可以處理。

handleInternal 方法會在控制器方法執(zhí)行完成后調(diào)用，它會根據(jù)返回值類型查找對應的 MethodReturnValueHandler 實現(xiàn)類，并調(diào)用它的 handleReturnValue 方法將數(shù)據(jù)對象轉換為HTTP響應。

總結

MethodReturnValueHandler 是Spring MVC 中的一個攔截器，它的作用是根據(jù)方法的返回值，將數(shù)據(jù)轉換為HTTP響應。

在Spring MVC中，MethodReturnValueHandler 由 RequestMappingHandlerAdapter 類負責管理。它會維護一個 MethodReturnValueHandler 列表，在控制器方法執(zhí)行完成后，它會遍歷這個列表，找到第一個支持處理當前返回值類型的 MethodReturnValueHandler，并調(diào)用它的handleReturnValue 方法。

我們可以自定義 MethodReturnValueHandler 實現(xiàn)類來處理特定類型的返回值。

到此這篇關于SpringMVC MethodArgumentResolver的作用與實現(xiàn)的文章就介紹到這了,更多相關SpringMVC MethodArgumentResolver內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: