Spring Scoped Proxy

Consider two Spring beans defined this way:

@Component
class SingletonScopedBean{
 @Autowired private PrototypeScopedBean prototypeScopedBean;
 
 public String getState(){
  return this.prototypeScopedBean.getState();
 }
}

@Component
@Scope(value="prototype")
class PrototypeScopedBean{
 private final String state;
 
 public PrototypeScopedBean(){
  this.state = UUID.randomUUID().toString();
 }

 public String getState() {
  return state;
 }
}

Here a prototype scoped bean is injected into a Singleton scoped bean.

Now, consider this test using these beans:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class ScopedProxyTest {
 
 @Autowired private SingletonScopedBean singletonScopedBean;
 
 @Test
 public void testScopedProxy() {
  assertThat(singletonScopedBean.getState(), not(equalTo(singletonScopedBean.getState())));
 }
 
 @Configuration
 @ComponentScan("org.bk.samples.scopedproxy")
 public static class SpringContext{}

}

The point to note is that there is only 1 instance of PrototypeScopedBean that is created here – and that 1 instance is injected into the SingletonScopedBean, so the above test which actually expects a new instance of PrototypeScopedBean with each invocation of getState() method will fail.

If a new instance is desired with every request to PrototypeScopedBean (and in general if a bean with longer scope has a bean with shorter scope as a dependency, and the shorter scope needs to be respected), then there are a few solutions:

1. Lookup method injection – which can be read about here
2. A better solution is using Scoped proxies

A scoped proxy can be specified this way using @Configuration:

@Component
@Scope(value="prototype", proxyMode=ScopedProxyMode.TARGET_CLASS)
class PrototypeScopedBean{
 private final String state;
 
 public PrototypeScopedBean(){
  this.state = UUID.randomUUID().toString();
 }

 public String getState() {
  return state;
 }

}

With this change, the bean injected into the SingletonScopedBean is not the PrototypeScopedBean itself, but a proxy to the bean (created using CGLIB or Dynamic proxies) and this proxy understands the scope and returns instances based on the requirements of the scope, the test should now work as expected.

Reference: Spring Scoped Proxy from our JCG partner Biju Kunjummen at the all and sundry blog.

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 two of our best selling eBooks for FREE!

JPA Mini Book

Learn how to leverage the power of JPA in order to create robust and flexible Java applications. With this Mini Book, you will get introduced to JPA and smoothly transition to more advanced concepts.

JVM Troubleshooting Guide

The Java virtual machine is really the foundation of any Java EE platform. Learn how to master it with this advanced guide!

Given email address is already subscribed, thank you!
Oops. Something went wrong. Please try again later.
Please provide a valid email address.
Thank you, your sign-up request was successful! Please check your e-mail inbox.
Please complete the CAPTCHA.
Please fill in the required fields.

Leave a Reply


4 × = twenty four



Java Code Geeks and all content copyright © 2010-2014, Exelixis Media Ltd | Terms of Use | Privacy Policy | Contact
All trademarks and registered trademarks appearing on Java Code Geeks are the property of their respective owners.
Java is a trademark or registered trademark of Oracle Corporation in the United States and other countries.
Java Code Geeks is not connected to Oracle Corporation and is not sponsored by Oracle Corporation.
Do you want to know how to develop your skillset and become a ...
Java Rockstar?

Subscribe to our newsletter to start Rocking right now!

To get you started we give you two of our best selling eBooks for FREE!

Get ready to Rock!
You can download the complementary eBooks using the links below:
Close