SpringはApplicationListenerを実装することで発生したApplicationEventの通知を受け取ることができます。

簡単にApplicationContextが初期化されたときに独自のログを流す処理を書いてみます。

import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

@Component
public class RefreshEventObserver implements ApplicationListener<ContextRefreshedEvent> {
    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        System.out.println("アプリケーションが初期化されました");
    }
}

アプリケーションを起動すると、設定したログが流れることが確認できます

ContextRefreshedEvent
- Springにデフォルトで用意されているイベントです

次は独自のイベントを作成してみます

独自のイベントを作成する

以下の手順でイベントの通知から処理の実行までします。

ソースの作成
- イベントに使用されるソースを定義します
イベントの作成
- ApplicationEventを継承したイベントクラスの作成パブリッシャーがこのイベントクラスを発火させます
  - パブリッシャーがこのイベントクラスを発火させます
パブリッシャーの作成
- イベントを発火させます
- イベントにはソースを付与させることができます
ハンドラの作成
- イベントが発行されたときに実行される処理を記載
- イベントを受け取って、行う処理を記載します
- イベントからソースを取得することができます

今回はメール送信を想定して実装していきます

ソースの作成

ハンドラで利用するソースを作成します。メールの送信が目的なのでソースはメールを表すクラスになります

import lombok.Builder;
import lombok.Getter;

@Builder
@Getter
public class Mail {
    private String to;
    private String message;
}

イベントを作成する

イベントではソースを保持しておきます。

import org.springframework.context.ApplicationEvent;

public class EmailEvent<Mail> extends ApplicationEvent {

    private Mail source;

    public EmailEvent(Mail source) {
        super(source);
        this.source = source;
    }
}

イベントは発行されるだけなので特別な処理は記載していません

パブリッシャーの作成

先ほど作成したイベントを発火させるのがパブリッシャーです。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Component;

@Component
public class EmailEventPublisher {

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    public void publish(String to, String message){
        Mail mail = Mail.builder().to(to).message(message).build();
        this.applicationEventPublisher.publishEvent(new EmailEvent(mail));
    }
}

実際の発火はApplicationEventPublisherというクラスが担当します

ハンドラの作成

ハンドラはイベントが発行されたときに実行します。ここで実際の処理を記載します

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class EmailEventHandler implements ApplicationListener<EmailEvent> {
    @Override
    public void onApplicationEvent(EmailEvent event) {
        Mail mail = (Mail)event.getSource();
        System.out.println("宛先" + mail.getTo());
        System.out.println("メッセージ" + mail.getMessage());
    }
}

getSourceメソッドでソースを取得できます。
- 戻り値はObject型なのでキャストしています

コントローラーから利用してみます

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class EventController {

    @Autowired
    private EmailEventPublisher emailEventPublisher;

    @GetMapping("/fire")
    public String eventtest(){
        System.out.println("メール送信します");
        String to = "misaka@mikoto.com";
        String message = "bili bili";
        this.emailEventPublisher.publish(to,message);
        System.out.println("その他の処理を実行中");
        return "完了しました";
    }
}

イベントが発行されて処理が実施されていることが確認できました。

非同期イベント

もしも時間のかかるイベントが発火されたら次の処理がブロッキングされてしまいます

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;

@Component
public class EmailEventHandler implements ApplicationListener<EmailEvent> {
    @Override
    public void onApplicationEvent(EmailEvent event) {
        try {
            TimeUnit.SECONDS.sleep(3);
            Mail mail = (Mail)event.getSource();
            System.out.println("宛先" + mail.getTo());
            System.out.println("メッセージ" + mail.getMessage());
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

メール送信処理で時間がかかっていて処理が進んでいません。

ThreadPoolTaskExecutorとApplicationEventMulticasterを利用して非同期で大量のイベントを捌けるようにします。

Bean定義

ThreadPoolTaskExecutorとApplicationEventMulticasterを利用するためシングルトンのBeanを定義します

まずはThreadPoolTaskExecutor

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@Configuration
public class MailTaskExecutorBeanConfig {

    @Bean
    public ThreadPoolTaskExecutor threadPoolTaskExecutor(){
        ThreadPoolTaskExecutor threadPoolTaskExecutor = new ThreadPoolTaskExecutor();
        threadPoolTaskExecutor.setCorePoolSize(5);
        threadPoolTaskExecutor.setMaxPoolSize(10);
        threadPoolTaskExecutor.setQueueCapacity(15);
        return threadPoolTaskExecutor;
    }
}

次にApplicationEventMulticaster

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.ApplicationEventMulticaster;
import org.springframework.context.event.SimpleApplicationEventMulticaster;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

@Configuration
public class MulticasterBeanConfig {

    @Autowired
    private ThreadPoolTaskExecutor threadPoolTaskExecutor;

    @Bean
    public ApplicationEventMulticaster simpleApplicationEventMulticaster(){
        SimpleApplicationEventMulticaster multicaster = new SimpleApplicationEventMulticaster();
        multicaster.setTaskExecutor(threadPoolTaskExecutor);
        return multicaster;
    }
}

Bean定義したThreadPoolTaskExecutorを利用するため別のファイルにしています

パブリッシャーの修正

ApplicationEventPublisherをApplicationEventMulticasterを利用するように修正します

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.event.ApplicationEventMulticaster;
import org.springframework.stereotype.Component;

@Component
public class EmailEventPublisher {

    @Autowired
    private ApplicationEventMulticaster applicationEventMulticaster;
    // private ApplicationEventPublisher applicationEventPublisher;

    // 直接メールを受け取るように修正しています
    public void publish(Mail mail){
        //Mail mail = Mail.builder().to(to).message(message).build();
        this.applicationEventMulticaster.multicastEvent(new EmailEvent(mail));
        //this.applicationEventPublisher.publishEvent(new EmailEvent(mail));
    }
}

使い方はほとんど一緒です

タスクの作成

タスクの中でパブリッシャーを呼び出します。このタスクはThreadPoolTaskExecutorから実行されます

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

import java.util.ArrayList;
import java.util.List;

@Component
public class MailTask implements Runnable{

    // 送信予定となるメールを全てタスクとして管理できるようにします
    private List<Mail> mails = new ArrayList<>();

    @Autowired
    private EmailEventPublisher emailEventPublisher;

    public void addMail(Mail ...mails){
        this.mails.addAll(List.of(mails));
    }

    @Override
    public void run() {
        for(Mail mail : mails){
            this.emailEventPublisher.publish(mail);
        }
    }
}

コントローラーを修正して確認します

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class EventController {

   //@Autowired
   // private EmailEventPublisher emailEventPublisher;

    @Autowired
    private MailTask mailTask;

    @Autowired
    private ThreadPoolTaskExecutor threadPoolTaskExecutor;

    @GetMapping("/fire")
    public String eventtest(){
        System.out.println("メール送信します");

        //　送信予定のメール
        Mail mail1 = Mail.builder().to("misaka@mikoto").message("bili bili").build();
        Mail mail2 = Mail.builder().to("gunha@sogita").message("konjo").build();
        Mail mail3 = Mail.builder().to("saiai@kinuhata").message("cho mukatukimasune").build();

        // 送信予定のメールをタスクに設定する
        this.mailTask.addMail(mail1,mail2,mail3);

        // ここからMailTaskのRunを呼び出してイベントが発行される
        // Runの中ではそれぞれのMailがパブリッシャーに渡されます
        threadPoolTaskExecutor.execute(this.mailTask);

        System.out.println("その他の処理を実行中");
        return "完了しました";
    }
}

ログもイベントの処理を待たずに次の処理へ動いてることがわかりますし、画面でもレスポンスがすぐに帰ってきているのがわかります。

同時にメール送信

今は1件ごとにメールを送信していますが、一斉に送信するようにしてみます

タスクの修正

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

// Runnableは関数型インターフェースを利用する
// public class MailTask implements Runnable{
@Component
public class MailTask {

    private List<Mail> mails = new ArrayList<>();

    @Autowired
    private EmailEventPublisher emailEventPublisher;

    // 追加
    @Autowired
    private ThreadPoolTaskExecutor threadPoolTaskExecutor;


    public void addMail(Mail ...mails){
        this.mails.addAll(List.of(mails));
    }

    // 追加
    public void runAllTask(){
        for(Mail mail : mails){
            this.threadPoolTaskExecutor.execute( () -> {
                this.emailEventPublisher.publish(mail);
            });
        }
    }

    // 不要
    /*
    @Override
    public void run() {
        for(Mail mail : mails){
            this.emailEventPublisher.publish(mail);
        }
    }
    */
}

Mailの数だけExecutorを実行するようにする

コントローラーを修正

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class EventController {

    @Autowired
    private MailTask mailTask;

    // 消す
    //@Autowired
    //private ThreadPoolTaskExecutor threadPoolTaskExecutor;

    @GetMapping("/fire")
    public String eventtest(){
        System.out.println("メール送信します");

        Mail mail1 = Mail.builder().to("misaka@mikoto").message("bili bili").build();
        Mail mail2 = Mail.builder().to("gunha@sogita").message("konjo").build();
        Mail mail3 = Mail.builder().to("saiai@kinuhata").message("cho mukatukimasune").build();

        this.mailTask.addMail(mail1,mail2,mail3);

        // ここで実行する
        this.mailTask.runAllTask();

        // 消す
        //threadPoolTaskExecutor.execute(this.mailTask);

        System.out.println("その他の処理を実行中");
        return "完了しました";
    }
}

ThreadPoolTaskExecutorはタスククラスで利用するのでコントローラーからは除外します

これで一気にタスクが実行されます。

関連記事

ApplicationEvent
- アプリケーション終了時にExecutorのシャットダウンを行う

リンク

インターセプター

リンク

AOP

リンク

リンク

参考

https://www.baeldung.com/spring-events

Spring | イベントの同期と非同期処理