Shut down a Spring Boot application

This post will discuss how to shut down a Spring Boot application.

1. Using `ApplicationContext#close()` method

Since closing the Spring Application basically means closing the underlying ApplicationContext. The idea is to use the close() method to close the application context, releasing all resources and locks that the implementation might hold. We can get ApplicationContext as a ConfigurableApplicationContext using SpringApplication.run() method, as shown below:

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication

public class Main

{

public static void main(String[] args)

{

ConfigurableApplicationContext context = SpringApplication.run(Main.class, args);

// do something

context.close();

}

2. Using `SpringApplication#exit()` method

Alternatively, we can use SpringApplication.exit(ApplicationContext, ExitCodeGenerator…) static utility method, as shown in the following example:

import org.springframework.boot.ExitCodeGenerator;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication

public class Main

{

public static void main(String[] args)

{

ConfigurableApplicationContext context = SpringApplication.run(Main.class, args);

// do something

int exitCode = SpringApplication.exit(context, new ExitCodeGenerator() {

@Override

public int getExitCode() {

return 0;

}

});

System.exit(exitCode);

}

Using Java 8 Lambda, we can rewrite the above code as:

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication

public class Main

{

public static void main(String[] args)

{

ConfigurableApplicationContext context = SpringApplication.run(Main.class, args);

// do something

System.exit(SpringApplication.exit(context, () -> 0));

}

We can also autowire ApplicationContext into one of our controllers and initiate app shut down from the controller itself, as shown below:

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.SpringApplication;

import org.springframework.context.ApplicationContext;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

public class Controller {

@Autowired

private ApplicationContext context;

public void initiateAppShutdown(int returnCode) {

SpringApplication.exit(context, () -> returnCode);

}

@RequestMapping("/shutdown")

public void shutdown() {

initiateAppShutdown(0);

}

// …

}

That’s all about shutting down a Spring Boot application.

Shut down a Spring Boot application

1. Using ApplicationContext#close() method

2. Using SpringApplication#exit() method

Share this:

1. Using `ApplicationContext#close()` method

2. Using `SpringApplication#exit()` method