Thu, Jul 11 2019

Spring bootでイベントハンドリングを実装する

spring bootの@EventListnerについて。

Spring Bootのイベントハンドリング機能を使うと手軽にpublisher-subscriberモデルを実装できる。

# 今回作るサンプル

https://github.com/qnaiv/spring-event-handling

TODOが作成されたらお知らせする。

# 処理の流れ

TODOを作成処理のあとにTodoCreatedイベントを発行する。
イベントが発行されたら、NoticeService#handleEvent(TodoCreated event)メソッドが自動で実行される。

# 実装

# 1. Eventを作成

@Getter
@EqualsAndHashCode
public class TodoCreated extends ApplicationEvent{

    private static final long serialVersionUID = 1L;
    private String todoId;
    private String text;

    public TodoCreated(Object source, String todoId, String text) {
        super(source);
        this.todoId = todoId;
        this.text = text;
        
    }
}

ポイント

ApplicationEventを継承する

# 2. Subscriber(イベントを購読する側)を実装する

@Service
public class NoticeService {

    @EventListener
    public void eventHandle(TodoCreated event){
        System.out.println("作成されました [TODO ID: " + event.getTodoId() + " / 内容: " + event.getText() + "]");
        
    }
}

ポイント:

@EventListenerアノテーションをつける
メソッドの引数を、購読したいEventクラスにする

# 3. Publisher(イベントを発行する側)を実装する

@RestController
public class TodoController {

    @Autowired ApplicationEventPublisher publisher;
    @GetMapping(value="")
    public String createTodo() {
        publisher.publishEvent(new TodoCreated(this, "1", "買い物に行く"));
        return "Todo created";
    }
    
}

ポイント:

ApplicationEventPublisherをAutowiredする
TODO作成処理の後にメソッドApplicationEventPublisher#publishEvent(ApplicationEvent event)を実行する。

spring boot java