WebClient拋UnsupportedMediaTypeException異常解決

Posted on by

前言

前面分享瞭Spring5中的WebClient使用方法詳解 後，就有朋友在segmentfault上給博主提瞭一個付費的問題，這個是博主在segmentfault平臺上面收到的首個付費問答，雖然酬勞不多，隻有十元，用群友的話說性價比太低瞭。但在解決問題過程中對WebClient有瞭更深入的瞭解卻是另一種收獲。解決這個問題博主做瞭非常詳細的排查和解決，現將過程記錄在此，供有需要的朋友參考。

問題背景

使用WebClient請求一個接口，使用bodyToMono方法用一個Entity接收響應的內容，偽代碼如下：

IdExocrResp resp = WebClient.create()
                .post()
                .uri("https://id.exocr.com:8080/bankcard")
                .body(BodyInserters.fromFormData(formData))
                .retrieve()
                .bodyToMono(IdExocrResp.class)
                .block();

上面的代碼在運行時會拋一個異常，異常如下：

Exception in thread "main" org.springframework.web.reactive.function.UnsupportedMediaTypeException: Content type 'application/octet-stream' not supported for bodyType=IdExocrResp
	at org.springframework.web.reactive.function.BodyExtractors.lambda$readWithMessageReaders$12(BodyExtractors.java:201)
	Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException: 
Error has been observed at the following site(s):

直譯過來大概的意思就是，不支持application/octet-stream類型的Content Type。

問題分析

如上異常，拋異常的代碼在BodyExtractors的201行，根據異常堆棧信息找到對應的代碼分析：

private static  S readWithMessageReaders(
			ReactiveHttpInputMessage message, BodyExtractor.Context context, ResolvableType elementType,
			Function readerFunction,
			Function errorFunction,
			Supplier emptySupplier) {
		if (VOID_TYPE.equals(elementType)) {
			return emptySupplier.get();
		}
		MediaType contentType = Optional.ofNullable(message.getHeaders().getContentType())
				.orElse(MediaType.APPLICATION_OCTET_STREAM);
		return context.messageReaders().stream()
				.filter(reader -> reader.canRead(elementType, contentType))
				.findFirst()
				.map(BodyExtractors::cast)
				.map(readerFunction)
				.orElseGet(() -> {
					ListmediaTypes = context.messageReaders().stream()
							.flatMap(reader -> reader.getReadableMediaTypes().stream())
							.collect(Collectors.toList());
					return errorFunction.apply(
							new UnsupportedMediaTypeException(contentType, mediaTypes, elementType));
				});
	}

可以看到，在這個body提取器類中，有一個默認的contentType 策略，如果server端沒有返回contentType ，默認就使用APPLICATION_OCTET_STREAM來接收數據。問題正是這裡導致的。因為在這個接口的響應header裡，contentType 為null，其實正確的應該是application/json，隻是服務器沒指定，然後被默認策略設置為application/octet-stream後，在默認的JSON解碼器裡是不支持，導致拋出瞭不支持的MediaType異常。定位到真實原因後，博主給出瞭如下方案

解決方案

方案一

如果服務端是自己的服務，可以修改服務端的程序指定ContentType為application/json類型返回即可。如果是第三方的服務，沒法改動server端請參考下面的方案

方案二

使用String接收後，然後在flatMap裡在過濾自己解碼一遍，String類型可以接收application/octet-stream類型的Content Type的，代碼如：

IdExocrResp resp = WebClient.create()
                .post()
                .uri("xxx")
                .body(BodyInserters.fromFormData(formData))
                .retrieve()
                .bodyToMono(String.class)
                .flatMap(str -> Mono.just(JSON.parseObject(str, IdExocrResp.class)))
                .block();

方案三

因為響應的值確實是json，隻是在響應的header裡沒有指定Content Type為application/json。而最終異常也是因為json解碼器不支持導致的，所以我們可以定制json解碼器，重寫支持的MediaType校驗規則

自定義解碼器

/**
 * @author: kl @kailing.pub
 * @date: 2019/12/3
 */
public class CustomJacksonDecoder extends AbstractJackson2Decoder {
    public CustomJacksonDecoder() {
        super(Jackson2ObjectMapperBuilder.json().build());
    }
    /**
     * 添加 MediaType.APPLICATION_OCTET_STREAM 類型的支持
     * @param mimeType
     * @return
     */
    @Override
    protected boolean supportsMimeType(MimeType mimeType) {
        return (mimeType == null
                || mimeType.equals(MediaType.APPLICATION_OCTET_STREAM)
                || super.getDecodableMimeTypes().stream().anyMatch(m -> m.isCompatibleWith(mimeType)));
    }
}

設置解碼器

ExchangeStrategies strategies = ExchangeStrategies.builder()
                .codecs(configurer -> configurer.customCodecs().decoder(new CustomJacksonDecoder()))
                .build();
        MultiValueMap formData = new LinkedMultiValueMap<>();
        IdExocrResp resp = WebClient.builder()
                .exchangeStrategies(strategies)
                .build()
                .post()
                .uri("https://id.exocr.com:8080/bankcard")
                .body(BodyInserters.fromFormData(formData))
                .retrieve()
                .bodyToMono(IdExocrResp.class)
                .block();

方案四

因為響應的DefaultClientResponse裡沒有Content-Type，所以可以使用exchange()拿到clientResponse後重新build一個ClientResponse，然後設置Content-Type為application/json即可解決問題，代碼如：

MultiValueMap formData = new LinkedMultiValueMap<>();
        IdExocrResp resp = WebClient.create()
                .post()
                .uri("https://id.exocr.com:8080/bankcard")
                .body(BodyInserters.fromFormData(formData))
                .exchange()
                .flatMap(res -> ClientResponse.from(res)
                        .header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
                        .body(res.body(BodyExtractors.toDataBuffers()))
                        .build()
                        .bodyToMono(IdExocrResp.class))
                .block();

方案五

同方案四的思路，重新構造一個帶Content-Type為application/json的clientResponse，但是處理邏輯是在filter裡，就不需要使用exchange()瞭，博主以為這種方式最簡潔優雅，代碼如：

MultiValueMap formData = new LinkedMultiValueMap<>();
        IdExocrResp resp = WebClient.builder()
                .filter((request, next) ->
                        next.exchange(request).map(response -> {
                            Fluxbody = response.body(BodyExtractors.toDataBuffers());
                            return ClientResponse.from(response)
                                    .header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
                                    .body(body)
                                    .build();
                        }))
                .build()
                .post()
                .uri("https://id.exocr.com:8080/bankcard")
                .body(BodyInserters.fromFormData(formData))
                .retrieve()
                .bodyToMono(IdExocrResp.class)
                .block();

方案六

前面原因分析的時候已經說瞭，MediaType為空時spring默認設置為application/octet-stream瞭。這裡的設計其實可以更靈活點的，比如除瞭默認的策略外，還可以讓用戶自由的設置默認的Content Type類型。這個就涉及到改動Spring的框架代碼瞭，博主已經把這個改動提交到Spring的官方倉庫瞭，如果合並瞭的話，就可以在下個版本使用這個方案解決問題瞭

pr地址：https://github.com/spring-projects/spring-framework/pull/24120

以上就是WebClient拋UnsupportedMediaTypeException異常解決的詳細內容，更多關於WebClient拋UnsupportedMediaTypeException的資料請關註WalkonNet其它相關文章！

推薦閱讀：