7
votes

I'm new to Spring Boot, and I've got a Spring Boot application that seems to be ignoring the @PreDestroy annotation - when I run from command line or via Eclipse, I'm never seeing the @PreDestroy code being run when application is shutdown (e.g. via ctrl-c)

Code is below ...

Application.java:

@SpringBootApplication
public class Application {

    @Autowired
    private MessageProcessor messageProcessor;

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @PostConstruct
    public void init() {    
        messageProcessor.run();
    }

}

Message Processor Config:

@Configuration
public class MessageProcessorConfiguration {

    @Bean
    public MessageProcessor messageProcessor() {
        return new MessageProcessorImpl();
    }
}

Message Processor:

public class MessageProcessorImpl implements MessageProcessor {

    @Override
    public void run() {

        while (isActive()) {
           …
        }
    }


   @PreDestroy
   public void shutdown() { 
       System.out.println("MessageProcessorImpl - shutting down");
   }

}
3
The PreDestroy annotation is used on methods as a callback notification to signal that the instance is in the process of being removed by the container, it is not a Pre-Shuttdown of your application - Azzabi Haythem
So @PreDestroy will not fire when I use ctrl-c or kill <pid> on the running application? Is there something I can to to catch this event ? - finbin
Reading that, it looks like @PreDestroy should be being called ... - finbin
No, if the bean is not singleton this would be invoked multiple times - Azzabi Haythem

3 Answers

2
votes

Spring Boot register shutdown hook during context creation see org.springframework.context.support.AbstractApplicationContext#registerShutdownHookmethod. As result context must be closed on crtl+c combination (if you run your app through java -jar app.jar cmd) and which in turn triggers your @Predestroy method. This works for me.

I don't see any remarks in your code. I can suggest annotating your MessageProcessorImpl bean with @Component annotation instead of a manual @Bean declaration.

1
votes

The @PreDestroy does not work when the Scope(value=ConfigurableBeanFactory.SCOPE_PROTOTYPE) is used on the bean since the bean's spawned with this method is not completely managed by the IOC container.

The @PreDestroy works when the Scope(value=ConfigurableBeanFactory.SCOPE_SINGLETON) is used on the bean.

0
votes

Try adding this line in your xml.

<bean class="org.springframework.context.annotation.CommonAnnotationBeanPostProcessor" />