如何获取 Spring 4.1 使用的 Jackson ObjectMapper？

Question

Spring 4.1 实例化了一个 Jackson ObjectMapper 实例。我有理由想将 @Autowire 该实例放入我的一个控制器中：控制器使用 Jackson 对自己的一些次要 JSON 解析，但它使用的 ObjectMapper 应该是 Spring 本身正在使用的同一个实例。我该如何实现呢？

请注意，我不是在问如何自定义配置 Spring 使用的 ObjectMapper；我对默认设置很满意。我只是想把 Spring 使用的实例捞出来，这样我就可以在自己的代码中重用现有的实例。

Answer 1

如果您在类路径上使用 Spring Boot 和 Jackson，并在 REST 控制器中使用 JSON 解析的默认实现，那么这应该可以：

@Autowired
private ObjectMapper jacksonObjectMapper;

Answer 2

正如其他人所说，您不能将@Autowired 直接放入您的控制器中。

@Emerson Farrugia 建议使用

创建一个新实例

Jackson2ObjectMapperBuilder.json().build()

也对我不起作用，因为获得的实例没有遵循我需要的 spring.jackson.* 配置属性。

---

我找到的解决方案是从 Spring 的 MappingJackson2HttpMessageConverter 获取 ObjectMapper，它是可注入的。

所以我自动接线：

@Autowired
private MappingJackson2HttpMessageConverter springMvcJacksonConverter;

然后像这样从中获取 ObjectMapper：

ObjectMapper objectMapper = springMvcJacksonConverter.getObjectMapper();

这个实例的行为与 Spring MVC 自己的消息转换完全一样 - 它可能 是 无论如何都是同一个实例。

Answer 3

如果您查看MappingJackson2HttpMessageConverter，您会看到它创建了一个新的ObjectMapper，但并未将其公开为一个bean。有一个吸气剂，但我过去找出它的唯一方法是我自己创建MappingJackson2HttpMessageConverter，例如

public class WebMvcConfiguration extends WebMvcConfigurerAdapter {

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

        MappingJackson2HttpMessageConverter jacksonMessageConverter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = jacksonMessageConverter.getObjectMapper();

        objectMapper.registerModule(new JodaModule());
        objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, true);

        converters.add(jacksonMessageConverter);
    }
}

如果您使用 Spring Boot，则手册中有一个 section 专门用于使用 ObjectMapper 如果您创建默认 Jackson2ObjectMapperBuilder @Bean，您应该能够自动连接相同的 @987654329 @ 控制器中的实例。

Answer 4

ObjectMapper 由Jackson2ObjectMapperBuilder 创建，您可以使用以下方法注入构建器：

@Autowired
private Jackson2ObjectMapperBuilder mapperBuilder;

然后使用mapperBuilder.build()构建一个ObjectMapper实例，这个实例可以使用application.properties中的配置。 Official doc here.

Answer 5

我调试了Spring Boot的源代码，发现只有当我们启动整个上下文Jackson2ObjectMapperBuilder时，才会包含我们放入application.yml的配置。

这意味着，如果我们想在 Spring Boot 测试中使用 JUnit 5 生成 ObjectMapper，我们必须：

@ExtendWith(SpringExtension.class)
@SpringBootTest
class SomeTest {
    @Autowired
    private Jackson2ObjectMapperBuilder builder;
    ...

    @Test
    void testObjectMapper() {
        ObjectMapper mapper = builder.build();


    }

我们不能只让@SpringBootTest(classes = Jackson2ObjectMapperBuilder.class) 来生成这个构建器。

当我们bootRun 时我们没有这个问题。

配置在Jackson2ObjectMapperBuilderCustomizerConfiguration#customize(Jackson2ObjectMapperBuilder builder) 方法中设置。

Answer 6

当您尝试 @Autowire MappingJackson2HttpMessageConverter 时，它会为您提供： No qualifying bean of type 'org.springframework.http.converter.json.MappingJackson2HttpMessageConverter' available: expected single matching bean but found 4: mappingJackson2HttpMessageConverter,jacksonHttpMessageConverter,halJacksonHttpMessageConverter,alpsJsonHttpMessageConverter.

这不是一个大问题，您只需将变量名称更改为上述之一即可获取该实例： @Autowired private MappingJackson2HttpMessageConverter halJacksonHttpMessageConverter;

Answer 7

如果你愿意，可以分两步；

1. 在您的 @SpringBootApplication 课程中，添加：

   @Bean
   public ObjectMapper mapper() {
     return new ObjectMapper();
   }
   

2. 任何你想使用的地方ObjectMapper:

   @Autowired
   ObjectMapper mapper;
   

和平！