TOC

春のシャットダウンコールバック

春のシャットダウンコールバック

1. 概要

このチュートリアルでは、to use shutdown callbacks with Springのさまざまな方法を学習します。

シャットダウンコールバックを使用する主な利点は、正常なアプリケーション終了を制御できることです。

2. シャットダウンコールバックアプローチ

Springは、コンポーネントレベルとコンテキストレベルの両方のシャットダウンコールバックをサポートしています。 これらを使用してこれらのコールバックを作成できます：

  • @PreDestroy

  • DisposableBeanインターフェース

  • Bean破棄メソッド

  • グローバルServletContextListener

これらすべてのアプローチを例を挙げて見てみましょう。

2.1. @PreDestroyの使用

@PreDestroyを使用するBeanを作成しましょう。 

@Component
public class Bean1 {

    @PreDestroy
    public void destroy() {
        System.out.println(
          "Callback triggered - @PreDestroy.");
    }
}

Beanの初期化中に、Springは@PreDestroyでアノテーションが付けられたすべてのBeanメソッドを登録し、アプリケーションのシャットダウン時にそれらを呼び出します。

2.2. DisposableBeanインターフェースの使用

2番目のBeanは、シャットダウンコールバックを登録するためにDisposableBeanインターフェースを実装します。 

@Component
public class Bean2 implements DisposableBean {

    @Override
    public void destroy() throws Exception {
        System.out.println(
          "Callback triggered - DisposableBean.");
    }
}

2.3. Bean破棄メソッドの宣言

このアプローチでは、最初にカスタムのdestroyメソッドを使用してクラスを作成します。 

public class Bean3 {

    public void destroy() {
        System.out.println(
          "Callback triggered - bean destroy method.");
    }
}

次に、Beanを初期化し、そのdestroy()メソッドをシャットダウンコールバックとしてマークする構成クラスを作成します。 

@Configuration
public class ShutdownHookConfiguration {

    @Bean(destroyMethod = "destroy")
    public Bean3 initializeBean3() {
        return new Bean3();
    }
}

destroyメソッドを登録するXMLの方法は次のとおりです。

2.4. グローバルServletContextListenerの使用

Beanレベルでコールバックを登録する他の3つのアプローチとは異なり、the ServletContextListener registers the callback at context levelです。

このために、カスタムコンテキストリスナーを作成しましょう。 

public class ExampleServletContextListener
  implements ServletContextListener {

    @Override
    public void contextDestroyed(ServletContextEvent event) {
        System.out.println(
          "Callback triggered - ContextListener.");
    }

    @Override
    public void contextInitialized(ServletContextEvent event) {
        // Triggers when context initializes
    }
}

構成クラスのServletListenerRegistrationBeanに登録する必要があります。 

@Bean
ServletListenerRegistrationBean servletListener() {
    ServletListenerRegistrationBean srb
      = new ServletListenerRegistrationBean<>();
    srb.setListener(new ExampleServletContextListener());
    return srb;
}

3. 結論

Beanレベルとコンテキストレベルの両方で、Springがシャットダウンコールバックを登録するために提供するさまざまな方法について学習しました。

これらは、アプリケーションを正常にシャットダウンし、使用済みのリソースを効果的に解放するために使用できます。

いつものように、この記事で言及されているすべての例は、over on Githubで見つけることができます。

Related