Spring Boot不使用配置的Jackson ObjectMapper和@enableWebMVC

Question

我想在我的项目中使用JacksonObjectMapper的配置版本（忽略空值和snake_case，也使用一些自定义模块）。

在我的大型项目中，我无法让Spring MVC真正使用这个映射器。

buildscript {
  ext {
    springBootVersion = '1.5.6.RELEASE'
  }
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
  }
}

apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'

version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
  mavenCentral()
}

dependencies {
  compile('org.springframework.boot:spring-boot-starter')
  compile("org.springframework.boot:spring-boot-starter-jetty:${springBootVersion}")
  compile("org.springframework.boot:spring-boot-starter-web:${springBootVersion}")

  compile group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.8.8'
  compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.8.8'

  testCompile('org.springframework.boot:spring-boot-starter-test')
}

spring:
  application:
  name: Jackson test
jackson:
  property-naming-strategy: SNAKE_CASE
  default-property-inclusion: non_empty
debug: true

public class MyLocationEntity {
    public String nameAndSnake;
}

@Configuration
@EnableWebMvc
public class AppConfig {
}

@RestController
@RequestMapping("/test")
public class TestController {

  @Autowired
  private ObjectMapper objectMapper;

  @RequestMapping(value = "/test", produces = "application/json")
  public MyLocationEntity test() throws JsonProcessingException {
    MyLocationEntity location = new MyLocationEntity();
    location.nameAndSnake = "hello world";
    String expexted = objectMapper.writeValueAsString(location);
    return location;
  }
}

如果我现在查看调试器中expected的值，它是{“name_and_snake”：“hello world”}。但是如果我让控制器运行，实际的响应是{“nameandsnake”：“hello world”}。

当我删除@enableWebMVC时，它就可以工作了。如何将配置的映射器与MVC一起使用，而不删除Web MVC的其余自动配置？

Answer 1

这不仅从Javadocs中可以看出，而且@enableWebMVC禁用了由WebMVcautoConfiguration提供的Spring Boot默认web MVC自动配置，包括使用由application.yml属性配置的JacksonObjectMapperbean。根据Spring Boot参考文档：

完全控制MVC配置的最简单方法是使用@enableWebMVC注释提供您自己的@configuration。这样做将所有MVC配置都掌握在您的手中。

因此，必须手动配置MVC配置，以便将Spring Bootapplication.yml属性与@enableWebMVC注释协同使用。对此有几种不同的可能方法。

第一种方法是从webmvcautoconfiguration.enablewebmvcconfiguration.configureMessageConverters()复制Spring Boot配置代码。这将用默认Spring Boot配置中使用的消息转换器替换消息转换器-- 包括MappingJackson2HttpMessageConverter，其中包含未配置的ObjectMapper- ：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private ObjectProvider<HttpMessageConverters> messageConvertersProvider;

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        this.messageConvertersProvider
                .ifAvailable((customConverters) -> converters.addAll(customConverters.getConverters()));
    }
}

或者，不使用消息转换器的默认Spring Boot列表，也可以只交换Spring Boot提供的ObjectMapper或MappingJackson2HttpMessageConverterbean（它们应用了application.yml属性）：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.stream()
                .filter(c -> c instanceof MappingJackson2HttpMessageConverter)
                .map(c -> (MappingJackson2HttpMessageConverter) c)
                .forEach(c -> c.setObjectMapper(objectMapper));

    }
}

或

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Autowired
    private MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter;

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        for (int i = 0; i < converters.size(); i++) {
            if (converters.get(i) instanceof MappingJackson2HttpMessageConverter) {
                converters.set(i, mappingJackson2HttpMessageConverter);
            }
        }
    }
}