快捷導(dǎo)航

SpringBoot自定義MessageConvert詳細(xì)講解

更新時間：2023年01月11日 15:38:37 作者：zoeil

正在學(xué)習(xí)SpringBoot，在自定義MessageConverter時發(fā)現(xiàn)：為同一個返回值類型配置多個MessageConverter時，可能會發(fā)生響應(yīng)數(shù)據(jù)格式錯誤，或406異常（客戶端無法接收相應(yīng)數(shù)據(jù)）。在此記錄一下解決問題以及追蹤源碼的過程

前言

對于頁面攜帶的請求頭中的AcceptSpringBoot有對應(yīng)的10種MessageConvert可以支持寫出對應(yīng)的媒體類型，比如application/xml、application/json……

我們還可以通過向容器放入一個WebMvcConfigurer

實現(xiàn)定制化SpingMVC，自定義一個MessageConvert處理特殊的協(xié)議比如application/x-person

實現(xiàn)多協(xié)議數(shù)據(jù)兼容。json、xml、x-person

原理

0、@ResponseBody 響應(yīng)數(shù)據(jù)出去調(diào)用 RequestResponseBodyMethodProcessor 處理

1、Processor 處理方法返回值。通過 MessageConverter 處理

2、所有 MessageConverter 合起來可以支持各種媒體類型數(shù)據(jù)的操作（讀、寫）

3、內(nèi)容協(xié)商找到最終的 messageConverter；

實現(xiàn)

/* 條件
*
* 1、瀏覽器發(fā)請求直接返回xml [application/xml] jacksonXmlConverter
* 2、如果是ajax請求返回json [application/json] jacksonJsonConverter
* 3、如果是app發(fā)請求，返回自定義協(xié)議數(shù)據(jù) [application/x-person] xxxxConverter
*
* 步驟：
* 1、添加自定義的MessageConverter進(jìn)系統(tǒng)底層
* 2、系統(tǒng)底層就會統(tǒng)計出所有MessageConverter能操作哪些類型
* 3、客戶端內(nèi)容協(xié)商 [person--->person]
*/

person類

@Data
public class Person {
    public String username;
    public Integer age;
    public Pet pet;
}

pet類

@Data
public class Pet {
    public String name;
    public Integer age;
}

PersonMessageConvert

/*
 * 自定義的Convert
 */
public class PersonMessageConvert implements HttpMessageConverter<Person> {
    @Override
    public boolean canRead(Class<?> clazz, MediaType mediaType) {
        return false;
    }
    @Override
    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
        return clazz.isAssignableFrom(Person.class);
    }
    /*
     * @Description 服務(wù)器需要統(tǒng)計所有MessageConvert都能寫出哪些類型，我們這里也要自定義
     * @Param
     **/
    @Override
    public List<MediaType> getSupportedMediaTypes() {
        return MediaType.parseMediaTypes("application/x-person");
    }
    @Override
    public Person read(Class<? extends Person> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        return null;
    }
    @Override
    public void write(Person person, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        //自定義協(xié)會數(shù)據(jù)的寫出
        String data = person.getUsername() + ";" + person.getAge() + ";" +person.getPet() + ";";
        //寫出去
        OutputStream body = outputMessage.getBody();
        body.write(data.getBytes());
    }
}

方法

    @ResponseBody
    @GetMapping("/test/person")
    public Person getPeroson() {
        Person person = new Person();
        person.setUsername("張三");
        person.setAge(18);
        person.setPet(new Pet());
        return person;
    }

WebMvcConfigurer

    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
                converters.add(new PersonMessageConvert());
            }
       }
    }

測試

拓展

如何實現(xiàn)訪問路徑攜帶format參數(shù)指明協(xié)商協(xié)議

比如：http://localhost:8080/test/person?format=x-person

記得先開啟基于參數(shù)的內(nèi)容協(xié)商

spring:
mvc:
contentnegotiation:
favor-parameter: true

@Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            /*
             * 自定義內(nèi)容協(xié)商策略
             */
            @Override
            public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
                Map<String, MediaType> mediaTypeMap = new HashMap<>();
                mediaTypeMap.put("json", MediaType.APPLICATION_JSON);
                mediaTypeMap.put("xml", MediaType.APPLICATION_XML);
                mediaTypeMap.put("x-person",MediaType.parseMediaType("application/x-person"));
                //指定支持解析那些參數(shù)的媒體類型
                ParameterContentNegotiationStrategy parametertrategy = new ParameterContentNegotiationStrategy(mediaTypeMap);
                HeaderContentNegotiationStrategy headerStrategy = new HeaderContentNegotiationStrategy();
                configurer.strategies(Arrays.asList(parametertrategy, headerStrategy));
            }
            @Override
            public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
                converters.add(new PersonMessageConvert());
            }
        };
    }

測試