java - 如何在不影响原始 bean 的 'clients' 的情况下声明另一个 Jackson ObjectMapper？

Question

我有一个公开 json REST API 的 spring-boot 应用程序。为了将对象映射到 json，它使用由 spring-boot 配置的内置 jackson ObjectMapper。

现在我需要从 yaml 文件中读取一些数据，我发现一种简单的方法是使用 Jackson - 为此我需要声明一个不同的 ObjectMapper 来将 yaml 转换为对象。我用一个特定的名称声明了这个新的映射器 bean，以便能够将它注入(inject)到我处理从 yaml 文件读取的服务中:

@Bean(YAML_OBJECT_MAPPER_BEAN_ID)
public ObjectMapper yamlObjectMapper() {
    return new ObjectMapper(new YAMLFactory());
}

但我需要一种方法来告诉原始 json ObjectMapper 的所有其他“客户端”继续使用该 bean。所以基本上我需要在原始 bean 上添加一个 @Primary 注释。有没有一种方法可以实现这一点，而不必在我自己的配置中重新声明原始 ObjectMapper(我必须深入挖掘 spring-boot 代码才能找到并复制其配置)？

我找到的一个解决方案是为 ObjectMapper 声明一个 FactoryBean 并使其返回已声明的 bean，如 this answer 中所建议的那样.我通过调试发现我原来的bean叫“_halObjectMapper”，所以我的factoryBean会搜索这个bean并返回:

public class ObjectMapperFactory implements FactoryBean<ObjectMapper> {

    ListableBeanFactory beanFactory;

    public ObjectMapper getObject() {
        return beanFactory.getBean("_halObjectMapper", ObjectMapper.class);
    }
    ...
}

然后在我的配置类中，我将它声明为 @Primary bean 以确保它是 Autowiring 的首选:

@Primary
@Bean
public ObjectMapperFactory objectMapperFactory(ListableBeanFactory beanFactory) {
    return new ObjectMapperFactory(beanFactory);
}

不过，我对这个解决方案并不是 100% 满意，因为它依赖于不受我控制的 bean 的名称，而且它看起来也像是 hack。有更清洁的解决方案吗？

谢谢!

Answer 1

您可以定义两个 ObjectMapper bean 并将其中一个声明为主要 bean，例如:

@Bean("Your_id")
public ObjectMapper yamlObjectMapper() {
    return new ObjectMapper(new YAMLFactory());
}

@Bean
@Primary
public ObjectMapper objectMapper() {
    return new ObjectMapper();
}

完成后，您可以使用带有 @Qualifier 注释的 objectmapper bean，例如:

@Autowired
@Qualifier("Your_id")
private ObjectMapper yamlMapper;

更新

您可以在运行时动态地将您的 ObjectMapper 添加到 Spring 的 bean 工厂，例如:

@Configuration
public class ObjectMapperConfig {

    @Autowired
    private ConfigurableApplicationContext  context;

    @PostConstruct
    private void init(){
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(ObjectMapper.class);
        builder.addConstructorArgValue(new JsonFactory());
        DefaultListableBeanFactory factory = (DefaultListableBeanFactory) context.getBeanFactory();
        factory.registerBeanDefinition("yamlMapper", builder.getBeanDefinition());
        Map<String, ObjectMapper> beans = context.getBeansOfType(ObjectMapper.class);
        beans.entrySet().forEach(System.out::println);
    }
}

上面的代码在context中添加了一个新的bean而不改变现有的bean(sysout在init方法的末尾打印了两个bean) .然后，您可以使用“yamlMapper”作为限定符在任何地方 Autowiring 它。

更新 2(来自问题作者):

“更新”中建议的解决方案有效，这里是一个简化版本:

@Autowired
private DefaultListableBeanFactory beanFactory;

@PostConstruct
private void init(){
    BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(YAMLMapper.class);
    beanFactory.registerBeanDefinition("yamlMapper", builder.getBeanDefinition());
}