如何声明另一个Jackson ObjectMapper而不影响'客户'原始豆?

时间:2017-05-26 06:28:03

标签: java spring spring-boot dependency-injection jackson

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

现在我需要从yaml文件中读取一些数据,我发现一个简单的方法是使用Jackson - 为此我需要声明一个不同的ObjectMapper来将yaml转换为对象。我声明这个新的mapper bean有一个特定的名称,可以在我的服务中注入它来处理从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);
    }
    ...
}

然后在我的Configuration类中,我将其声明为@Primary bean,以确保它是自动装配的首选:

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

尽管如此,我对此解决方案并不是百分之百满意,因为它依赖于不受我控制的bean的名称,而且它看起来也像是一个黑客。有更清洁的解决方案吗?

谢谢!

4 个答案:

答案 0 :(得分:3)

您可以定义两个ObjectMapper bean并将其声明为primary,例如:

@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);
    }
}

上面的代码将新bean添加到context而不更改现有bean(sysoutinit方法的末尾打印两个bean)。然后,您可以使用“yamlMapper”作为限定符,在任何地方自动装配它。

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

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

@Autowired
private DefaultListableBeanFactory beanFactory;

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

答案 1 :(得分:1)

其他选项是将自定义映射器包装到自定义对象中:

@Component
public class YamlObjectMapper {
    private final ObjectMapper objectMapper;

    public YamlObjectMapper() {
        objectMapper = new ObjectMapper(new YAMLFactory());
    }

    public ObjectMapper getMapper() {
        return objectMapper;
    }
}

不幸的是,这种方法需要在您注入getMapper后调用YamlObjectMapper

答案 2 :(得分:0)

我认为为MVC层定义显式主对象映射器应该这样工作:

 @Primary
 @Bean
 public ObjectMapper objectMapper() {
     return Jackson2ObjectMapperBuilder.json().build();
 }

通过类型自动装配对象映射器的所有bean都将使用上面的bean。您的Yaml逻辑可以通过YAML_OBJECT_MAPPER_BEAN_ID自动装配。

答案 3 :(得分:0)

我刚才意识到我不需要使用FactoryBean,我也可以将常规bean声明为@Primary并让它返回原始bean,如下所示:

@Bean
@Primary
public ObjectMapper objectMapper(@Qualifier("_halObjectMapper") ObjectMapper objectMapper) {
    return objectMapper;
}

这使配置稍微清晰,但仍需要原始ObjectMapper的确切名称。不过,我想我会继续使用这个解决方案。