【Spring】@RequestBody的實現原理

来源:https://www.cnblogs.com/shanml/archive/2023/07/21/17572571.html
-Advertisement-
Play Games

@RequestBody註解可以用於POST請求接收請求體中的參數，使用方式如下： ``` java @Controller public class IndexController { @PostMapping(value = "/submit", produces = MediaType.APP ...


@RequestBody註解可以用於POST請求接收請求體中的參數，使用方式如下：

@Controller
public class IndexController {
    
    @PostMapping(value = "/submit", produces = MediaType.APPLICATION_JSON_VALUE)
    public void submit(@RequestBody UserInfo userInfo) {
        System.out.println(userInfo.toString());
    }
}

那麼是如何從請求中解析數據設置到對應的參數中呢，接下來就從源碼的角度一探究竟。

DispatcherServlet是Spring MVC的核心，它對請求進行調度，收到請求後會進入DispatcherServlet的doDispatch方法中：

  1. 調用getHandler方法獲取請求對應的Handler處理器；
  2. 根據handler獲取對應的適配器，這裡用到了適配器模式；
  3. 調用適配器的handle方法處理請求，它會返回一個ModelAndView對象；
public class DispatcherServlet extends FrameworkServlet {
    protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
		HttpServletRequest processedRequest = request;
		HandlerExecutionChain mappedHandler = null;
		boolean multipartRequestParsed = false;

		WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

		try {
			ModelAndView mv = null;
			Exception dispatchException = null;

			try {
				// 檢查是否有Multipart
				processedRequest = checkMultipart(request);
				multipartRequestParsed = (processedRequest != request);

				// 根據請求獲取對應的處理器
				mappedHandler = getHandler(processedRequest);
				if (mappedHandler == null) {
					noHandlerFound(processedRequest, response);
					return;
				}

				// 根據handler獲取對應的適配器
				HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

				// ...

				// 處理請求
				mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

				// ...
			}
			catch (Exception ex) {
				dispatchException = ex;
			}
			catch (Throwable err) {
				dispatchException = new NestedServletException("Handler dispatch failed", err);
			}
			processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
		}
		// ...
	}
}

通過POSTMAN模擬請求，在代碼中打斷點可以看到HandlerAdapter的類型為對RequestMappingHandlerAdapter:

handle方法在其父類AbstractHandlerMethodAdapter中實現，在它的handle方法中，又調用了handleInternal方法處理請求，handleInternal是一個抽象方法，由具體的子類實現：

public abstract class AbstractHandlerMethodAdapter extends WebContentGenerator implements HandlerAdapter, Ordered {
	@Override
	@Nullable
	public final ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
	    // 處理請求
		return handleInternal(request, response, (HandlerMethod) handler);
	}

	@Nullable
	protected abstract ModelAndView handleInternal(HttpServletRequest request,
			HttpServletResponse response, HandlerMethod handlerMethod) throws Exception;
}

所以回到RequestMappingHandlerAdapter的handleInternal方法，裡面調用了invokeHandlerMethod方法進行處理：

  1. 創建ServletInvocableHandlerMethod；
  2. 調用invokeAndHandle方法繼續請求處理；
  3. 調用getModelAndView方法返回ModelAndView;
public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
		implements BeanFactoryAware, InitializingBean {
    @Override
	protected ModelAndView handleInternal(HttpServletRequest request,
			HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {

		ModelAndView mav;
		checkRequest(request);
		if (this.synchronizeOnSession) {
			HttpSession session = request.getSession(false);
			if (session != null) {
				Object mutex = WebUtils.getSessionMutex(session);
				synchronized (mutex) {
					// 執行請求
					mav = invokeHandlerMethod(request, response, handlerMethod);
				}
			}
			else {
				// 執行請求
				mav = invokeHandlerMethod(request, response, handlerMethod);
			}
		}
		else {
			// 執行請求
			mav = invokeHandlerMethod(request, response, handlerMethod);
		}
		// ...
		return mav;
	}

	@Nullable
	protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
			HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {

		ServletWebRequest webRequest = new ServletWebRequest(request, response);
		try {
			// ...
            // 創建ServletInvocableHandlerMethod
            ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
			// 調用invokeAndHandle方法處理請求
			invocableMethod.invokeAndHandle(webRequest, mavContainer);
			if (asyncManager.isConcurrentHandlingStarted()) {
				return null;
			}
			// 返回ModelAndView
			return getModelAndView(mavContainer, modelFactory, webRequest);
		}
		finally {
			webRequest.requestCompleted();
		}
	}
}

ServletInvocableHandlerMethod的invokeAndHandle中調用了invokeForRequest方法執行請求，它的實現在其父類InvocableHandlerMethod中：

public class ServletInvocableHandlerMethod extends InvocableHandlerMethod {
    public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer,
			Object... providedArgs) throws Exception {
    	// 執行請求
		Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);
		setResponseStatus(webRequest);

		// ...
	}
}

invokeForRequest中又調用了getMethodArgumentValues方法獲取請求中的參數，處理邏輯如下：

  1. 調用getMethodParameters獲取方法中的參數，也就是我們的請求處理器方法中的所有參數，上面看到submit只接收了一個UserInfo類型的參數，這裡可以從斷點中看到parameters中只有一個元素，類型為UserInfo:

  2. 對獲取到方法中的所有參數進行遍歷，通過處理器調用resolveArgument方法解析請求中的數據，解析每一個參數對應的值；

public class InvocableHandlerMethod extends HandlerMethod {
	@Nullable
	public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
			Object... providedArgs) throws Exception {
		// 獲取請求中的參數
		Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
		if (logger.isTraceEnabled()) {
			logger.trace("Arguments: " + Arrays.toString(args));
		}
		return doInvoke(args);
	}
    
    protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer,
			Object... providedArgs) throws Exception {
		// 獲取方法的所有參數
		MethodParameter[] parameters = getMethodParameters();
		if (ObjectUtils.isEmpty(parameters)) {
			return EMPTY_ARGS;
		}
		Object[] args = new Object[parameters.length];
		// 對方法中的所有參數進行遍歷
		for (int i = 0; i < parameters.length; i++) {
			MethodParameter parameter = parameters[i];
			parameter.initParameterNameDiscovery(this.parameterNameDiscoverer);
			// ...
			try {
				// 調用resolveArgument從請求中解析對應的數據
				args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
			}
			// ...
		}
		return args;
	}
}

resolveArgument方法在HandlerMethodArgumentResolverComposite中實現：

  1. 調用getArgumentResolver方法獲取對應的參數處理器resolver；

  2. 調用resolver的resolveArgument方法進行參數解析；

public class HandlerMethodArgumentResolverComposite implements HandlerMethodArgumentResolver {
	@Override
	@Nullable
	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
        // 獲取對應的參數處理器
		HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
		if (resolver == null) {
			throw new IllegalArgumentException("Unsupported parameter type [" +
					parameter.getParameterType().getName() + "]. supportsParameter should be called first.");
		}
		// 解析參數
		return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
	}
}

從斷點中可以看到此時的resolver是RequestResponseBodyMethodProcessor類型的:

進入到RequestResponseBodyMethodProcessor的resolveArgument方法中，它又調用了readWithMessageConverters方法解析參數，最終會進入到
AbstractMessageConverterMethodArgumentResolve中的readWithMessageConverters方法:

public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
    @Override
	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

		parameter = parameter.nestedIfOptional();
		// 通過轉換器進行參數解析
		Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
		String name = Conventions.getVariableNameForParameter(parameter);
		// ...
		return adaptArgumentIfNecessary(arg, parameter);
	}

	@Override
	protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
			Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {

		HttpServletRequest servletRequest = webRequest.getNativeRequest(HttpServletRequest.class);
		Assert.state(servletRequest != null, "No HttpServletRequest");
		ServletServerHttpRequest inputMessage = new ServletServerHttpRequest(servletRequest);
		// 調用AbstractMessageConverterMethodArgumentResolver中readWithMessageConverters方法讀取參數
		Object arg = readWithMessageConverters(inputMessage, parameter, paramType);
		if (arg == null && checkRequired(parameter)) {
			throw new HttpMessageNotReadableException("Required request body is missing: " +
					parameter.getExecutable().toGenericString(), inputMessage);
		}
		return arg;
	}
}

readWithMessageConverters方法處理邏輯如下：

  1. 遍歷所有HTTP消息轉換器，判斷是否支持解析當前的請求參數類型；

  2. 如果轉換器支持解析當前的參數類型並且有消息體內容，調用轉換器的read方法進行解析；

public abstract class AbstractMessageConverterMethodArgumentResolver implements HandlerMethodArgumentResolver {
    @Nullable
	protected <T> Object readWithMessageConverters(HttpInputMessage inputMessage, MethodParameter parameter,
			Type targetType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {

		// ...
		try {
			message = new EmptyBodyCheckingHttpInputMessage(inputMessage);
			// 遍歷所有的消息轉換器
			for (HttpMessageConverter<?> converter : this.messageConverters) {
				Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
				GenericHttpMessageConverter<?> genericConverter =
						(converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
				// 判斷是否支持當前參數類型的讀取
				if (genericConverter != null ? genericConverter.canRead(targetType, contextClass, contentType) :
						(targetClass != null && converter.canRead(targetClass, contentType))) {
					// 如果有消息體
					if (message.hasBody()) {
						HttpInputMessage msgToUse =
								getAdvice().beforeBodyRead(message, parameter, targetType, converterType);
						// 調用read方法進行讀取
						body = (genericConverter != null ? genericConverter.read(targetType, contextClass, msgToUse) :
								((HttpMessageConverter<T>) converter).read(targetClass, msgToUse));
						body = getAdvice().afterBodyRead(body, msgToUse, parameter, targetType, converterType);
					}
					else {
						body = getAdvice().handleEmptyBody(null, message, parameter, targetType, converterType);
					}
					break;
				}
			}
		}
		catch (IOException ex) {
			throw new HttpMessageNotReadableException("I/O error while reading input message", ex, inputMessage);
		}

		// ...
		return body;
	}
}

這裡列舉一些消息轉換器的類型：

對於application/json;charset=UTF-8類型會進入到MappingJackson2HttpMessageConverter，read方法在其父類AbstractJackson2HttpMessageConverter，處理邏輯如下：

  1. 獲取參數的Class類型，從斷點中可以看出是[class com.example.demo.model.UserInfo];

  2. 調用readJavaType方法解析參數
    （1）獲取ContentType，前面可以看到請求接收的類型為application/json;
    （2）獲取字元集，這裡的字元集為UTF-8；
    （3）創建ObjectMapper對象，並從請求體中讀取JSON數據，轉為JAVA對象；

public abstract class AbstractJackson2HttpMessageConverter extends AbstractGenericHttpMessageConverter<Object> {

    @Override
	public Object read(Type type, @Nullable Class<?> contextClass, HttpInputMessage inputMessage)
			throws IOException, HttpMessageNotReadableException {
		// 獲取參數的Class類型
		JavaType javaType = getJavaType(type, contextClass);
		// 解析參數
		return readJavaType(javaType, inputMessage);
	}

	private Object readJavaType(JavaType javaType, HttpInputMessage inputMessage) throws IOException {
		// 獲取ContentType
		MediaType contentType = inputMessage.getHeaders().getContentType();
		// 獲取字元集
		Charset charset = getCharset(contentType);
		ObjectMapper objectMapper = selectObjectMapper(javaType.getRawClass(), contentType);
		Assert.state(objectMapper != null, "No ObjectMapper for " + javaType);
		boolean isUnicode = ENCODINGS.containsKey(charset.name());
		try {
		    // ...
			if (isUnicode) {
				// 獲取HTTP請求體中的JSON數據，轉為JAVA對象
				return objectMapper.readValue(inputMessage.getBody(), javaType);
			}
			else {
				Reader reader = new InputStreamReader(inputMessage.getBody(), charset);
				return objectMapper.readValue(reader, javaType);
			}
		}
		// ....
	}
}

到這裡已經成功從HTTP請求體中的JSON數據，並轉為JAVA對象，完成了參數的設置。

Spring版本:5.3.4


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 記錄--百分百空手接大鍋
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 背景 愉快的雙休周末剛過完，早上來忽然被運營通知線上業務掛了，用戶無法下單。卧槽，趕緊進入debug模式，一查原來是服務端返回的數據有問題，趕緊問了服務端，大佬回覆說是業務部門配置套餐錯誤。好在主責不在我們，不過趕緊寫了復盤文檔，主動找自 ...
  • 【技術積累】Vue.js中的組件庫【一】
    博客推行版本更新，成果積累制度，已經寫過的博客還會再次更新，不斷地琢磨，高質量高數量都是要追求的，工匠精神是學習必不可少的精神。因此，大家有何建議歡迎在評論區踴躍發言，你們的支持是我最大的動力，你們敢投，我就敢肝 ...
  • 圖片預載入需要token認證的地址處理
    1.添加函數修改img的屬性； /** * * @param {*} idName 傳入的id，獲取改img的dom，添加相應的數學 */ export const proxyImg = (idName) => { const img = document.getElementById(idName ...
  • chrome事件迴圈的自問自答
    打開前端項目中的 package.json，會發現眾多工具已經占據了我們開發日常的各個角落，它們的存在於我們的開發而言是不可或缺的。有沒有想過這些工具的功能是如何實現的呢？沒錯，抽象語法樹 (Abstract Syntax Tree) 就是上述工具的基石。 ...
  • TCP/IP協議模型的五層處理流程簡介
    TCP/IP是一種分層模型，它將通信協議分解為五個層次，每個層次都有特定的功能和任務。以下是TCP/IP五層的處理流程： ...
  • DDD架構為什麼應該首選六邊形架構？
    採用依賴倒置原則後的分層架構和六邊形架構，實際上都符合整潔架構設計理念。但是六邊形架構中使用埠與適配器，讓應用程式能夠以一致的方式被用戶、程式、自動化測試、批處理腳本所驅動，同時能夠讓應用程式邊界更加清晰，從而能更好地防止領域層和應用層邏輯泄露到外層。 ...
  • 一文瞭解電商大促系統的高可用保障思路
    本文面向受眾可以是運營、可以是產品、也可以是研發、測試人員，作者希望通過如下思路（知歷史->清家底->明目標->定戰略->做戰術->促成長）幫助大家能夠瞭解電商大促系統的高可用保障，減少哪些高深莫測的黑話和高大尚的論調，而是希望有個體系化的知識讓讀者有所得。 ...
  • 前、後端通用的可視化邏輯編排
    可視化邏輯編排引擎，包括數據流驅動的邏輯編排原理，業務編排編輯器的實現，頁面控制項聯動，前端業務邏輯與UI層的分離，子編排的復用、自定義迴圈等嵌入式子編排的處理、事務處理等 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類