Spring core. Default @Bean destroy method

Question

I have my own bean:

@Bean
public MyBean myBean(){...

following spring documentation to release its own resources I should specify destroyMethod. I've not found any default destroy methods called by spring in case if destroyMethod is not specified directly.

I used

@Bean(destroyMethod = "close")
public MyBean myBean(){...

but think about possibility to do not specify destroy method directly if it has value by default.

Does spring try something by default like destroy, close, release? If spring tries some methods by default to release resources - which ones?

I think no. It would be very unclear, you need an annotation like @PreDestroy or @Bean(destroyMethod = "..."), or implement DisposableBean. — rxn1d
– rxn1d, Commented Jun 26, 2017 at 9:49

Mark Rotteveel · Accepted Answer · 2017-06-26 10:47:07Z

88

As documented in Bean.destroyMethod:

As a convenience to the user, the container will attempt to infer a destroy method against an object returned from the @Bean method. For example, given an @Bean method returning an Apache Commons DBCP BasicDataSource, the container will notice the close() method available on that object and automatically register it as the destroyMethod. This 'destroy method inference' is currently limited to detecting only public, no-arg methods named 'close' or 'shutdown'.

In other words, if you don't specify destroyMethod, but the bean has a public close() or shutdown() method, it will be automatically used as the destroy-method.

To disable this inference, use @Bean(destroyMethod = "").

edited Jun 26, 2017 at 10:47

answered Jun 26, 2017 at 9:55

Mark Rotteveel

110k240 gold badges160 silver badges232 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

dpelisek Over a year ago

Besides the public close() method, there is also @PreDestroy annotation and DisposableBean interface. Is there any recommended or generally preferred way to go?

Mark Rotteveel Over a year ago

@dpelisek @Bean with a destroyMethod will work for any class used as a bean, even if you can't modify the class. Using @PreDestroy means you need to have access to the source of that class to be able to add that annotation to the right method, similar for DisposableBean: you need to be able to implement that interface. So, if it is your own code, by all means use @PreDestroy or DisposableBean (personally I would prefer the annotation over the interface), but for third-party classes you usually don't have the choice.

kk. · Accepted Answer · 2018-02-02 06:53:32Z

24

You can implement a method which will be executed before destroying and annotate it with @PreDestroy

@PreDestroy
public void methodName() {
    //Your code..
}

edited Feb 2, 2018 at 6:53

answered Jun 26, 2017 at 9:51

kk.

4,00512 gold badges40 silver badges71 bronze badges

Comments

Ofer Skulsky · Accepted Answer · 2017-06-26 09:51:58Z

11

The org.springframework.beans.factory.DisposableBean interface specifies a single method −

void destroy() throws Exception;

Simply implement it −

public class ExampleBean implements DisposableBean {
   public void destroy() {
      // do some destruction work
   }
}

for XML-based configuration

<bean id = "exampleBean" class = "examples.ExampleBean" destroy-method = "destroy"/>

and in the bean

public class ExampleBean {
   public void destroy() {
      // do some destruction work
   }
}

or annotate with @PreDestroy

answered Jun 26, 2017 at 9:51

Ofer Skulsky

7714 silver badges11 bronze badges

Comments

Dmitry Senkovich · Accepted Answer · 2017-06-26 09:57:03Z

4

You can extend DisposableBeanAdapter class. One of the methods it provides is the destroy method being called by Spring. This way you don't have to provide any implementation while it is required when you're using DisposableBean interface.

edited Jun 26, 2017 at 9:57

answered Jun 26, 2017 at 9:47

Dmitry Senkovich

5,9819 gold badges41 silver badges82 bronze badges

Collectives™ on Stack Overflow

Spring core. Default @Bean destroy method

4 Answers 4

2 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related