碼上快樂

相關內容    簡體    繁體

每天用SpringBoot，還不懂RESTful API返回統一數據格式是怎么實現的？

本文轉載自   查看原文   2019-08-13 09:10   4250    Spring

關於 Spring 的全局處理，我有兩方面要說:

  1. 統一數據返回格式
  2. 統一異常處理
    為了將兩個問題說明清楚，將分兩個章節分別說明，本章主要說第一點

有童鞋說，我們項目都做了這種處理，就是在每個 API 都單獨工具類將返回值進行封裝，但這種不夠優雅；我想寫最少的代碼完成這件事，也許有童鞋說，加幾個注解就解決問題了，說的沒錯，但這篇文章主要是為了說明為什么加了幾個注解就解決問題了，目的是希望大家知其所以然。

為了更好的說明問題，本文先說明如何實現，然后再詳細剖析實現原理(這很關鍵)

為什么要做統一數據返回格式

前后端分離是當今服務形式的主流，如何設計一個好的 RESTful API ，以及如何讓前端小伙伴可以處理標准的 response JSON 數據結構都至關重要，為了讓前端有更好的邏輯展示與頁面交互處理，每一次 RESTful 請求都應該包含以下幾個信息:

名稱 描述
status 狀態碼，標識請求成功與否，如 [1:成功；-1:失敗]
errorCode 錯誤碼，給出明確錯誤碼，更好的應對業務異常；請求成功該值可為空
errorMsg 錯誤消息，與錯誤碼相對應，更具體的描述異常信息
resultBody 返回結果，通常是 Bean 對象對應的 JSON 數據, 通常為了應對不同返回值類型，將其聲明為泛型類型

實現

通用返回值類定義

根據上面的描述，用 Java Bean 來體現這個結構就是這樣:

@Data
public final class CommonResult<T> {

	private int status = 1;

	private String errorCode = "";

	private String errorMsg = "";

	private T resultBody;

	public CommonResult() {
	}

	public CommonResult(T resultBody) {
		this.resultBody = resultBody;
	}
}

配置

沒錯，我們需要借助幾個關鍵注解來完成一下相關配置:

@EnableWebMvc
@Configuration
public class UnifiedReturnConfig {

	@RestControllerAdvice("com.example.unifiedreturn.api")
	static class CommonResultResponseAdvice implements ResponseBodyAdvice<Object>{
		@Override
		public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
			return true;
		}

		@Override
		public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
			if (body instanceof CommonResult){
				return body;
			}

			return new CommonResult<Object>(body);
		}
	}
}

到這里就結束了，我們就可以縱情的寫任何 RESTful API 了，所有的返回值都會有統一的 JSON 結構

測試

新建 UserController，添加相應的 RESTful API，測試用例寫的比較簡單，只為了說明返回值的處理

@RestController
@RequestMapping("/users")
public class UserController {


	@GetMapping("")
	public List<UserVo> getUserList(){
		List<UserVo> userVoList = Lists.newArrayListWithCapacity(2);
		userVoList.add(UserVo.builder().id(1L).name("日拱一兵").age(18).build());
		userVoList.add(UserVo.builder().id(2L).name("tan").age(19).build());
		return userVoList;
	}
}

打開瀏覽器輸入地址測試: http://localhost:8080/users/ ，我們可以看到返回了 List JSON 數據

繼續添加 RESTful API，根據用戶 ID 查詢用戶信息

@GetMapping("/{id}")
public UserVo getUserByName(@PathVariable Long id){
    return UserVo.builder().id(1L).name("日拱一兵").age(18).build();
}

打開瀏覽器輸入地址測試: http://localhost:8080/users/1 ，我們可以看到返回了單個 User JSON 數據

添加一個返回值類型為 ResponseEntity 的 API

@GetMapping("/testResponseEntity")
public ResponseEntity getUserByAge(){
    return new ResponseEntity(UserVo.builder().id(1L).name("日拱一兵").age(18).build(), HttpStatus.OK);
}

打開瀏覽器輸入地址測試: http://localhost:8080/users/testResponseEntity ，我們可以看到同樣返回了單個 User JSON 數據

解剖實現過程

我會將關鍵部分一一說明清楚，斷案還需小伙伴自己去案發現場(打開自己的 IDE 查看)

故事要從 @EnableWebMvc 這個注解說起，打開該注解看:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}

通過 @Import 注解引入了 DelegatingWebMvcConfiguration.class，那來看這個類吧:

@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    ...
}

有 @Configuration 注解，你應該很熟悉了，該類的父類 WebMvcConfigurationSupport 中卻隱藏着一段關鍵代碼:

@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
    RequestMappingHandlerAdapter adapter = createRequestMappingHandlerAdapter();
    ...
    return adapter;
}

RequestMappingHandlerAdapter 是每一次請求處理的關鍵，來看該類的定義:

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
		implements BeanFactoryAware, InitializingBean {
    ...
}

該類實現了 InitializingBean 接口，我在 Spring Bean 生命周期之“我從哪里來”？ 這篇文章中明確說明了 Spring Bean 初始化的幾個關鍵，其中 InitializingBean 接口的
afterPropertiesSet 方法就是關鍵之一，在 RequestMappingHandlerAdapter 類中同樣重寫了該方法:

@Override
public void afterPropertiesSet() {
    // Do this first, it may add ResponseBody advice beans
    initControllerAdviceCache();

    if (this.argumentResolvers == null) {
        List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
        this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
    }
    if (this.initBinderArgumentResolvers == null) {
        List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();
        this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
    }
    if (this.returnValueHandlers == null) {
        List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
        this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
    }
}

該方法內容都非常關鍵，但我們先來看 initControllerAdviceCache 方法，其他內容后續再單獨說明:

private void initControllerAdviceCache() {
        ...
    if (logger.isInfoEnabled()) {
        logger.info("Looking for @ControllerAdvice: " + getApplicationContext());
    }

    List<ControllerAdviceBean> beans = ControllerAdviceBean.findAnnotatedBeans(getApplicationContext());
    AnnotationAwareOrderComparator.sort(beans);

    List<Object> requestResponseBodyAdviceBeans = new ArrayList<Object>();

    for (ControllerAdviceBean bean : beans) {
        ...
        if (ResponseBodyAdvice.class.isAssignableFrom(bean.getBeanType())) {
            requestResponseBodyAdviceBeans.add(bean);
        }
    }
}

通過 ControllerAdviceBean 靜態方法掃描 ControllerAdvice 注解，可是我們在實現上使用的是 @RestControllerAdvice 注解，打開看該注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ControllerAdvice
@ResponseBody
public @interface RestControllerAdvice {

該注解由 @ControllerAdvice 和 @ResponseBody 標記，就好比你熟悉的 @RestController 注解由 @Controller 和 @ResponseBody 標記是一樣的

到這里你已經知道我們用 @RestControllerAdvice 標記的 Bean 是如何被加載到 Spring 上下文的，接下來就要知道是 Spring 是如何使用我們的 bean 以及對返回 body 做處理的

其實在 HttpMessageConverter是如何轉換數據的？ 這篇文章中已經說明了一部分，希望小伙伴先看這篇文章，下面的部分就會秒懂了，我們在這里做進一步的說明

在 AbstractMessageConverterMethodProcessor 的 writeWithMessageConverters 方法中，有一段核心代碼:

if (messageConverter instanceof GenericHttpMessageConverter) {
    if (((GenericHttpMessageConverter) messageConverter).canWrite(
            declaredType, valueType, selectedMediaType)) {
        outputValue = (T) getAdvice().beforeBodyWrite(outputValue, returnType, selectedMediaType,
                (Class<? extends HttpMessageConverter<?>>) messageConverter.getClass(),
                inputMessage, outputMessage);
            ...
        return;
    }
}

可以看到通過 getAdvice() 調用了 beforeBodyWrite 方法，我們已經接近真相了

protected RequestResponseBodyAdviceChain getAdvice() {
    return this.advice;
}

RequestResponseBodyAdviceChain，看名字帶有 Chain，很明顯用到了「責任鏈設計模式」，這些內容在 不得不知的責任鏈設計模式 文章中明確說明過，只不過它傳遞責任鏈以循環的方式完成:

class RequestResponseBodyAdviceChain implements RequestBodyAdvice, ResponseBodyAdvice<Object> {

    @Override
	public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType contentType,
			Class<? extends HttpMessageConverter<?>> converterType,
			ServerHttpRequest request, ServerHttpResponse response) {

		return processBody(body, returnType, contentType, converterType, request, response);
	}

    @SuppressWarnings("unchecked")
	private <T> Object processBody(Object body, MethodParameter returnType, MediaType contentType,
			Class<? extends HttpMessageConverter<?>> converterType,
			ServerHttpRequest request, ServerHttpResponse response) {

		for (ResponseBodyAdvice<?> advice : getMatchingAdvice(returnType, ResponseBodyAdvice.class)) {
			if (advice.supports(returnType, converterType)) {
				body = ((ResponseBodyAdvice<T>) advice).beforeBodyWrite((T) body, returnType,
						contentType, converterType, request, response);
			}
		}
		return body;
	}
}

我們重寫的 beforeBodyWrite 方法終究會被調用到，真相就是這樣了!!!

其實還沒完，你有沒有想過，如果我們的 API 方法返回值是 org.springframework.http.ResponseEntity<T> 類型，我們可以指定 HTTP 返回狀態碼，但是這個返回值會直接放到我們的 beforeBodyWrite 方法的 body 參數中嗎？如果這樣做很明顯是錯誤的，因為 ResponseEntity 包含很多我們非業務數據在里面，那 Spring 是怎么幫我們處理的呢？

在我們方法取得返回值並且在調用 beforeBodyWrite 方法之前，還要選擇 HandlerMethodReturnValueHandler 用於處理不同的 Handler 來處理返回值

在類 HandlerMethodReturnValueHandlerComposite 中的 handleReturnValue 方法中

@Override
public void handleReturnValue(Object returnValue, MethodParameter returnType,
        ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {

    HandlerMethodReturnValueHandler handler = selectHandler(returnValue, returnType);
    if (handler == null) {
        throw new IllegalArgumentException("Unknown return value type: " + returnType.getParameterType().getName());
    }
    handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
}

通過調用 selectHandler 方法來選擇合適的 handler，Spring 內置了很多個 Handler，我們來看類圖:

HttpEntityMethodProcessor 就是其中之一，它重寫了 supportsParameter 方法，支持 HttpEntity 類型，即支持 ResponseEntity 類型:

@Override
public boolean supportsParameter(MethodParameter parameter) {
    return (HttpEntity.class == parameter.getParameterType() ||
            RequestEntity.class == parameter.getParameterType());
}

所以當我們返回的類型為 ResponseEntity 時，就要通過 HttpEntityMethodProcessor 的 handleReturnValue 方法來處理我們的結果:

@Override
public void handleReturnValue(Object returnValue, MethodParameter returnType,
        ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {

    ...
    if (responseEntity instanceof ResponseEntity) {
        int returnStatus = ((ResponseEntity<?>) responseEntity).getStatusCodeValue();
        outputMessage.getServletResponse().setStatus(returnStatus);
        if (returnStatus == 200) {
            if (SAFE_METHODS.contains(inputMessage.getMethod())
                    && isResourceNotModified(inputMessage, outputMessage)) {
                // Ensure headers are flushed, no body should be written.
                outputMessage.flush();
                // Skip call to converters, as they may update the body.
                return;
            }
        }
    }

    // Try even with null body. ResponseBodyAdvice could get involved.
    writeWithMessageConverters(responseEntity.getBody(), returnType, inputMessage, outputMessage);

    // Ensure headers are flushed even if no body was written.
    outputMessage.flush();
}

該方法提取出 responseEntity.getBody()，並傳遞個 MessageConverter，然后再繼續調用 beforeBodyWrite 方法，這才是真相!!!

這是 RESTful API 正常返回內容的情況，下一篇文章，讓我們來偵查一下統一異常情況的處理以及實現原理

靈魂追問

  1. 返回值是非 ResponseEntity 類型時，用的是什么 handler？它支持的返回值類型是什么？看過你也許就知道為什么要用 @ResponseBody 注解了
  2. 你有追蹤過 DispatchServlet 的整個請求過程嗎？

提高效率工具

推薦閱讀

歡迎持續關注公眾號：「日拱一兵」

  • 前沿 Java 技術干貨分享
  • 高效工具匯總 | 回復「工具」
  • 面試問題分析與解答
  • 技術資料領取 | 回復「資料」

以讀偵探小說思維輕松趣味學習 Java 技術棧相關知識，本着將復雜問題簡單化，抽象問題具體化和圖形化原則逐步分解技術問題，技術持續更新，請持續關注......


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 springboot返回統一數據格式及其原理淺析 .net core api 全局統一數據返回格式 統一返回數據格式 （二）如何返回統一的數據格式 .net core restful api 返回數據格式 SpringBoot入門系列（二）如何返回統一的數據格式 React-使用redux-immutable統一數據格式 springboot統一ajax返回數據格式，並且jquery ajax success函數修改 springboot統一返回json數據格式並配置系統異常攔截 Spring Boot 無侵入式 實現RESTful API接口統一JSON格式返回
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM