Spring Boot 之事件（Event）

來醉一場發表於2019-03-05
Spring Boot事件

Spring 官方文件翻譯如下 ：

ApplicationContext 通過 ApplicationEvent 類和 ApplicationListener 介面進行事件處理。 如果將實現 ApplicationListener 介面的 bean 注入到上下文中，則每次使用 ApplicationContext 釋出 ApplicationEvent 時，都會通知該 bean。 本質上，這是標準的觀察者設計模式。

Spring的事件（Application Event）其實就是一個觀察者設計模式，一個 Bean 處理完成任務後希望通知其它 Bean 或者說 一個Bean 想觀察監聽另一個Bean的行為。

Spring 事件只需要幾步：

  • 自定義事件，繼承 ApplicationEvent
  • 定義監聽器，實現 ApplicationListener 或者通過 @EventListener 註解到方法上
  • 定義釋出者，通過 ApplicationEventPublisher

程式碼示例：

1. 自定義Event

@Data
public class DemoEvent extends ApplicationEvent {
    private Long id;
    private String message;

    public DemoEvent(Object source, Long id, String message) {
        super(source);
        this.id = id;
        this.message = message;
    }
}
複製程式碼

2. 監聽器

  • 實現ApplicationListener 介面

@Component
public class DemoListener implements ApplicationListener<DemoEvent> {

    @Override
    public void onApplicationEvent(DemoEvent demoEvent) {
        System.out.println(">>>>>>>>>DemoListener>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
        System.out.println("收到了：" + demoEvent.getSource() + "訊息;時間：" + demoEvent.getTimestamp());
        System.out.println("訊息：" + demoEvent.getId() + ":" + demoEvent.getMessage());
    }
}
複製程式碼

泛型為需要監聽的事件型別

  • @EventListener
@Component
public class DemoListener2 {

    @EventListener
    public void onApplicationEvent(DemoEvent demoEvent) {
        System.out.println(">>>>>>>>>DemoListener2>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
        System.out.println("收到了：" + demoEvent.getSource() + "訊息;時間：" + demoEvent.getTimestamp());
        System.out.println("訊息：" + demoEvent.getId() + ":" + demoEvent.getMessage());
    }
}

複製程式碼

引數為需要監聽的事件型別

3. 訊息釋出者

@Component
public class DemoPublisher {

    private final ApplicationContext applicationContext;

    @Autowired
    public DemoPublisher(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    public void publish(long id, String message) {
        applicationContext.publishEvent(new DemoEvent(this, id, message));
    }

}
複製程式碼

4. 測試方法

@Test
public void publisherTest() {
    demoPublisher.publish(1L, "成功了！");
}
複製程式碼

5.結果

>>>>>>>>>DemoListener2>>>>>>>>>>>>>>>>>>>>>>>>>>>>
收到了：com.jiuxian.publisher.DemoPublisher@3a62c01e訊息;時間：1551762322376
訊息：1:成功了！
>>>>>>>>>DemoListener>>>>>>>>>>>>>>>>>>>>>>>>>>>>
收到了：com.jiuxian.publisher.DemoPublisher@3a62c01e訊息;時間：1551762322376
訊息：1:成功了！

複製程式碼

6. 示例原始碼

GitHub https://github.com/Zejun-Liu/SpringBoot2.0/tree/master/springboot-event

相關文章