VOOZH about

URL: https://www.javacodegeeks.com/2019/01/spring-boot-overriding-bean-definition.html

⇱ Spring-Boot 2.1.x and overriding bean definition - Java Code Geeks


I was recently migrating an application from Spring Boot 1.5.X to Spring Boot 2.X and saw an issue with overriding Spring Bean definitions. One of the configurations was along these lines in Kotlin:

@Configuration
class DynamoConfig {

 @Bean
 fun dynamoDbAsyncClient(dynamoProperties: DynamoProperties): DynamoDbAsyncClient {
 ...
 }

 @Bean
 fun dynampoDbSyncClient(dynamoProperties: DynamoProperties): DynamoDbClient {
 ...
 }
}

Now, for a test I wanted to override these 2 bean definitions and did something along these lines:

@SpringBootTest
class DynamoConfigTest {

 @Test
 fun saveHotel() {
 val hotelRepo = DynamoHotelRepo(localDynamoExtension.asyncClient!!)
 val hotel = Hotel(id = "1", name = "test hotel", address = "test address", state = "OR", zip = "zip")
 val resp = hotelRepo.saveHotel(hotel)

 StepVerifier.create(resp)
 .expectNext(hotel)
 .expectComplete()
 .verify()
 }


 @TestConfiguration
 class SpringConfig {
 @Bean
 fun dynamoDbAsyncClient(dynamoProperties: DynamoProperties): DynamoDbAsyncClient {
 ...
 }

 @Bean
 fun dynamoDbSyncClient(dynamoProperties: DynamoProperties): DynamoDbClient {
 ...
 }
 }
}

This type of overriding works with Spring Boot 1.5.X but fails with Spring Boot 2.1.X with an error:

Invalid bean definition with name 'dynamoDbAsyncClient' defined in sample.dyn.repo.DynamoConfigTest$SpringConfig:.. 
There is already .. defined in class path resource [sample/dyn/config/DynamoConfig.class]] bound

I feel this behavior is right, not allowing beans to overridden this way is the correct default behavior for an application, however I do want the ability to override the beans for tests and thanks to a Stack Overflow answer and Spring Boot 2.1.X release notes, the fix is to allow overrides using a property β€œspring.main.allow-bean-definition-overriding=true”, so with this change, the test looks like this:

@SpringBootTest(properties = ["spring.main.allow-bean-definition-overriding=true"])
class DynamoConfigTest {

 @Test
 fun saveHotel() {
 val hotelRepo = DynamoHotelRepo(localDynamoExtension.asyncClient!!)
 val hotel = Hotel(id = "1", name = "test hotel", address = "test address", state = "OR", zip = "zip")
 val resp = hotelRepo.saveHotel(hotel)

 StepVerifier.create(resp)
 .expectNext(hotel)
 .expectComplete()
 .verify()
 }


 @TestConfiguration
 class SpringConfig {
 @Bean
 fun dynamoDbAsyncClient(dynamoProperties: DynamoProperties): DynamoDbAsyncClient {
 ...
 }

 @Bean
 fun dynamoDbSyncClient(dynamoProperties: DynamoProperties): DynamoDbClient {
 ...
 }
 }
}

Published on Java Code Geeks with permission by Biju Kunjummen, partner at our JCG program. See the original article here: Spring-Boot 2.1.x and overriding bean definition

Opinions expressed by Java Code Geeks contributors are their own.

Do you want to know how to develop your skillset to become a Java Rockstar?
Subscribe to our newsletter to start Rocking right now!
To get you started we give you our best selling eBooks for FREE!
1. JPA Mini Book
2. JVM Troubleshooting Guide
3. JUnit Tutorial for Unit Testing
4. Java Annotations Tutorial
5. Java Interview Questions
6. Spring Interview Questions
7. Android UI Design
and many more ....
I agree to the Terms and Privacy Policy

Thank you!

We will contact you soon.

πŸ‘ Photo of Biju Kunjummen
Biju Kunjummen
January 22nd, 2019Last Updated: January 22nd, 2019
0 1,433 1 minute read
Subscribe

This site uses Akismet to reduce spam. Learn how your comment data is processed.

0 Comments
Oldest
Newest Most Voted
Back to top button
Close
wpDiscuz