在@Configuration bean中引用SpEL表达式中的ConfigurationProperties Beans

Question

我有这个属性类：

import java.util.List;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("some")
    public class SomeProperties {
        private List<String> stuff;

        public List<String> getStuff() {
            return stuff;
        }

        public void setStuff(List<String> stuff) {
            this.stuff = stuff;
        }    
    }

我在@Configuration类中启用配置属性，如下所示：

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(SomeProperties.class)
public class SomeAutoConfiguration {    
}

在同一个类（“SomeAutoConfiguration”）中，我想创建另一个bean，具体取决于SomeProperties中的list属性是否为空。我以为我可以使用@ConditionalExpression和以下SpEl：

@Bean
@ConditionalOnExpression("!(#someProperties.stuff?.isEmpty()?:true)")   
    public Object someBean(final SomeProperties someProperties) {
    return new Object();
}    

SpEl是正确的，但我无法控制包含我的属性的bean。使用上面的表达式我遇到了

EL1007E：（pos 43）：在null上找不到属性或字段'stuff'

并尝试通过它的名称来获取bean

@Bean
@ConditionalOnExpression("!(@'some.CONFIGURATION_PROPERTIES'.stuff?.isEmpty()?:true)")  
    public Object someBean(final SomeProperties someProperties) {
    return new Object();
} 

最终进入

NoSuchBeanDefinitionException：未定义名为“some.CONFIGURATION_PROPERTIES”的bean

有任何想法吗？我已经尝试在另一个类中启用ConfigurationProperties，但这也不起作用。

Answer 1

我认为你所面临的问题是@Conditions在@Configuration类被解析时被评估，所以没有任何保证已经定义了SomeProperties bean。即使它被定义了，你可能不希望它提前初始化，所以我建议采用不同的方法。

您可以尝试@ConditionalOnPropety，这是Spring Boot内部使用的注释，只要它有条件地想要基于属性启用自动配置。如果这不够灵活，你可以创建自己的Condition并直接访问Environment来判断属性值是否为空。如果您想支持灵活绑定，可以使用RelaxedPropertyResolver。 Here's an example。

Answer 2

为了补充关于Spring Boot 2+的@PhilWebb答案，RelaxedPropertyResolver已经被删除，有利于更强大的替代品Binder。这是一个非常简单的例子：

@Configuration
@AutoConfigureBefore(JacksonAutoConfiguration.class)
@ConditionalOnMissingBean(ObjectMapper.class)
@Conditional(SpringJacksonPropertiesMissing.class)
public class ObjectMapperConfiguration {
    @Bean
    public ObjectMapper objectMapper() {
        return new ObjectMapper()
                .disable(FAIL_ON_UNKNOWN_PROPERTIES)
                .setSerializationInclusion(JsonInclude.Include.NON_NULL);
    }

    static class SpringJacksonPropertiesMissing extends SpringBootCondition {
        @Override
        public ConditionOutcome getMatchOutcome(ConditionContext context,
                                                AnnotatedTypeMetadata metadata) {
            return new ConditionOutcome(hasJacksonPropertiesDefined(context),
                                        "Spring Jackson property based configuration missing");
        }

        private boolean hasJackonPropertiesDefined(ConditionContext context) {
            return Binder.get(context.getEnvironment())
                         .bind(ConfigurationPropertyName.of("spring.jackson"),
                                                Bindable.of(Map.class))
                         .orElse(Collections.emptyMap())
                         .isEmpty();
        }
    }
}

免责声明：此代码用于淘汰关于jackson对象映射器的一些不良做法，以便将一些代码转换为spring boot way to configure an object mapper。