messageConverter应用

在springmvc和springboot中，均默认采用MappingJackson2HttpMessageConverter来实现JSON数据的处理，那么我们是否可以通过其他转换器实现呢？可以的，本章将通过GsonHttpMessageConverter来诠释messageConverter在springboot中的灵活应用。

本章概要

---

1、如何实现GsonHttpMessageConverter作为默认的JSON数据转换；

2、如何扩展实现系统默认的GsonHttpMessageConverter；

3、多样化的转换器装载；

如何实现GsonHttpMessageConverter作为默认的JSON数据转换

---

默认设置下，参看 HttpMessageConvertersAutoConfiguration  源码优先加载的是MappingJackson2HttpMessageConverter来处理JSON，故所有的@responseboby均通过此HttpMessageConverter来进行json数据转换。

那么如果我们需要采用GsonHttpMessageConverter如何处理呢，先根据源码可以发现，注册MappingJackson2HttpMessageConverter的bean对象前提是 @ConditionalOnClass({ObjectMapper.class})，那么如果我们的类路径下没有ObjectMapper.class即可，故根据pom文件找到jackson-databind依赖，不加载对应的jar文件即可。同时也需要添加gson对应的依赖加载。

此时默认加载如下

其实我们也可以根据源码发现，如果我们需要添加自定义的HttpMessageConverter，则需要的就是注册一个返回类型为HttpMessageConverter的bean对象即可，此时我们就是取消了一个bean实例的创建。

注意：在实验过程中发现如果取消了databind依赖的载入，则spring-boot-starter-actuator自动载入也会出现异常，两者之前有强依赖，故同时也只能注释掉spring-boot-starter-actuator的载入，暂时不用监控功能。

如何扩展实现系统默认的GsonHttpMessageConverter

---

1、扩展实现GsonHttpMessageConverter

package com.shf.springboot.config;

import java.io.IOException;

import java.lang.reflect.Type;

import org.springframework.http.HttpInputMessage;

import org.springframework.http.HttpOutputMessage;

import org.springframework.http.converter.HttpMessageNotReadableException;

import org.springframework.http.converter.HttpMessageNotWritableException;

import org.springframework.http.converter.json.GsonHttpMessageConverter;

/**

* 扩展GsonHttpMessageConverter

* @author song

*

*/

public class GsonHttpMessageConverterExt extends GsonHttpMessageConverter {

@Override

protected Object readInternal(Class<? extends Object> paramClass, HttpInputMessage paramHttpInputMessage)

throws IOException, HttpMessageNotReadableException {

System.out.println("通过GsonHttpMessageConverterExt处理");

return super.readInternal(paramClass, paramHttpInputMessage);

}

@Override

protected void writeInternal(Object o, Type type, HttpOutputMessage outputMessage)

throws IOException, HttpMessageNotWritableException {

System.out.println("通过GsonHttpMessageConverterExt处理");

super.writeInternal(o, type, outputMessage);

}

}

目前通过使用过程中打印信息来获取是否正常采用我们自定义的扩展GsonHttpMessageConverter。其中readInternal处理请求的数据，writeInternal如何输出数据到response。

2、考虑到目前我们采用springmvc的配置，在xml配置的时候我们在其中配置过messageconverter，那么现在我们通过java配置重新实现， 编写一个MvcConfiguration配置类，该配置类需要实现WebMvcConfigurerAdapter接口，从而该配置类其实就是我们之前一直使用的spring-mvc.xml文件：

package com.shf.springboot.config;

import java.util.List;

import org.springframework.context.annotation.Configuration;

import org.springframework.http.converter.HttpMessageConverter;

import org.springframework.http.converter.json.GsonHttpMessageConverter;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration

@EnableWebMvc

public class MvcConfiguration extends WebMvcConfigurerAdapter {

/**

* 重写configureMessageConverters方法替换所有默认的MessageConverters，使用自定义添加converters

*/

// @Override

// public void configureMessageConverters(List<HttpMessageConverter < ? >> converters) {

// GsonHttpMessageConverterExt gsonHttpMessageConverter = new GsonHttpMessageConverterExt();

// converters.add(gsonHttpMessageConverter);

// }

/**

* 在系统原有默认的MessageConverters基础上继续添加自定义的converters实例

*/

@Override

public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {

//保存系统原GsonHttpMessageConverter类型的HttpMessageConverter集合

List<GsonHttpMessageConverter> originalConverters=new ArrayList<GsonHttpMessageConverter>(2);

for(int i=0;i<converters.size();i++){

if(converters.get(i) instanceof GsonHttpMessageConverter){

originalConverters.add((GsonHttpMessageConverter) converters.get(i));

}

}

//如果存在则移除

if(originalConverters!=null&&originalConverters.size()>0)

converters.removeAll(originalConverters);

//添加扩展

converters.add(gsonHttpMessageConverterExt());

System.out.println(converters.size());

}

@Bean

@ConditionalOnMissingBean

@ConditionalOnClass(value={GsonHttpMessageConverterExt.class})

public GsonHttpMessageConverterExt gsonHttpMessageConverterExt(){

return new GsonHttpMessageConverterExt();

}

}

可以看到其中有两个方法：

2.1、 configureMessageConverters：该方法会替换所有默认的MessageConverters，使用自定义添加converters；不适合我们目前的场景，在实际项目中应用比例也比较小；

2.2、 extendMessageConverters：该方法在系统原有的MessageConverters的基础上继续扩展我们自定义添加的MessageConverters；

本案例的实现有一个基础， 目前已经排除了采用MappingJackson2HttpMessageConverter，且默认采用的是GsonHttpMessageConverter。那么既然我们扩展了，就希望使用我们自定义的MessageConverter。但由于Gson.class一定在类路径下，那么GsonHttpMessageConverter会自动被创建，此时我们再次添加，根据优先加载的规则，系统使用的还是默认的GsonHttpMessageConverter，并非我们的扩展，故我们需要删除系统默认的GsonHttpMessageConverter。

我们来看下MessageConverter加载过程：

默认加载

删除后：

添加自定义：

3、编写一个控制器，来返回一个json格式的map对象

package com.shf.SpringBoot1;

import java.util.HashMap;

import java.util.Map;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

@RequestMapping(value="/converter")

public class ConverterTestController {

@RequestMapping("/testGson")

public Map<String,String> testGson(){

Map<String,String> map=new HashMap<String,String>();

map.put("name", "aaa");

map.put("age", "12");

return map;

}

}

4、通过浏览器访问我们的请求地址 http://localhost:8083/converter/testGson，查看打印内容：

验证成功！

关注几个之前没有出现过的注解：

@EnableWebMvc：在配置类中通过@EnableWebMvc注解来实现完全自己控制的MVC的java配置类；

@ConditionalOnMissingBean：当容器下没有对应的bean的情况下；

@ConditionalOnClass：当类路径下有指定类的条件下；

在spingboot下还有很多类似条件组合注解，都是组合了@Conditional的元注解

多样化转换器装配

---

A：突然有个想法，我们的两种json转换器是否能够 并存呢，那么如果我们需要两个HttpMessageConverter均存在，如何实现呢？

1、第一步先把之前注释掉的jackson-databind依赖加入POM文件：

在上述扩展的基础上，我们继续跟踪所有的HttpMessageConverter加载过程

默认加载：

此时并不会存在GsonHttpMessageConverter，下一步我们添加自定义扩展的GsonHttpMessageConverterExt：

加入成功，那么我们此时也加入GsonHttpMessageConverter呢

并存使用成功。

在 HttpMessageConverters 默认的行为规则中，会优先采用先加载的HttpMessageConverter实例，故会优先采用MappingJackson2HttpMessageConverter进行转换处理。

B：以上的方式主要采用了实现 WebMvcConfigurerAdapter接口中extendMessageConverters方法扩展实现，其实我们也完全可以通过configureMessageConverters方法来实现共存，前提是我们需要根据springboot的提供的java配置来优先加载bean实例：

1、通过Java配置类注册HttpMessageConverters 类型的bean实例：

package com.shf.springboot.config;

import java.util.ArrayList;

import java.util.Collection;

import org.springframework.boot.autoconfigure.web.HttpMessageConverters;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.http.converter.HttpMessageConverter;

import org.springframework.http.converter.json.GsonHttpMessageConverter;

@Configuration

public class ConverterConfiguration {

@Bean

public HttpMessageConverters customConverters() {

Collection<HttpMessageConverter<?>> messageConverters = new ArrayList<>();

GsonHttpMessageConverter gsonHttpMessageConverter = new GsonHttpMessageConverter();

messageConverters.add(new GsonHttpMessageConverterExt());

messageConverters.add(gsonHttpMessageConverter);

return new HttpMessageConverters( true, messageConverters);

}

}

此构造函数new HttpMessageConverters( true, messageConverters);表示追加springboot默认已经给提供的HttpMessageConverter，故我们可以在第2步中通过configureMessageConverters中配置，不会丢失系统默认部分。同时我们自定义的MessageConverters会优先加载，也便于后续真正起作用的也是我们自定义的MessageConverters。

2、在webmvc配置类中定义如下：

package com.shf.springboot.config;

import java.util.ArrayList;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

import org.springframework.boot.autoconfigure.web.HttpMessageConverters;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.http.converter.HttpMessageConverter;

import org.springframework.http.converter.json.GsonHttpMessageConverter;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration

@EnableWebMvc

public class MvcConfiguration extends WebMvcConfigurerAdapter {

@Autowired

HttpMessageConverters customConverters;

/**

* 重写configureMessageConverters方法替换所有默认的MessageConverters，使用自定义添加converters

*/

@Override

public void configureMessageConverters(List<HttpMessageConverter < ? >> converters) {

converters.addAll(customConverters.getConverters());

System.out.println(converters.size());

}

}

3、此时我们来跟踪加载情况：

4、通过信息的打印查看是否使用我们自定义的JSON处理转换：

5、验证成功，确实是我们自定义的转换器。

C：通过继续的实验，发现如果我们没有特别的需求，不定义webmvc的情况下，是否也能满足我们自定义JSON转换器的使用呢，答案也是肯定的。我们直接删除MvcConfiguration类，仅仅通过ConverterConfiguration 配置类定义bean：

package com.shf.springboot.config;

import java.util.ArrayList;

import java.util.Collection;

import org.springframework.boot.autoconfigure.web.HttpMessageConverters;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.http.converter.HttpMessageConverter;

import org.springframework.http.converter.json.GsonHttpMessageConverter;

@Configuration

public class ConverterConfiguration {

@Bean

public HttpMessageConverters customConverters() {

Collection<HttpMessageConverter<?>> messageConverters = new ArrayList<>();

GsonHttpMessageConverter gsonHttpMessageConverter = new GsonHttpMessageConverter();

messageConverters.add(new GsonHttpMessageConverterExt());

messageConverters.add(gsonHttpMessageConverter);

return new HttpMessageConverters(true, messageConverters);

}

}

通过请求查看打印信息：

同样成功。从而说明，在springboot中，自定义的HttpMessageConverter通过配置类实现bean注册即可简洁的实现。