En mi aplicación Spring Boot, quiero que se creen beans solo si un módulo no está habilitado.
En CoreConfig, he definido dos beans (geocodificador y travelDistanceCalculator) anotados con @ConditionalOnMissingBean referencia a las interfaces que esos beans deben inicializar.
@Configuration class CoreConfig { private val logger = loggerFor<CoreConfig>() @Bean @ConditionalOnMissingBean(Geocoder::class) fun geocoder(): Geocoder { logger.warn("no Geocoder bean instance has been provided. Instantiating default.") return object : Geocoder { override fun getGeocode(address: String) = Coordinates.Unavailable } } @Bean @ConditionalOnMissingBean(TravelDistanceCalculator::class) fun travelDistanceCalculator(): TravelDistanceCalculator { logger.warn("no TravelDistanceCalculator bean instance has been provided. Instantiating default.") return object : TravelDistanceCalculator { override fun getTravelDistanceInKm(origin: Coordinates, destination: Coordinates) = Double.NaN } } // other beans definitions... }Luego, GeolocationConfig define un bean (HereApiClient) que implementa las interfaces Geocoder y TravelDistanceCalculator.
@Configuration @ConditionalOnProperty("app.geolocation.enable") class GeolocationConfig { @Bean fun hereApiClient( geolocationProperties: GeolocationProperties, restTemplate: RestTemplate ): HereApiClient = HereApiClient(restTemplate, geolocationProperties) } app.geolocation.enable se define como true en application.yml.
Lo que sucede aquí es que, en el inicio, los beans predeterminados de geocodificador y travelDistanceCalculator definidos en CoreConfig se inicializan incluso si GeolocationConfig está habilitado y HereApiClient se inicializa poco después de ellos.
¿Que me estoy perdiendo aqui?
ConditionalOnMissingBean depende del orden en que se procesan las clases @Configuration y se definen sus beans. En su ejemplo, sospecho que se está procesando CoreConfig , se están evaluando sus condiciones y se han definido sus beans antes de que se haya definido su bean hereApiClient . Como resultado, cuando se evalúan las condiciones del bean faltante, no se encuentra ningún bean coincidente y se definen los beans geocoder y travelDistanceCalculator .
El javadoc para ConditionalOnMissingBean hace la siguiente recomendación:
La condición solo puede coincidir con las definiciones de beans que han sido procesadas por el contexto de la aplicación hasta el momento y, como tal, se recomienda enfáticamente usar esta condición solo en las clases de configuración automática. Si se puede crear un bean candidato mediante otra configuración automática, asegúrese de que el que utiliza esta condición se ejecute después.
Puede seguir esta recomendación usando @Order en sus clases de configuración. Alternativamente (y preferiblemente, en mi opinión) podría hacer CoreConfig una clase de configuración automática al incluirlo en META-INF/spring.factories bajo la clave org.springframework.boot.autoconfigure.EnableAutoConfiguration y moverlo a un paquete donde no ser recogido por el escaneo de componentes.
@ConditionalOn(Missing)Bean está diseñado para usarse en clases de configuración automática. ver javadoc Si se usa en clases de configuración comunes, el resultado depende de la configuración que se cargue primero. Ver la respuesta de andy-wilkinson
En su caso, podría usar fácilmente la misma propiedad (que ya está proporcionando) para configurar los beans correctos.
Use @ConditionalOnProperty(name="app.geolocation.enable") en GeolocationConfig
Use @ConditionalOnProperty(name="app.geolocation.enable",havingValue="false") en/en CoreConfig
EDITAR
Use @ConditionalOnProperty(name="app.geolocation.enable",havingValue="false",matchIfMissing = true) si desea que se use CoreConfig si falta la propiedad.