自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

帶你玩轉(zhuǎn)SpringMVC自定義HTTP請(qǐng)求響應(yīng)數(shù)據(jù)轉(zhuǎn)換

開發(fā) 前端
自定義HttpMessageConverter是Spring MVC中一個(gè)強(qiáng)大的工具,它可以幫助開發(fā)者更加靈活地控制數(shù)據(jù)轉(zhuǎn)換的過程,滿足特定的需求。

環(huán)境:SpringBoot2.7.12

1. 簡(jiǎn)介

在Spring MVC中,HttpMessageConverter主要用于將HTTP請(qǐng)求的輸入內(nèi)容轉(zhuǎn)換為指定的Java對(duì)象,以及將Java對(duì)象轉(zhuǎn)換為HTTP響應(yīng)的輸出內(nèi)容。這種靈活的消息轉(zhuǎn)換機(jī)制就是利用HttpMessageConverter來實(shí)現(xiàn)的。

Spring MVC提供了多個(gè)默認(rèn)的HttpMessageConverter實(shí)現(xiàn),包括處理JSON、XML、文本等格式的Converter。另外,我們也可以自定義HttpMessageConverter來處理其他格式的數(shù)據(jù)。

Spring MVC提供了兩個(gè)注解:@RequestBody和@ResponseBody,分別用于完成請(qǐng)求報(bào)文到對(duì)象和對(duì)象到響應(yīng)報(bào)文的轉(zhuǎn)換。

然而,有時(shí)候默認(rèn)的HttpMessageConverter無法滿足特定的需求,例如,當(dāng)我們需要處理的數(shù)據(jù)格式?jīng)]有默認(rèn)的Converter時(shí),或者我們需要對(duì)現(xiàn)有的Converter進(jìn)行擴(kuò)展時(shí),就需要自定義HttpMessageConverter。

自定義HttpMessageConverter可以讓我們更加靈活地控制數(shù)據(jù)轉(zhuǎn)換的過程,例如我們可以自定義轉(zhuǎn)換規(guī)則、異常處理等。

接下來我們通過一個(gè)實(shí)例講解如何自定義HttpMessageConverter。

需求

接口請(qǐng)求數(shù)據(jù)格式:

xxx|yyy|zzz|...

接口返回JSON數(shù)據(jù)格式

{
    "xxx": xxx,
    "yyy": yyy,
    "zzz": zzz,
    ...
}

其實(shí)就上面的數(shù)據(jù)格式,我們完全可以不用自定義HttpMessageConverter也是完全可以實(shí)現(xiàn)的。我們這里主要就是教大家如何在特殊的需求下實(shí)現(xiàn)特定的數(shù)據(jù)轉(zhuǎn)換處理。

2. 實(shí)戰(zhàn)案例

自定義HttpMessageConverter轉(zhuǎn)換器

public class PackHttpMessageConverter implements HttpMessageConverter<Object> {
    
  // 設(shè)置自定義的Content-Type類型,這樣就限定了只有請(qǐng)求的內(nèi)容類型是該類型才會(huì)使用該轉(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) ;
  }


  // 從請(qǐng)求中讀取數(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) ;
    // 這里簡(jiǎn)單處理只針對(duì)Users類型的對(duì)象處理
    if (clazz == Users.class) {
      try {
        // 創(chuàng)建實(shí)例
        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注冊(cè)到容器中

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  
  @Override
  public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.add(new PackHttpMessageConverter()) ;
  }
}

到這里自定義HttpMessageConverter及注冊(cè)到容器中就全部完成了,開發(fā)還是比較簡(jiǎn)單,接下來做測(cè)試

接口

// 方法非常簡(jiǎn)單還是用的那些常用的類,@RequestBody接收請(qǐng)求body中的內(nèi)容
@PostMapping("/i")
public Object i(@RequestBody Users user) {
  System.out.println(handlerAdapter) ;
  return user ;
}

通過Postman測(cè)試接口

設(shè)置請(qǐng)求的header

圖片圖片

圖片圖片

似乎沒有任何的問題,其實(shí)你只要在寫的方法中打印下日志,或者調(diào)試下,你會(huì)發(fā)現(xiàn)你的write方法根本就沒有被調(diào)用,也就是說寫數(shù)據(jù)并沒有使用到我們自定義的實(shí)現(xiàn),這是因?yàn)橛袃?yōu)先級(jí)比我們自定義的轉(zhuǎn)換器高,所以要想讓寫消息也調(diào)用自定義的。我們需要如下修改注冊(cè)方式:

public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  converters.add(0, new PackHttpMessageConverter()) ;
}

這樣我們自定義的轉(zhuǎn)換器就排到了第一的位置,這樣就會(huì)調(diào)用我們自定義的write方法。

以上就是自定義HttpMessageConverter全部?jī)?nèi)容。

3. 實(shí)現(xiàn)原理

請(qǐng)求參數(shù)由于添加了@RequestBody,所以方法的參數(shù)解析器使用的是RequestResponseBodyMethodProcessor。

public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
  protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
      Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
    // ...
    // 讀取請(qǐng)求數(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)換器是否讀,也就上面我們自定義中實(shí)現(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;
        }
      }
  }
}

原理也比較的簡(jiǎn)單。

自定義HttpMessageConverter是Spring MVC中一個(gè)強(qiáng)大的工具,它可以幫助開發(fā)者更加靈活地控制數(shù)據(jù)轉(zhuǎn)換的過程,滿足特定的需求。

責(zé)任編輯:武曉燕 來源: Spring全家桶實(shí)戰(zhàn)案例源碼
相關(guān)推薦

2023-12-04 07:27:54

SpringMVC方法

2022-12-07 08:56:27

SpringMVC核心組件

2022-06-20 08:26:39

Spring容器類型轉(zhuǎn)換

2022-11-01 11:15:56

接口策略模式

2021-07-11 17:17:08

.NET 授權(quán)自定義

2021-08-09 10:31:33

自定義授權(quán)響應(yīng)

2019-01-27 14:37:47

數(shù)據(jù)HTTP服務(wù)

2009-08-12 14:53:50

C#類型轉(zhuǎn)換函數(shù)

2023-10-06 10:47:25

Mybatis類型轉(zhuǎn)換

2015-02-12 15:33:43

微信SDK

2011-07-04 14:08:02

C++

2015-02-12 15:38:26

微信SDK

2009-08-28 17:45:19

C#自定義數(shù)據(jù)

2024-01-05 15:28:06

鴻蒙數(shù)據(jù)同步GlobalThis

2016-12-26 15:25:59

Android自定義View

2016-11-16 21:55:55

源碼分析自定義view androi

2023-06-06 08:01:18

自定義接口響應(yīng)

2011-06-23 10:49:13

Qt 自定義信號(hào)

2021-08-13 08:36:15

SpringMVC自定義

2012-02-02 13:45:28

JavaJSP
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)