<div dir="ltr" style="text-align: justify;">
<div class="separator" style="clear: both; text-align: center;"><img src="https://dineshonjava.com/wp-content/uploads/2017/01/Spring-Method-Injection.png" width="320" height="128" border="0" /></div>
<p>In this article we will discuss how spring lookup-method annotation used for the method injection. Spring could inject dependencies between the beans in the application by following way of injection types:</p>
<ol style="text-align: left;">
<li>Setter Injection</li>
<li>Constructor Injection</li>
<li>Field Injection (@Autowired at field)</li>
<li>Method Injection</li>
</ol>
<p>As discussed in earlier article Spring Beans have mainly two types of scope i.e <b>1. <a href="https://dineshonjava.com/singleton-bean-scope-in-spring/">Singleton</a> (Instantiate only one object)</b> and <b>2. <a href="https://dineshonjava.com/prototype-bean-scope-with-annotation/">Prototype </a>(Instantiate a new object every time)</b>. To find more about <a href="https://dineshonjava.com/understanding-bean-scopes/"><b>Spring Bean Scope</b></a> before reading this article. In Spring application there are many beans injected to each other for a goal. There is no problem when injected beans have same scope of beans like singleton bean injected with other singleton beans. Sometimes in Spring, Problems arise when you need to inject a prototype-scoped bean in a singleton-scoped bean. Since singletons are created (and then injected) during context creation it&#8217;s the only time the Spring context is accessed and thus prototype-scoped beans are injected only once, thus defeating their purpose.</p>
<div style="background-color: #f2f9fc; border: 1px solid #c9e6f2; border-radius: 3px; padding: 16px; line-height: 1.45;">
<p><span style="color: red; font-size: x-large; text-align: center;"><b>Popular Tutorials</b></span></p>
<ul style="text-align: left;">
<li><b><a href="https://dineshonjava.com/spring-tutorial/"><em><strong>Spring Tutorial</strong> </em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-web-mvc-framework-chapter-38/"><strong><em>Spring MVC Web Tutorial </em></strong></a></b></li>
<li><b><a href="https://dineshonjava.com/introduction-to-spring-boot-a-spring-boot-complete-guide/"><strong>Spring Boot Tutorial</strong> </a></b></li>
<li><b><a href="https://dineshonjava.com/spring-security-take-baby-step-to-secure/"><em>Spring Security Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-tutorial-with-example-aspect-advice-pointcut-joinpoint/"><em>Spring AOP Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/using-spring-jdbc-framework-chapter-32/"><em>Spring JDBC Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-hateoas-hypermedia-driven-restful-web-service/"><em><strong>Spring HATEOAS </strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/microservices-with-spring-boot/"><em><strong>Microservices with Spring Boot</strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/jax-rs-web-service-tutorial/"><strong><em>REST Webservice</em> </strong></a></b></li>
<li><b><a href="https://dineshonjava.com/core-java-baby-step-to-be-best-java-ian/"><em><strong>Core Java </strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/hibernate-3-on-baby-steps/"><em><strong>Hibernate Tutorial</strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-batch-process-with-example/"><strong><em>Spring Batch</em> </strong></a></b></li>
</ul>
</div>
<p>But Spring provides another way for injection of beans, It is called method injection. It is solution of above problem in injecting different scoped beans. It works as that since singleton beans are instantiated at context creation, but it changes the way prototype-scoped are handled, from injection to created by an abstract method. It is actually a another kind of injection used for dynamically overriding a class and its abstract methods to create instances every time the bean is injected.</p>
<p>Method injection is different from Constructor Injection and Setter Injection. While in Constructor and Setter Injection, Spring creates the beans and injects them using the constructor or setter method, in Method Injection Spring overrides a given abstract method of an abstract class and provides an implementation of the overridden method.</p>
<p>Note there is an alternative to method injection would be to explicitly access the Spring context to get the bean yourself. It&#8217;s a bad thing to do since it completely defeats the whole Inversion of Control pattern, but it works.</p>
<p>This is an advanced form of dependency injection and should be used in very special cases as it involves byte-code manipulation by Spring.</p>
<h2><b>Sample of Use Case of Spring Method Injection</b></h2>
<p>You have a generic business object/singleton (<b>TokenMachine</b>) that need to create an implementation of an interface with state to perform some task.</p>
<div class="separator" style="clear: both; text-align: center;"><img src="https://dineshonjava.com/wp-content/uploads/2017/01/method-injection.gif" border="0" /></div>
<p>There is usually one instance of Token Machine usually available in the Banks. However, a Token Machine generates a new instance of Token every time. In this case, Token Machine bean has scope Singleton while Token bean has scope Prototype.</p>
<p>In this sample application we define a <b>Token </b>class and an abstract <b>TokenMachine </b>class. The <b>TokenMachine</b> class defines an abstract method called <b>generateToken()</b> which returns a new Token. We use Spring’s Method Injection to create a new instance of Token from <b>TokenMachine</b>. We will configure Spring to override the <b>generateToken() </b>method and return a new instance of Token class.</p>
<p>Finally, we will test this sample by using Main class which will load the <b>TokenMachine</b> bean via Spring and invoke the <b>generateToken() </b>method.<br />
<b><br />
Required Dependencies in Pom.xml</b></p>
<pre class="highlight"><;properties>; 
 <;spring.version>;4.3.5.RELEASE<;/spring.version>; 
 <;/properties>; 
 
 <;dependencies>; 
 <;dependency>; 
 <;groupId>;org.springframework<;/groupId>; 
 <;artifactId>;spring-core<;/artifactId>; 
 <;version>;${spring.version}<;/version>; 
 <;/dependency>; 
 <;dependency>; 
 <;groupId>;org.springframework<;/groupId>; 
 <;artifactId>;spring-context<;/artifactId>; 
 <;version>;${spring.version}<;/version>; 
 <;/dependency>; 
 <;dependency>; 
 <;groupId>;org.springframework<;/groupId>; 
 <;artifactId>;spring-beans<;/artifactId>; 
 <;version>;${spring.version}<;/version>; 
 <;/dependency>; 
 <;/dependencies>; 
</pre>
<p><b>Creating TokenMachine class for generating Token.</b><br />
<b>TokenMachine.java</b></p>
<pre class="highlight">/** 
 * 
 */ 
package com.doj.app; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
public abstract class TokenMachine { 
 
 public void findToken(){ 
 System.out.println("Token has been generated "+generateToken()); 
 } 
 public abstract Token generateToken(); 
 
} 
 
</pre>
<p><b>TokenMachine </b>contains the <b>lookup-method </b>tag with the name <b>generateToken</b> and bean id <b>token </b>that tells Spring to perform Method Injection on <b>generateToken() </b>method and return the <b>Token </b>type</p>
<p><b>Creating Token class for generating Token.<br />
Token.java</b></p>
<pre class="highlight">/** 
 * 
 */ 
package com.doj.app; 
 
import org.springframework.context.annotation.Scope; 
import org.springframework.stereotype.Component; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
@Component 
@Scope("prototype") 
public class Token { 
 
} 
</pre>
<p><b>Token </b>is declared with scope <b>Prototype </b>so that a new instance is created for every call to <b>generateToken() </b>method.</p>
<p><b>Spring Configuration file<br />
spring.xml</b></p>
<pre class="highlight"><;?xml version="1.0" encoding="UTF-8"?>; 
<;beans xmlns="http://www.springframework.org/schema/beans" 
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns:context="http://www.springframework.org/schema/context" 
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd 
 http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">; 
 
 <;bean id="token" class="com.doj.app.Token" scope="prototype"/>; 
 
 <;bean id="tokenMachine" class="com.doj.app.TokenMachine" scope="singleton">; 
 <;lookup-method bean="token" name="generateToken"/>; 
 <;/bean>; 
 
<;/beans>; 
 
</pre>
<p>Finally, we need a java program to test the Method Injection setup. This is done by <b>Main.java</b> as below.</p>
<pre class="highlight">/** 
 * 
 */ 
package com.doj.app.main; 
 
import org.springframework.context.ConfigurableApplicationContext; 
import org.springframework.context.annotation.AnnotationConfigApplicationContext; 
 
import com.doj.app.TokenMachine; 
import com.doj.app.config.AppConfig; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
public class Main { 
 public static void main(String[] args) { 
 ConfigurableApplicationContext context = new ClassPathXmlApplicationContext("spring.xml"); 
 TokenMachine machine = context.getBean(TokenMachine.class); 
 machine.findToken(); 
 machine = context.getBean(TokenMachine.class); 
 machine.findToken(); 
 context.close(); 
 } 
} 
 
</pre>
<p>Now run this application main class has generation two times Token it always return different tokens.</p>
<p><b>Find <a href="https://github.com/DOJ-SoftwareConsultant/Spring-Method-Injection" target="_blank" rel="noopener">Source Code from GitHub</a>.</b></p>
<p><b>Spring JavaConfig&#8217;s approach</b></p>
<pre class="highlight">/** 
 * 
 */ 
package com.doj.app.config; 
 
import org.springframework.context.annotation.Bean; 
import org.springframework.context.annotation.ComponentScan; 
import org.springframework.context.annotation.Configuration; 
 
import com.doj.app.Token; 
import com.doj.app.TokenMachine; 
 
/** 
 * @author Dinesh.Rajput 
 * 
 */ 
@Configuration 
@ComponentScan("com.doj.app") 
public class AppConfig { 
 @Bean 
 public TokenMachine tokenMachine(){ 
 return new TokenMachine(){ 
 
 @Override 
 public Token generateToken() { 
 return new Token(); 
 } 
 
 }; 
 } 
} 
 
</pre>
<p> ;</p>
<div style="background-color: #f2f9fc; border-radius: 3px; border: 1px solid #c9e6f2; line-height: 1.45; padding: 16px;">
<p><span style="color: red; font-size: x-large; text-align: center;"><b>Spring Related Topics you may like</b></span></p>
<ul>
<li><b><a href="https://dineshonjava.com/interview-questions-on-spring/"><span style="color: red;">Spring Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-interview-questions-and-answers/"><span style="color: red;">Spring AOP Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-mvc-interview-questions-and-answers/"><span style="color: red;">Spring MVC Interview Questions</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-security-interview-questions-and-answers/"><span style="color: red;">Spring Security Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-rest-web-services-interview-questions-and-answers/"><span style="color: red;">Spring REST Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-interview-questions-and-answers/"><span style="color: red;">Spring Boot Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-boot-microservices-interview-questions-answers/"><span style="color: red;">Spring Boot Microservices Interview Questions and Answers</span></a></b></li>
<li><b><a href="https://dineshonjava.com/dependency-injection-in-spring/"><span style="color: red;">Dependency Injection (DI) in Spring </span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-ioc-container/"><span style="color: red;">Spring IoC Container</span></a></b></li>
<li><b><a href="https://dineshonjava.com/what-is-bean-factory-in-spring/"><span style="color: red;">What is Bean Factory in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/application-context-in-spring/"><span style="color: red;">ApplicationContext in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/bean-autowiring-in-spring/"><span style="color: red;">Bean Autowiring in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/understanding-bean-scopes/"><span style="color: red;">Spring Bean Scopes</span></a></b></li>
<li><b><a href="https://dineshonjava.com/create-custom-bean-scope-in-spring-example/"><span style="color: red;">Create Custom Bean Scope in Spring Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/using-applicationcontextaware-in-spring/"><span style="color: red;">Using ApplicationContextAware in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/bean-lifecycle-and-callbacks/"><span style="color: red;">Spring Bean Life Cycle and Callbacks</span></a></b></li>
<li><b><a href="https://dineshonjava.com/writing-beanpostprocessor-in-spring/"><span style="color: red;">BeanPostProcessor in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/writing-beanfactorypostprocessor-in/"><span style="color: red;">BeanFactoryPostProcessor in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/annotations-in-spring-and-based/"><span style="color: red;"> Annotations in Spring and Based Configuration</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-jsr-250-annotations/"><span style="color: red;">Spring JSR-250 Annotations</span></a></b></li>
<li><b><a href="https://dineshonjava.com/jsr-330-annotations-in-spring/"><span style="color: red;">JSR 330 Annotations in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/stereotype-annotations-in-spring/"><span style="color: red;">Spring @Component, @Repository, @Service and @Controller Stereotype Annotations</span></a></b></li>
<li><b><a href="https://dineshonjava.com/method-injection-with-spring-using-lookup-method-property/"><span style="color: red;">Method injection with Spring using Lookup method property</span></a></b></li>
<li><b><a href="https://dineshonjava.com/introduction-to-aop-in-spring/"><span style="color: red;">Spring AOP-Introduction to Aspect Oriented Programming</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aspect-annotation/"><span style="color: red;">@Aspect Annotation in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-aspectj-before-annotation-advice-example/"><span style="color: red;"> Spring AOP AspectJ @Before Annotation Advice Example<br />
</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-before-advice-example-using-xml-config/"><span style="color: red;"> Spring AOP Before Advice Example using XML Config</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-aspectj-after-annotation-advice-example/"><span style="color: red;"> Spring AOP AspectJ @After Annotation Advice Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-after-advice-example-using-xml-config/"><span style="color: red;"> Spring AOP After Advice Example using XML Config</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-aspectj-after-returning-annotation-advice-example/"><span style="color: red;"> Spring AOP AspectJ @AfterReturning Annotation Advice Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-after-returning-advice-example-using-xml-config/"><span style="color: red;"> Spring AOP After-Returning Advice Example using XML Config</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-aspectj-after-throwing-annotation-advice-example/"><span style="color: red;"> Spring AOP AspectJ @AfterThrowing Annotation Advice Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-after-throwing-advice-example-using-xml-config/"><span style="color: red;"> Spring AOP After Throwing Advice Example using XML Config</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-aspectj-around-annotation-advice-example/"><span style="color: red;"> Spring AOP AspectJ @Around Annotation Advice Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-around-advice-example-using-xml-config/"><span style="color: red;"> Spring AOP Around Advice Example using XML Config</span></a></b></li>
<li><b><a href="https://dineshonjava.com/understanding-aop-proxies-chapter-31/"><span style="color: red;">Spring AOP Proxies in Spring</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-transaction-management-in/"><span style="color: red;"> Spring AOP Transaction Management in Hibernate</span></a></b></li>
<li><b><a href="https://dineshonjava.com/transaction-management-in-spring/"><span style="color: red;">Spring Transaction Management</span></a></b></li>
<li><b><a href="https://dineshonjava.com/declarative-transaction-management/"><span style="color: red;">Spring Declarative Transaction Management Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-ordering-of-aspects-with-example/"><span style="color: red;">Spring AOP-Ordering of Aspects with Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-security-java-based-configuration-with-example/"><span style="color: red;">Spring Security Java Based Configuration with Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-security-xml-namespace-configuration-example/"><span style="color: red;">Spring Security XML Namespace Configuration Example</span></a></b></li>
</ul>
<p> ;</p>
</div>
</div>
<div class="wp-post-navigation"> 
									 <div class="wp-post-navigation-pre"> 
									 <a href="https://dineshonjava.com/container-managed-transaction-cmt-on-ejb-and-spring-declarative-transaction/">Previous</a> 
									 </div> 
									 <div class="wp-post-navigation-next"> 
									 <a href="https://dineshonjava.com/spring-mobile-tutorial/">Next</a> 
									 </div> 
									</div>
<script type="text/javascript">
jQuery(document).ready(function($) {
 $.post('https://dineshonjava.com/wp-admin/admin-ajax.php', {action: 'mts_view_count', id: '92'});
});
</script>
Strategy Design Patterns We can easily create a strategy design pattern using lambda. To implement…
Decorator Pattern A decorator pattern allows a user to add new functionality to an existing…
Delegating pattern In software engineering, the delegation pattern is an object-oriented design pattern that allows…
Technology has emerged a lot in the last decade, and now we have artificial intelligence;…
Managing a database is becoming increasingly complex now due to the vast amount of data…
Overview In this article, we will explore Spring Scheduler how we could use it by…