Spring init-method and destroy-method example

In Spring, you can use init-method and destroy-method as attribute in bean configuration file for bean to perform certain actions upon initialization and destruction. Alternative to InitializingBean and DisposableBean interface.

Example

Here’s an example to show you how to use init-method and destroy-method.


package com.mkyong.customer.services;

public class CustomerService
{
	String message;
	
	public String getMessage() {
	  return message;
	}

	public void setMessage(String message) {
	  this.message = message;
	}
	
	public void initIt() throws Exception {
	  System.out.println("Init method after properties are set : " + message);
	}
	
	public void cleanUp() throws Exception {
	  System.out.println("Spring Container is destroy! Customer clean up");
	}
	
}

File : Spring-Customer.xml, define init-method and destroy-method attribute in your bean.


<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
	http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">

	<bean id="customerService" class="com.mkyong.customer.services.CustomerService" 
		init-method="initIt" destroy-method="cleanUp">
   		
		<property name="message" value="i'm property message" />
	</bean>
		
</beans>

Run it


package com.mkyong.common;

import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.mkyong.customer.services.CustomerService;

public class App 
{
    public static void main( String[] args )
    {
    	ConfigurableApplicationContext context = 
		new ClassPathXmlApplicationContext(new String[] {"Spring-Customer.xml"});
	
    	CustomerService cust = (CustomerService)context.getBean("customerService");
    	
    	System.out.println(cust);
    	
    	context.close();
    }
}

The ConfigurableApplicationContext.close will close the application context, releasing all resources and destroying all cached singleton beans.

Output


Init method after properties are set : i'm property message
com.mkyong.customer.services.CustomerService@47393f
...
INFO: Destroying singletons in org.springframework.beans.factory.
support.DefaultListableBeanFactory@77158a: 
defining beans [customerService]; root of factory hierarchy
Spring Container is destroy! Customer clean up

The initIt() method is called, after the message property is set, and the cleanUp() method is called after the context.close();

Thoughts…
It’s always recommended to use init-method and destroy-method in bean configuration file, instead of implement the InitializingBean and DisposableBean interface to cause unnecessarily coupled your code to Spring.

Download Source Code

About the Author

author image
mkyong
Founder of Mkyong.com, love Java and open source stuff. Follow him on Twitter, or befriend him on Facebook or Google Plus. If you like my tutorials, consider make a donation to these charities.

Comments

Leave a Reply

avatar
newest oldest most voted
Vikram Pyati
Guest
Vikram Pyati

Hi,

Is the init-method threadsafe ?

trackback
Spring InitializingBean and DisposableBean example | architecture?riaos.com?

[…] because it will tight coupled your code to Spring. A better approach should be specifying theinit-method and destroy-method attributes in your bean configuration file. […]

Matthias
Guest
Matthias

as always … a valuable source!

Thx a lot

Yogesh
Guest
Yogesh

hi,

Can you explain if destroy method required some parameter how i can write in Spring-Customer.xml

public void cleanUp(String down) throws Exception {
System.out.println(“Spring Container is destroy! Customer clean up”+ down);
}

thanks yogesh

Somapala
Guest
Somapala

destroy methods does not accept non boolean parameters. But you can inject via setter or constructor and use in the destroy method.

trackback
Spring @PostConstruct and @PreDestroy example

[…] Spring, you can either implements InitializingBean and DisposableBean interface or specify the init-method and destroy-method in bean configuration file for the initialization and destruction callback function.In this […]

trackback
Spring InitializingBean and DisposableBean example

[…] because it will tight coupled your code to Spring. A better approach should be specifying the init-method and destroy-method attributes in your bean configuration file.Download Source Code Download It – […]

trackback
Spring Tutorials | Tutorials

[…] init-method and destroy-method example Define init-method and destroy-method in bean configuration file for initialization and destruction feature. […]

trackback
How Facial Hair Removal is Done | WOMEN FACIAL HAIR REMOVEAL

[…] Spring – init-method and destroy-method example | Spring […]

trackback
Profiteering With ClickBank (Not What You Think)

[…] Spring – init-method and destroy-method example | Spring […]