Spring中的事件机制-ApplicationEventPublisher

Spring的Application拥有事件发布并且注册事件监听器的能力，拥有一套完整的事件发布与监听机制。在Java中，通过java.util.EventObject来描述事件，通过java.util.EventListner来描述事件监听器，在众多的框架中，建立一套事件发布监听机制通常基于这两个接口来扩展实现 。

主要用于系统的解耦.是观察者observe模式的一种体现。

这种场景在框架中很常见，比如在Eureka Server中的EurekaInstanceRegisteredEvent等事件可以用来扩展，监听服务端instance的一些状态。

步骤：

• 主要用于系统的解耦.是观察者observe模式的一种体现。
• 触发event 通过ApplicationEventPublisher发布event。this.ctxt.publishEvent(applicationEvent);
• 建立listener EurekaInstanceRegisteredEventListener implements ApplicationListener 。或者可以用Spring 的 @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)可以监听事务提交事件。

代码如下：

UserActionEvent 类

public class UserActionEvent extends ApplicationEvent {

    private User user;

    private Boolean success;

    private EnumUserOperate enumUserOperate; // 枚举类型

    public UserActionEvent(Object source){
        super(source);
    }

    public User getUser() {
        return user;
    }

    public void setUser(User user) {
        this.user = user;
    }

    public Boolean getSuccess() {
        return success;
    }

    public void setSuccess(Boolean success) {
        this.success = success;
    }

    public EnumUserOperate getEnumUserOperate() {
        return enumUserOperate;
    }

    public void setEnumUserOperate(EnumUserOperate enumUserOperate) {
        this.enumUserOperate = enumUserOperate;
    }
}

EnumUserOperate类

@Data
public enum EnumUserOperate {
ADD("add",1,"新增"),
 UPDATE("update",2,"修改"),
 DELETE("delete",0,"删除");
    
 private String name;
 private Integer value;
 private String desc;
}

UserService类

@Service
@Slf4j
public class UserService {
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    public User addUser(User user){
        UserActionEvent userActionEvent = new UserActionEvent(this);
        userActionEvent.setUser(new User("zhanhgsan",12,"123"));
        userActionEvent.setEnumUserOperate(EnumUserOperate.ADD);
        userActionEvent.setSuccess(true);

        applicationEventPublisher.publishEvent(userActionEvent);

        log.info("发布事件"+userActionEvent);
        return user;

    }
}

UserController类：

@Component
@Slf4j
@RestController
public class UserController {
    @Autowired
    private UserService userService;
    @Async
    @EventListener(value = UserActionEvent.class,condition = "#actionEvent.enumUserOperate.name()=='ADD'")
    public UserActionEvent addUserEvent(UserActionEvent actionEvent){
        try{
            User user = actionEvent.getUser();
            log.info("监听到的用户：{}"+user);
            log.info("此处可操作：发送邮件 赠送用户体验");
        }catch (Exception e){
            log.error("事件：{},执行异常",actionEvent,e.getMessage());
            return actionEvent;
        }
        return null;
    }
    @PostMapping("/add")
    public User addUser(@RequestBody User user){
        return userService.addUser(user);
    }
}

代码运行结果：