springboot怎么實(shí)現(xiàn)RESTfulAPI返回統(tǒng)一數(shù)據(jù)格式

今天就跟大家聊聊有關(guān)spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

在竹山等地區(qū)，都構(gòu)建了全面的區(qū)域性戰(zhàn)略布局，加強(qiáng)發(fā)展的系統(tǒng)性、市場(chǎng)前瞻性、產(chǎn)品創(chuàng)新能力，以專(zhuān)注、極致的服務(wù)理念，為客戶(hù)提供做網(wǎng)站、網(wǎng)站制作網(wǎng)站設(shè)計(jì)制作定制網(wǎng)站開(kāi)發(fā),公司網(wǎng)站建設(shè),企業(yè)網(wǎng)站建設(shè),品牌網(wǎng)站設(shè)計(jì),成都營(yíng)銷(xiāo)網(wǎng)站建設(shè),外貿(mào)網(wǎng)站制作,竹山網(wǎng)站建設(shè)費(fèi)用合理。

關(guān)于 Spring 的全局處理，我有兩方面要說(shuō):

統(tǒng)一數(shù)據(jù)返回格式
統(tǒng)一異常處理為了將兩個(gè)問(wèn)題說(shuō)明清楚，將分兩個(gè)章節(jié)分別說(shuō)明，本章主要說(shuō)第一點(diǎn)

有童鞋說(shuō)，我們項(xiàng)目都做了這種處理，就是在每個(gè) API 都單獨(dú)工具類(lèi)將返回值進(jìn)行封裝，但這種不夠優(yōu)雅；我想寫(xiě)最少的代碼完成這件事，也許有童鞋說(shuō)，加幾個(gè)注解就解決問(wèn)題了，說(shuō)的沒(méi)錯(cuò)，但這篇文章主要是為了說(shuō)明為什么加了幾個(gè)注解就解決問(wèn)題了，目的是希望大家知其所以然。

spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式

為了更好的說(shuō)明問(wèn)題，本文先說(shuō)明如何實(shí)現(xiàn)，然后再詳細(xì)剖析實(shí)現(xiàn)原理(這很關(guān)鍵)

為什么要做統(tǒng)一數(shù)據(jù)返回格式

前后端分離是當(dāng)今服務(wù)形式的主流，如何設(shè)計(jì)一個(gè)好的 RESTful API ，以及如何讓前端小伙伴可以處理標(biāo)準(zhǔn)的 response JSON 數(shù)據(jù)結(jié)構(gòu)都至關(guān)重要，為了讓前端有更好的邏輯展示與頁(yè)面交互處理，每一次 RESTful 請(qǐng)求都應(yīng)該包含以下幾個(gè)信息:

名稱(chēng)	描述
status	狀態(tài)碼，標(biāo)識(shí)請(qǐng)求成功與否，如 [1:成功；-1:失敗]
errorCode	錯(cuò)誤碼，給出明確錯(cuò)誤碼，更好的應(yīng)對(duì)業(yè)務(wù)異常；請(qǐng)求成功該值可為空
errorMsg	錯(cuò)誤消息，與錯(cuò)誤碼相對(duì)應(yīng)，更具體的描述異常信息
resultBody	返回結(jié)果，通常是 Bean 對(duì)象對(duì)應(yīng)的 JSON 數(shù)據(jù), 通常為了應(yīng)對(duì)不同返回值類(lèi)型，將其聲明為泛型類(lèi)型

實(shí)現(xiàn)

通用返回值類(lèi)定義

根據(jù)上面的描述，用 Java Bean 來(lái)體現(xiàn)這個(gè)結(jié)構(gòu)就是這樣:

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

配置

沒(méi)錯(cuò)，我們需要借助幾個(gè)關(guān)鍵注解來(lái)完成一下相關(guān)配置:

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

到這里就結(jié)束了，我們就可以縱情的寫(xiě)任何 RESTful API 了，所有的返回值都會(huì)有統(tǒng)一的 JSON 結(jié)構(gòu)

測(cè)試

新建 UserController，添加相應(yīng)的 RESTful API，測(cè)試用例寫(xiě)的比較簡(jiǎn)單，只為了說(shuō)明返回值的處理

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

打開(kāi)瀏覽器輸入地址測(cè)試: http://localhost:8080/users/ ，我們可以看到返回了 List JSON 數(shù)據(jù)

spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式

繼續(xù)添加 RESTful API，根據(jù)用戶(hù) ID 查詢(xún)用戶(hù)信息

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

打開(kāi)瀏覽器輸入地址測(cè)試: http://localhost:8080/users/1 ，我們可以看到返回了單個(gè) User JSON 數(shù)據(jù)

spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式

添加一個(gè)返回值類(lèi)型為 ResponseEntity 的 API

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

打開(kāi)瀏覽器輸入地址測(cè)試: http://localhost:8080/users/testResponseEntity ，我們可以看到同樣返回了單個(gè) User JSON 數(shù)據(jù)

spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式

解剖實(shí)現(xiàn)過(guò)程

我會(huì)將關(guān)鍵部分一一說(shuō)明清楚，斷案還需小伙伴自己去案發(fā)現(xiàn)場(chǎng)(打開(kāi)自己的 IDE 查看)

故事要從 @EnableWebMvc 這個(gè)注解說(shuō)起，打開(kāi)該注解看:

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

通過(guò) @Import 注解引入了 DelegatingWebMvcConfiguration.class，那來(lái)看這個(gè)類(lèi)吧:

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

有 @Configuration 注解，你應(yīng)該很熟悉了，該類(lèi)的父類(lèi) WebMvcConfigurationSupport 中卻隱藏著一段關(guān)鍵代碼:

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

RequestMappingHandlerAdapter 是每一次請(qǐng)求處理的關(guān)鍵，來(lái)看該類(lèi)的定義:

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

該類(lèi)實(shí)現(xiàn)了 InitializingBean 接口，我在 Spring Bean 生命周期之“我從哪里來(lái)”？這篇文章中明確說(shuō)明了 Spring Bean 初始化的幾個(gè)關(guān)鍵，其中 InitializingBean 接口的 afterPropertiesSet 方法就是關(guān)鍵之一，在 RequestMappingHandlerAdapter 類(lèi)中同樣重寫(xiě)了該方法:

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

該方法內(nèi)容都非常關(guān)鍵，但我們先來(lái)看 initControllerAdviceCache 方法，其他內(nèi)容后續(xù)再單獨(dú)說(shuō)明:

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

通過(guò) ControllerAdviceBean 靜態(tài)方法掃描 ControllerAdvice 注解，可是我們?cè)趯?shí)現(xiàn)上使用的是 @RestControllerAdvice 注解，打開(kāi)看該注解:

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

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

到這里你已經(jīng)知道我們用 @RestControllerAdvice 標(biāo)記的 Bean 是如何被加載到 Spring 上下文的，接下來(lái)就要知道是 Spring 是如何使用我們的 bean 以及對(duì)返回 body 做處理的

其實(shí)在 HttpMessageConverter是如何轉(zhuǎn)換數(shù)據(jù)的？這篇文章中已經(jīng)說(shuō)明了一部分，希望小伙伴先看這篇文章，下面的部分就會(huì)秒懂了，我們?cè)谶@里做進(jìn)一步的說(shuō)明

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

可以看到通過(guò) getAdvice() 調(diào)用了 beforeBodyWrite 方法，我們已經(jīng)接近真相了

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

RequestResponseBodyAdviceChain，看名字帶有 Chain，很明顯用到了「責(zé)任鏈設(shè)計(jì)模式」，這些內(nèi)容在不得不知的責(zé)任鏈設(shè)計(jì)模式文章中明確說(shuō)明過(guò)，只不過(guò)它傳遞責(zé)任鏈以循環(huán)的方式完成:

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

我們重寫(xiě)的 beforeBodyWrite 方法終究會(huì)被調(diào)用到，真相就是這樣了!!!

其實(shí)還沒(méi)完，你有沒(méi)有想過(guò)，如果我們的 API 方法返回值是 org.springframework.http.ResponseEntity<T> 類(lèi)型，我們可以指定 HTTP 返回狀態(tài)碼，但是這個(gè)返回值會(huì)直接放到我們的 beforeBodyWrite 方法的 body 參數(shù)中嗎？如果這樣做很明顯是錯(cuò)誤的，因?yàn)?ResponseEntity 包含很多我們非業(yè)務(wù)數(shù)據(jù)在里面，那 Spring 是怎么幫我們處理的呢？

在我們方法取得返回值并且在調(diào)用 beforeBodyWrite 方法之前，還要選擇 HandlerMethodReturnValueHandler 用于處理不同的 Handler 來(lái)處理返回值

在類(lèi) 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);
}

通過(guò)調(diào)用 selectHandler 方法來(lái)選擇合適的 handler，Spring 內(nèi)置了很多個(gè) Handler，我們來(lái)看類(lèi)圖:

spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式

HttpEntityMethodProcessor 就是其中之一，它重寫(xiě)了 supportsParameter 方法，支持 HttpEntity 類(lèi)型，即支持 ResponseEntity 類(lèi)型:

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

所以當(dāng)我們返回的類(lèi)型為 ResponseEntity 時(shí)，就要通過(guò) HttpEntityMethodProcessor 的 handleReturnValue 方法來(lái)處理我們的結(jié)果:

@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()，并傳遞個(gè) MessageConverter，然后再繼續(xù)調(diào)用 beforeBodyWrite 方法，這才是真相!!!

看完上述內(nèi)容，你們對(duì)spring boot怎么實(shí)現(xiàn)RESTful API返回統(tǒng)一數(shù)據(jù)格式有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝大家的支持。

當(dāng)前名稱(chēng)：springboot怎么實(shí)現(xiàn)RESTfulAPI返回統(tǒng)一數(shù)據(jù)格式
轉(zhuǎn)載注明：http://www.jbt999.com/article40/iipieo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供搜索引擎優(yōu)化、網(wǎng)站策劃、外貿(mào)網(wǎng)站建設(shè)、電子商務(wù)、定制開(kāi)發(fā)、App設(shè)計(jì)

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話(huà)：028-86922220；郵箱：[email protected]。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容