快捷導(dǎo)航

SpringMVC自定義消息轉(zhuǎn)換器的使用其實(shí)很簡單

更新時間：2024年07月08日 10:01:27 作者：kusedexingfu

這篇文章主要介紹了SpringMVC自定義消息轉(zhuǎn)換器的使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

什么是消息轉(zhuǎn)換器

在SpringMVC中，可以使用@RequestBody和@ResponseBody兩個注解，分別完成請求報文到對象和對象到響應(yīng)報文的轉(zhuǎn)換，這種靈活的消息轉(zhuǎn)換機(jī)制就是利用HttpMessageConverter來實(shí)現(xiàn)的，Spring內(nèi)置了很多HttpMessageConverter，比如MappingJackson2HttpMessageConverter，StringHttpMessageConverter等，下面我們來自定義自己的消息轉(zhuǎn)換器來滿足上面的需求

自定義消息轉(zhuǎn)換器

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.util.StreamUtils;

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Base64;

/**
 * 針對Object的base64消息處理器
 */
public class Base64ObjMessageConverter extends AbstractHttpMessageConverter<Object> {

    public Base64ObjMessageConverter() {
        // 新建一個我們自定義的媒體類型application/base64obj
        super(new MediaType("application", "base64obj", Charset.forName("UTF-8")));
    }


    @Override
    protected boolean supports(Class<?> clazz) {
        return true;
    }

    @Override
    protected Object readInternal(Class<? extends Object> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        String source = new String(Base64.getDecoder().decode(StreamUtils.copyToString(inputMessage.getBody(), Charset.forName("UTF-8"))), "UTF-8");
        return new ObjectMapper().readValue(source, clazz);
    }

    @Override
    protected void writeInternal(Object obj, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        byte[] encode = Base64.getEncoder().encode(new ObjectMapper().writeValueAsString(obj).getBytes());
        outputMessage.getBody().write(encode);
    }
}

如上，我們繼承了泛型類AbstractHttpMessageConverter，并重寫了它的幾個方法。

supports：設(shè)置處理哪些類。
readInternal：處理輸入內(nèi)容，即處理請求值。
writeInternal：處理輸出內(nèi)容，即處理返回值。

構(gòu)造方法定義了要處理的MediaType，這里我定義的是application/base64obj;charset=utf-8，接下來在Controller中也要用到這個MediaType

上面我自定義的消息轉(zhuǎn)換器處理的是Object類型，你也可以指定泛型為特定的類型，只處理該種類型的數(shù)據(jù)。

將自定義的消息轉(zhuǎn)換器加入到springmvc容器中

這里采用配置類的形式

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration
public class MessageConverterConfig implements WebMvcConfigurer {

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(base64ObjMessageConverter());
    }

    @Bean
    public Base64ObjMessageConverter base64ObjMessageConverter() {
        return new Base64ObjMessageConverter();
    }
}

Controller代碼

@PostMapping(value = "base64obj",  consumes = "application/base64obj;charset=utf-8",produces = "application/base64obj;charset=utf-8")
    public User base64obj(@RequestBody User user) {
        System.out.println(user);
        return user;
    }

我們可以通過設(shè)置consumes和produces來讓springmvc采用不同的消息轉(zhuǎn)換器處理我們的請求。

我們的測試代碼設(shè)置的@PostMapping的屬性consumers和produces都為我們的自定義的消息處理器要處理的類型application/base64obj;charset=utf-8。

即請求和返回都需要經(jīng)過自定義消息處理器Base64ObjMessageConverter的處理。

注意：

我們可以將consumers和produces設(shè)置為不同的MediaType來讓不同的消息轉(zhuǎn)換器來處理，但是開發(fā)中一般不會這么做。
比如輸入的格式是XML，返回的格式確實(shí)JSON，這樣做是很逆天的。
consumers和produces一般都會采用相同的MediaType。