Creating Spring Bean dynamically in the Runtime

After 5 years it seems that this article in my blog is the most popular one, over 9,300 page views. So, it’s time to update this article. I also added a Github example for this article.

Image for post
Image for post
The Example springbean-dynamic at Github

In my training someone asked me whether it is possible to create an object (a Spring Bean) dynamically so you can choose which implementation you want to have in the runtime. So at the compile time you don’t know what object actually should be created yet. The application should decide what object to be created based on a properties file.

1. We create an annotation so we can mark the method which should be able to create the object dynamically:

package your.package;

public @interface InjectDynamicObject {

2. Use the new created annotation in your method which should be able to create the object dynamically:

public class CustomerServiceImpl {

3. Write an aspect with Pointcut and Advise which change the object returned by the method in the step 2:

public class DynamicObjectAspect {
// This comes from the property file
private String object;

4. Write your class which should be returned back from the @InjectDynamicObject. The name is configured in a properties file. In this example I wrote two different Customer implementation: CustomerOneImpl and CustomerTwoImpl:

public class CustomerOneImpl implements Customer {

5. Write your unit test to test the method:

public class CustomerServiceImplTest {

OK, there is another easier way to do this 😃 Without Aspects and AspectJ, just pure Spring:

Just inject all your component implementations into a Map and get the correct implementation out of it. Just like what we have done in eXTra Client application. Please take a look at our implementation of PluginsLocatorManager as an example. Spring injects the Map with Bean name as String and the Bean itself automagically.

“… Even typed Maps can be autowired as long as the expected key type is String. The Map values will contain all beans of the expected type, and the keys will contain the corresponding bean names” (see Spring documentation for details).

public class CustomerServiceImpl {

// We inject the customer implementations into a Map
private Map<String, Customer> dynamicCustomerWithMap;

// This comes from the property file as a key for the Map
private String object;

Have fun!

Originally published at

Written by

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store