深入淺出Spring MVC

stoneFang發表於2020-05-31
SpringMVC

摘要

本文旨在詳細分析SpringMVC工作原理以及作為開發者如何基於SpringMVC做擴充套件。因為SpringMVC分析的文章比較多，所以本文重點講解如何利用SpringMVC的擴充套件點實現我們的需求。

什麼是Spring MVC

SpringMVC的作用是什麼呢？需要解決什麼問題呢？

下圖是一個客戶端與服務端的互動

在這裡插入圖片描述
在之前的詳解http報文（2）-web容器是如何解析http報文的一文中我也提到過。
這次再更細緻的分析一遍。一個請求如何中客戶端發到服務端，再從服務端返回內容。乾的這件事在web中叫請求動態內容，區別於靜態內容。在java語言中，為了解決這件事定義了一個規範就是servlet。具體的實現由各大廠商自己定義。

大體部分分為兩部分一塊是建立連線、一塊是傳輸內容。所以servlet規範包括兩大部分，，一部分是servlet介面，定義處理請求的規範。一部分是servlet容器的，去管理載入servlet例項。

輕量級的servlet容器有tomcat/jetty/undertow,servlet框架有SpringMVC/Struts/Webx這些，本篇重點講解SpringMVC

SpringMVC工作流程

在這裡插入圖片描述
Spring MVC 顧名思義就是處理Controll-Model-View的。

  1. DispatchServlet 是入口，doDispatch方法開始處理請求
  2. 首先經過controll，controll包含兩部分，一部分是url處理對映，將url與具體的處理bean對映起來。也就是HandleMapping,另一部分是具體的Handle，因為需要不同的handle，所以定義了HandleAdapter.
  3. Model比較簡單，主要就是ModelView物件，
  4. View 包含兩部分，一部分是ViewName的解析，另一部分是ViewName的對應的模板引擎，來渲染出最終的模板引擎。

常見擴充套件點

基於以上，Spring MVC 提供了不同層面的擴充套件,方便開發者實現定製化的功能，而不需要底層程式碼的修改

一. Filter

Filter其實不算是SpringMVC,是servlet的，這時候請求還沒有到DispatchServlet。Filter允許對請求和響應做一些統一的定製化處理，比如你限流、日誌、trace。

實現javax.servlet.Filter介面即可

二. Controll - HandleMapping，HandlerAdapter

HandleMapping屬於Controll層面,我們可以編寫任意的HandlerMapping實現類，然後定義策略來決定一個web請求到HandlerExecutionChain物件的生成。

繼承RequestMappingHandlerMapping 類即可。
這個具體案例可以看下fredal的部落格-使用基於 SpringMVC 的透明 RPC 開發微服務

簡要來說，他的rpc通訊協議是基於http的。所以rpc呼叫就是基於服務端還是原來的restful api。寫法給普通的前端去掉無異，然後包一層rpc client。方便客戶端呼叫。但是這樣太麻煩了，對於不需要暴露給前端的API，單純是服務間的rpc呼叫。再走一遍servlet-SpringMVC沒必要。

所以他基於RequestMappingHandlerMapping做了一個改造。不再基於SpringMVC，而是自己定義了一套rpc的正規化，然後轉換為springmvc。

三. Controll - Interceptor

Interceptor屬於Controll層面，我們可以自定義各種攔截器，在一個請求被真正處理之前、請求被處理但還沒輸出到響應中、請求已經被輸出到響應中之後這三個時間點去做任何我們想要做的事情。廣泛應用於Log,Session，鑑權等場景。

實現HandlerInterceptor介面即可

四. View - HandlerMethodArgumentResolver

解析方法引數的，可以很方便的擴充套件http請求引數。
實現HandlerMethodArgumentResolver介面即可

比如需要從http header中處理裝置資訊

@Component
public class DeviceResolver implements HandlerMethodArgumentResolver {
    @Override
    public boolean supportsParameter(final MethodParameter methodParameter) {
        return methodParameter.getParameterType().equals(DeviceInfo.class);
    }

    @Override
    public Object resolveArgument(final MethodParameter methodParameter,
            final ModelAndViewContainer modelAndViewContainer,
            final NativeWebRequest nativeWebRequest,
            final WebDataBinderFactory webDataBinderFactory) throws Exception {
        HttpServletRequest request =
                (HttpServletRequest)  nativeWebRequest.getNativeRequest(HttpServletRequest.class);

        // 從head頭中獲取裝置資訊
        String id = request.getHeader("x-device-id");
        if (id != null) {
            DeviceInfo deviceInfo = new DeviceInfo();
            deviceInfo.setId("id");
            return deviceInfo;
        }
        return null;
    }
}

五. View - Converter

型別轉換器,主要和序列化相關，引數繫結時springmvc會對將前端傳來的引數通過某種規則轉化成方法定義的引數的型別，預設實現的有StringHttpMessageConverter、ByteArrayHttpMessageConverter等等，預設的不能滿足需求時我們可自己定義此介面來實現自己的型別的轉換。

繼承AbstractHttpMessageConverter 即可。

六. View- HandlerExceptionResolver

異常處理,通常需要定義的全域性異常。

@ControllerAdvice 註解即可
在一次和前端的相互甩鍋的問題記錄中有總結過這種

七. 修改requestbody 內容

當我們需要對RequestBody的內容進行統一處理時，因為HandlerMethodArgumentResolver只能處理特定型別的，做不到這點要求。

實現RequestBodyAdvice 介面即可。比如我需要處理requestbody中的內容，將emoji輸入轉換掉

@RestControllerAdvice
public class EmojiReplaceAdvice implements RequestBodyAdvice {
    @Override
    public boolean supports(final MethodParameter methodParameter, final Type targetType,
            final Class<? extends HttpMessageConverter<?>> converterType) {
        return methodParameter.hasParameterAnnotation(EmojiReplace.class);
    }

    @Override
    public Object handleEmptyBody(final Object body, final HttpInputMessage inputMessage,
            final MethodParameter parameter, final Type targetType,
            final Class<? extends HttpMessageConverter<?>> converterType) {
        return body;
    }

    @Override
    public HttpInputMessage beforeBodyRead(final HttpInputMessage inputMessage,
            final MethodParameter parameter,
            final Type targetType, final Class<? extends HttpMessageConverter<?>> converterType)
            throws IOException {
        return new HttpInputMessage() {
            @Override
            public InputStream getBody() throws IOException {
                final String content = IOUtils.toString(inputMessage.getBody());
                final String emojiUnicodeToAlias = StringUtil.parseEmojiUnicodeToAlias(content);
                return new ByteArrayInputStream(
                        emojiUnicodeToAlias.getBytes(StandardCharsets.UTF_8));
            }

            @Override
            public HttpHeaders getHeaders() {
                return inputMessage.getHeaders();
            }
        };
    }

    @Override
    public Object afterBodyRead(final Object body, final HttpInputMessage inputMessage,
            final MethodParameter parameter, final Type targetType,
            final Class<? extends HttpMessageConverter<?>> converterType) {
        return body;
    }
}

總結

這篇文章主要是系統的概括了SpringMVC的工作原理和各種擴充套件機制，屬於高度概括，細節不足。具體的每個擴充套件點的實現、坑、應用場景需要在之後的文章繼續闡述。

參考

https://fredal.xin/develop-with-transparent-rpc

相關文章