springboot中使用ApplicationListener和ApplicationEvent /@EventListener监听事件

文章目录

• ​​自定义一个事件类​​
• ​​监听类：​​
• ​​事件发布者​​
• ​​改用@EventListener注解：​​

• ​​总结​​

---

自定义一个事件类

public class OnRegistrationCompleteEvent extends ApplicationEvent {
    private final User user;
    public OnRegistrationCompleteEvent(final User user) {
        super(user);
        System.out.println("登录/注册了一个"+user.toString());
        this.user = user;
    }
    public User getUser() {
        return user;
    }
}

监听类：

@Component
public class EventListener implements ApplicationListener<OnRegistrationCompleteEvent> {
    @Override
    @NonNull
    public void onApplicationEvent(OnRegistrationCompleteEvent event) {
        //事件发生后回调的方法
        System.out.println("监听"+event.getUser().toString());
    }
}

事件发布者

在业务层中注入publisher

@Service
public class UserServiceImpl  implements IUserService {
@Autowired
    UserMapper userMapper;
@Autowired
private ApplicationEventPublisher publisher;

    public ResponseResult insert(User record) {
        userMapper.insert(record);
        publisher.publishEvent(new OnRegistrationCompleteEvent(record));
        return ResponseResult.success(record);
    }
    }

ApplicationEventPublisher是ApplicationContext的父接口之一。这接口的作用是：Interface that encapsulates event publication functionality.

功能就是发布事件，也就是把某个事件告诉的所有与这个事件相关的监听器。

　　

现在插入一条数据进行测试：

如果删掉 publisher.publishEvent(new OnRegistrationCompleteEvent(record));这句话会发现事件并没有被监听

改用@EventListener注解：

修改上面的监听类，不再继承ApplicationListener

@Component

public class EmailSendListener  {

    @NonNull
    @EventListener(classes=OnRegistrationCompleteEvent.class)
    public void onApplicationEvent(OnRegistrationCompleteEvent event) {
        //事件发生后回调的方法
        System.out.println("监听"+event.getUser().toString());
    }
}

再次插入数据：

一样可以起到监听作用。

总结

目前结论：需要自定义事件，监听者，发布者。
监听者类需要加@component注解交由spring管理，可以选择继承ApplicationEvent 也可以加@EventListener注解的方式
发布者发布事件后所有监听器将能接收到信息，回调监听到以后的方法
基本上牵涉到事件（Event）方面的设计，就离不开观察者模式，ApplicationContext 的事件机制主要通过 ApplicationEvent 和 ApplicationListener 这两个接口来提供的，和 Java swing 中的事件机制一样。即当 ApplicationContext 中发布一个事件时，所有扩展了 ApplicationListener 的 Bean都将接受到这个事件，并进行相应的处理。

ApplicationContext 扩展了 ResourceLoader（资源加载器）接口，从而可以用来加载多个Resource，而 BeanFactory 是没有扩展 ResourceLoader