SpringMVC處理JSON

一、具體實作

1、加入jar包

2、編寫目标方法，使其傳回JSON對應的對象或集合

3、在編寫的方法上面添加@ResponseBody注解

@Controller
public class testJson {

	@ResponseBody
	@RequestMapping("/testJson")
	public List<Department> testJson() {

		List<Department> list = new ArrayList<>();
		Department department1 = new Department(1, "GL");
		Department department2 = new Department(2, "LG");
		list.add(department1);
		list.add(department2);
		return list;
	}
}
           

這樣我們就可以傳回一個JSON數組。

二、原理

SpringMVC在處理JSON資料時，需要使用HttpMessageConverter接口，其是Spring3.0新添加的接口，主要負責将請求資訊轉換為一個Java對象（類型為 T），或将Java對象（類型為 T）輸出為響應資訊。 

　　HttpMessageConverter的基本流程如下圖所示： 

HttpMessageConverter的實作類主要有：

DispatcherServlet預設裝配有ReuqestMappingHandlerAdapter

而ReuqestMappingHandlerAdapter預設裝配的HttpMessageConverter如下： 

加入Jackson所需要的jar包後，RequestMappingHandlerAdapter裝配的HttpMessageConverter如下：

由此可見，在加入Jackson所需要的jar包後，SpringMVC會自動将MappingJackson2HttpMessageConverter裝配上，以實作對JSON資料的處理。

三、HttpMessageConverter

使用

HttpMessageConverter<T>

将請求資訊轉化并綁定到處理方法的入參中或将響應結果轉化為對應類型的響應資訊，SpringMVC提供了兩種途徑： 

　　①. 使用@RequestBody标注處理方法的入參或使用@ResponseBody标注處理方法； 

　　②. 使用

HttpEntity<T>

作為處理方法的入參或使用

ResponseEntity<T>

作為處理方法的傳回值。 

1. @Responsebody 注解表示該方法的傳回的結果直接寫入 HTTP 響應正文（ResponseBody）中，一般在異步擷取資料時使用；
2. 在使用 @RequestMapping 後，傳回值通常解析為跳轉路徑，加上 @Responsebody 後傳回結果不會被解析為跳轉路徑，而是直接寫入HTTP 響應正文中。例如，異步擷取 json 資料，加上 @Responsebody 注解後，就會直接傳回 json 資料。
3. @RequestBody 注解則是将 HTTP 請求正文插入方法中，使用适合的 HttpMessageConverter 将請求體寫入某個對象。

那麼HttpMessageConverter的比對過程是什麼樣的呢？

@RequestBody注解時： 根據Request對象header部分的Content-Type類型，逐一比對合适的HttpMessageConverter來讀取資料。

spring 3.1源代碼如下：

private Object readWithMessageConverters(MethodParameter methodParam, HttpInputMessage inputMessage, Class paramType) throws Exception {  

    MediaType contentType = inputMessage.getHeaders().getContentType();  
    if (contentType == null) {  
        StringBuilder builder = new StringBuilder(ClassUtils.getShortName(methodParam.getParameterType()));  
        String paramName = methodParam.getParameterName();  
        if (paramName != null) {  
            builder.append(' ');  
            builder.append(paramName);  
        }  
        throw new HttpMediaTypeNotSupportedException("Cannot extract parameter (" + builder.toString() + "): no Content-Type found");  
    }  

    List<MediaType> allSupportedMediaTypes = new ArrayList<MediaType>();  
    if (this.messageConverters != null) {  
        for (HttpMessageConverter<?> messageConverter : this.messageConverters) {  
            allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());  
            if (messageConverter.canRead(paramType, contentType)) {  
                if (logger.isDebugEnabled()) {  
                    logger.debug("Reading [" + paramType.getName() + "] as \"" + contentType  + "\" using [" + messageConverter + "]");  
                }  
                return messageConverter.read(paramType, inputMessage);  
            }  
        }  
    }  
    throw new HttpMediaTypeNotSupportedException(contentType, allSupportedMediaTypes);  
}
           

@ResponseBody注解時：根據Request對象header部分的Accept屬性（逗号分隔），逐一按accept中的類型，去周遊找到能處理的HttpMessageConverter。

spring 3.1 源代碼如下：

private void writeWithMessageConverters(Object returnValue,  HttpInputMessage inputMessage, HttpOutputMessage outputMessage)  
                throws IOException, HttpMediaTypeNotAcceptableException {  
    List<MediaType> acceptedMediaTypes = inputMessage.getHeaders().getAccept();  
    if (acceptedMediaTypes.isEmpty()) {  
        acceptedMediaTypes = Collections.singletonList(MediaType.ALL);  
    }  
    MediaType.sortByQualityValue(acceptedMediaTypes);  
    Class<?> returnValueType = returnValue.getClass();  
    List<MediaType> allSupportedMediaTypes = new ArrayList<MediaType>();  
    if (getMessageConverters() != null) {  
        for (MediaType acceptedMediaType : acceptedMediaTypes) {  
            for (HttpMessageConverter messageConverter : getMessageConverters()) {  
                if (messageConverter.canWrite(returnValueType, acceptedMediaType)) {  
                    messageConverter.write(returnValue, acceptedMediaType, outputMessage);  
                    if (logger.isDebugEnabled()) {  
                        MediaType contentType = outputMessage.getHeaders().getContentType();  
                        if (contentType == null) {  
                            contentType = acceptedMediaType;  
                        }  
                        logger.debug("Written [" + returnValue + "] as \"" + contentType +  
                                "\" using [" + messageConverter + "]");  
                    }  
                    this.responseArgumentUsed = true;  
                    return;  
                }  
            }  
        }  
        for (HttpMessageConverter messageConverter : messageConverters) {  
            allSupportedMediaTypes.addAll(messageConverter.getSupportedMediaTypes());  
        }  
    }  
    throw new HttpMediaTypeNotAcceptableException(allSupportedMediaTypes);  
}
           

版權聲明：本文為CSDN部落客「weixin_33851177」的原創文章，遵循CC 4.0 BY-SA版權協定，轉載請附上原文出處連結及本聲明。

原文連結：https://blog.csdn.net/weixin_33851177/article/details/91818498