帶你玩轉(zhuǎn)SpringMVC自定義HTTP請求響應(yīng)數(shù)據(jù)轉(zhuǎn)換
環(huán)境：SpringBoot2.7.12
1. 簡介
在Spring MVC中，HttpMessageConverter主要用于將HTTP請求的輸入內(nèi)容轉(zhuǎn)換為指定的Java對象，以及將Java對象轉(zhuǎn)換為HTTP響應(yīng)的輸出內(nèi)容。這種靈活的消息轉(zhuǎn)換機(jī)制就是利用HttpMessageConverter來實現(xiàn)的。
Spring MVC提供了多個默認(rèn)的HttpMessageConverter實現(xiàn)，包括處理JSON、XML、文本等格式的Converter。另外，我們也可以自定義HttpMessageConverter來處理其他格式的數(shù)據(jù)。
Spring MVC提供了兩個注解：@RequestBody和@ResponseBody，分別用于完成請求報文到對象和對象到響應(yīng)報文的轉(zhuǎn)換。
然而，有時候默認(rèn)的HttpMessageConverter無法滿足特定的需求，例如，當(dāng)我們需要處理的數(shù)據(jù)格式?jīng)]有默認(rèn)的Converter時，或者我們需要對現(xiàn)有的Converter進(jìn)行擴(kuò)展時，就需要自定義HttpMessageConverter。
自定義HttpMessageConverter可以讓我們更加靈活地控制數(shù)據(jù)轉(zhuǎn)換的過程，例如我們可以自定義轉(zhuǎn)換規(guī)則、異常處理等。
接下來我們通過一個實例講解如何自定義HttpMessageConverter。
需求
接口請求數(shù)據(jù)格式：
xxx|yyy|zzz|...接口返回JSON數(shù)據(jù)格式
{
"xxx": xxx,
"yyy": yyy,
"zzz": zzz,
...
}其實就上面的數(shù)據(jù)格式，我們完全可以不用自定義HttpMessageConverter也是完全可以實現(xiàn)的。我們這里主要就是教大家如何在特殊的需求下實現(xiàn)特定的數(shù)據(jù)轉(zhuǎn)換處理。
2. 實戰(zhàn)案例
自定義HttpMessageConverter轉(zhuǎn)換器
public class PackHttpMessageConverter implements HttpMessageConverter<Object> {
// 設(shè)置自定義的Content-Type類型，這樣就限定了只有請求的內(nèi)容類型是該類型才會使用該轉(zhuǎn)換器進(jìn)行處理
private static final MediaType PACK = new MediaType("application", "pack", StandardCharsets.UTF_8) ;
// 判斷當(dāng)前轉(zhuǎn)換器是否能夠讀取數(shù)據(jù)
@Override
public boolean canRead(Class<?> clazz, MediaType mediaType) {
return PACK.equals(mediaType) ;
}
// 判斷當(dāng)前轉(zhuǎn)換器是否可以將結(jié)果數(shù)據(jù)進(jìn)行輸出到客戶端
@Override
public boolean canWrite(Class<?> clazz, MediaType mediaType) {
return true ;
}
// 返回當(dāng)前轉(zhuǎn)換器只支持application/pack類型的數(shù)據(jù)格式
@Override
public List<MediaType> getSupportedMediaTypes() {
return Arrays.asList(PACK) ;
}
// 從請求中讀取數(shù)據(jù)
@Override
public Object read(Class<? extends Object> clazz, HttpInputMessage inputMessage)
throws IOException, HttpMessageNotReadableException {
InputStream is = inputMessage.getBody() ;
String res = IOUtils.toString(is, StandardCharsets.UTF_8) ;
// 這里簡單處理只針對Users類型的對象處理
if (clazz == Users.class) {
try {
// 創(chuàng)建實例
Users target = (Users) clazz.newInstance() ;
String[] s = res.split("\\|");
target.setId(Long.valueOf(s[0])) ;
target.setName(s[1]) ;
target.setAge(Integer.valueOf(s[2])) ;
target.setIdNo(s[3]) ;
return target ;
} catch (InstantiationException | IllegalAccessException e) {
e.printStackTrace() ;
}
}
return null ;
}
// 將Controller方法返回值寫到客戶端
@Override
public void write(Object t, MediaType contentType, HttpOutputMessage outputMessage)
throws IOException, HttpMessageNotWritableException {
// 設(shè)置響應(yīng)頭為json格式
outputMessage.getHeaders().add("Content-Type", "application/json;charset=UTF-8") ;
ObjectMapper mapper = new ObjectMapper() ;
OutputStream os = outputMessage.getBody();
// 輸出結(jié)果內(nèi)容
os.write(mapper.writeValueAsString(t).getBytes(StandardCharsets.UTF_8)) ;
os.flush();
}
}
將PackHttpMessageConverter注冊到容器中
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
converters.add(new PackHttpMessageConverter()) ;
}
}到這里自定義HttpMessageConverter及注冊到容器中就全部完成了，開發(fā)還是比較簡單，接下來做測試
接口
// 方法非常簡單還是用的那些常用的類，@RequestBody接收請求body中的內(nèi)容
@PostMapping("/i")
public Object i(@RequestBody Users user) {
System.out.println(handlerAdapter) ;
return user ;
}通過Postman測試接口
設(shè)置請求的header
圖片
圖片
似乎沒有任何的問題，其實你只要在寫的方法中打印下日志，或者調(diào)試下，你會發(fā)現(xiàn)你的write方法根本就沒有被調(diào)用，也就是說寫數(shù)據(jù)并沒有使用到我們自定義的實現(xiàn)，這是因為有優(yōu)先級比我們自定義的轉(zhuǎn)換器高，所以要想讓寫消息也調(diào)用自定義的。我們需要如下修改注冊方式：
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
converters.add(0, new PackHttpMessageConverter()) ;
}這樣我們自定義的轉(zhuǎn)換器就排到了第一的位置，這樣就會調(diào)用我們自定義的write方法。
以上就是自定義HttpMessageConverter全部內(nèi)容。
3. 實現(xiàn)原理
請求參數(shù)由于添加了@RequestBody，所以方法的參數(shù)解析器使用的是RequestResponseBodyMethodProcessor。
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
// ...
// 讀取請求數(shù)據(jù)；調(diào)用父類方法
Object arg = readWithMessageConverters(inputMessage, parameter, paramType);
// ...
}
}AbstractMessageConverterMethodArgumentResolver
public abstract class AbstractMessageConverterMethodArgumentResolver {
protected <T> Object readWithMessageConverters(...) {
// ...
// 遍歷所有的消息轉(zhuǎn)換器
for (HttpMessageConverter<?> converter : this.messageConverters) {
Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
GenericHttpMessageConverter<?> genericConverter = (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
// 判斷當(dāng)前轉(zhuǎn)換器是否讀，也就上面我們自定義中實現(xiàn)的canRead方法
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);
// 讀取具體的數(shù)據(jù)內(nèi)容
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;
}
}
}
}原理也比較的簡單。
自定義HttpMessageConverter是Spring MVC中一個強(qiáng)大的工具，它可以幫助開發(fā)者更加靈活地控制數(shù)據(jù)轉(zhuǎn)換的過程，滿足特定的需求。
