Spring 事件通知

Spring事件通知

1.编写自定义的事件载体对象

1. /**
2. * @Author:qmfang
3. * @Description: 继承自事件对象，表明将其作为一个事件通知对象
4. * @Date:Created in 10:35 2018/4/8
5. * @Modified By:
6. */
7. @Data
8. public class BlackListEvent extends ApplicationEvent {
10. private final String address;
11. private final String test;
13. public BlackListEvent(Object source, String address, String test) {
14. super(source);
15. this.address = address;
16. this.test = test;
17. }
18. }

2.编写事件触发对象

1. /**
2. * @Author:qmfang
3. * @Description: 实现以aware结尾的接口之后在bean被实例化之后会Spring会注入相应的资源
4. * @Date:Created in 10:37 2018/4/8
5. * @Modified By:
6. */
7. public class EmailService implements ApplicationEventPublisherAware {
9. private List<String> blackList;
10. private ApplicationEventPublisher publisher;
12. public void setBlackList(List<String> blackList) {
13. this.blackList = blackList;
14. }
16. @Override
17. public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
18. /**
19. * 此处也就是注册进入应用事件发布对象
20. */
21. this.publisher = applicationEventPublisher;
22. }
24. public void sendEmail(String address, String test) {
25. if (blackList.contains(address)) {
26. /**
27. * 如果是包含的地址将发布该消息
28. */
29. BlackListEvent event = new BlackListEvent(this, address, test);
30. publisher.publishEvent(event);
31. return;
32. }
33. }
34. }

3.编写相应的事件监听对象

1. /**
2. * @Author:qmfang
3. * @Description: 实现ApplicationListener的接口将监听相应的事件，当有事件时，将触发onApplicationEvent方法
4. * @Date:Created in 10:44 2018/4/8
5. * @Modified By:
6. */
7. public class BlackListNotifier implements ApplicationListener<BlackListEvent> {
9. @Override
10. public void onApplicationEvent(BlackListEvent event) {
11. System.out.println("应用事件:" + event);
12. }
14. }

4.将相应的对象注入到容器

1. /**
2. * @Author:qmfang
3. * @Description:
4. * @Date:Created in 9:58 2018/4/8
5. * @Modified By:
6. */
7. @Configuration
8. public class MvcConfig {
10. @Bean
11. public EmailService emailService() {
12. EmailService emailService = new EmailService();
13. List list = Arrays.asList("known.spammer@example.org", "known.hacker@example.org", "john.deo@example.org");
14. emailService.setBlackList(list);
15. return emailService;
16. }
18. @Bean
19. public BlackListNotifier blackListNotifier() {
20. BlackListNotifier blackListNotifier = new BlackListNotifier();
21. return blackListNotifier;
22. }
24. }

4.编写测试

1. @RestController
2. public class TestController {
4. @Autowired
5. private EmailService emailService;
7. /**
8. * 127.0.0.1:8886/test
9. *
10. * @return
11. */
12. @GetMapping("/test")
13. public Object get() {
14. emailService.sendEmail("known.spammer@example.org", "test@test");
15. return "hello";
16. }
18. }

基于注解的事件处理

基于注解的可以将BlackListNotifier修改为如下形式

1. /**
2. * @Author:qmfang
3. * @Description: 实现ApplicationListener的接口将监听相应的事件，当有事件时，将触发onApplicationEvent方法
4. * @Date:Created in 10:44 2018/4/8
5. * @Modified By:
6. */
7. public class BlackListNotifier {
9. /**
10. * 也可以基于注解的形式 参数表名了需要监听的事件类型
11. *
12. * @param event
13. */
14. @EventListener
15. public void onApplicationEvent(BlackListEvent event) {
16. System.out.println("应用事件:" + event);
17. }
19. /**
20. * 如果方法需要监听好几个事件，或者如果定义的方法没有任何参数,也可以在注解自身上指定事件类型
21. */
22. @EventListener({ContextStartedEvent.class, ContextRefreshedEvent.class})
23. public void handleContextStart() {
24. System.out.println("监听到事件");
25. }
27. /**
28. * 也可以通过定义SpEL表达式的注解condition属性添加额外的运行时过滤，
29. * 他们应该匹配以实际调用特定事件的方法，例如如果事件的test属性等于foo
30. * 才回调该方法
31. * <p>
32. * SpEL可用的元数据
33. * 名字 位置 描述 例子
34. * Event事件 根对象 实际应用事件 #root.event
35. * Arguments array参数数组 根对象 用于目标数组 #root.args[0]
36. * Argumentname参数名称 评估上下文 任意方法参数的名字
37. */
38. @EventListener(condition = "#event.test=='foo'")
39. public void onApplicationEvent2(BlackListEvent event) {
40. System.out.println("应用事件2:" + event);
41. }
43. /**
44. * 如果需要发布一个事件作为另一个事件的结果，只需要更改方法签名返回应该发布的事件即可
45. * 注意点是：异步事件不支持此功能
46. */
47. @EventListener
48. public OtherEvent handlerBlackListEvent(BlackListEvent event) {
50. }
52. }

转载出处：https://blog.youkuaiyun.com/fang_qiming/article/details/79849394