spring中,使用事件发布功能

  • 自定义事件
import org.springframework.context.ApplicationEvent;

/**
 * @Author osy
 * @Date 2022/1/30
 * @Description: TODO
 **/
public class MyEvent extends ApplicationEvent {
    /**
     * Create a new {@code ApplicationEvent}.
     *
     * @param source the object on which the event initially occurred or with
     *               which the event is associated (never {@code null})
     */
    public MyEvent(Object source) {
        super(source);
    }
}
  • 自定义监听器,监听我们自定义的事件
import com.xfr.event.MyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

/**
 * @Author osy
 * @Date 2022/1/29
 * @Description: TODO
 **/
@Component
public class MyApplicationListener implements ApplicationListener<MyEvent> {

	@Override
	public void onApplicationEvent(MyEvent event) {
		System.out.println("资源" + event.getSource());
		System.out.println("事件:" + event.toString());
	}
}
  • 封装SpringContextUtils,以便于使用上下文对象:ApplicationContext,封装publishEvent方法

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ApplicationEvent;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.Optional;

/**
 * @Author osy
 * @Date 2022/1/29
 * @Description: TODO
 **/
@Component
public class SpringContextUtils implements ApplicationContextAware {


    /**
     * Spring应用上下文环境
     */
    private static ApplicationContext applicationContext;

    public static String getBeanName(Class clazz) {
        String[] beanNamesForType = applicationContext.getBeanNamesForType(clazz);
        if(beanNamesForType.length > 0){
            return beanNamesForType[0];
        }
        return null;
    }

    /**
     * 实现ApplicationContextAware接口的回调方法,设置上下文环境
     *
     * @param applicationContext
     * @throws BeansException
     */
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Optional.ofNullable(applicationContext).orElse(SpringContextUtils.applicationContext = applicationContext);
    }

    /**
     * @return ApplicationContext
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }


    public static void publishEvent(ApplicationEvent event){
        applicationContext.publishEvent(event);
    }



    /**
     * 获取对象
     *
     * @param name
     * @return Object 一个以所给名字注册的bean的实例
     * @throws BeansException
     */
    public static Object getBean(String name) throws BeansException {
        return applicationContext.getBean(name);
    }

    public static <T> T getBean(Class<T> aClass) {
        return applicationContext.getBean(aClass);
    }

    /**
     * 获取类型为requiredType的对象 如果bean不能被类型转换,相应的异常将会被抛出(BeanNotOfRequiredTypeException)
     *
     * @param name         bean注册名
     * @param requiredType 返回对象类型
     * @return Object 返回requiredType类型对象
     * @throws BeansException
     */
    public static <T> T getBean(String name, Class<T> requiredType) throws BeansException {
        return applicationContext.getBean(name, requiredType);
    }

    /**
     * 如果BeanFactory包含一个与所给名称匹配的bean定义,则返回true
     *
     * @param name
     * @return boolean
     */
    public static boolean containsBean(String name) {
        return applicationContext.containsBean(name);
    }

    /**
     * 判断以给定名字注册的bean定义是一个singleton还是一个prototype。
     * 如果与给定名字相应的bean定义没有被找到,将会抛出一个异常(NoSuchBeanDefinitionException)
     *
     * @param name
     * @return boolean
     * @throws NoSuchBeanDefinitionException
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.isSingleton(name);
    }

    /**
     * @param name
     * @return Class 注册对象的类型
     * @throws NoSuchBeanDefinitionException
     */
    public static Class getType(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.getType(name);
    }

    /**
     * 如果给定的bean名字在bean定义中有别名,则返回这些别名
     *
     * @param name
     * @return
     * @throws NoSuchBeanDefinitionException
     */
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException {
        return applicationContext.getAliases(name);
    }

    /**
     * 返回环境对象,可以获取一些系统配置或者我们自己的配置
     *
     * @return
     */
    public static Environment getEnvironment() {
        return applicationContext.getEnvironment();
    }

    // 用于查找bean类上面是否有我们指定的注解。看到这里我倒是突发奇想:
    // 我们是不是可以对其进行开发的约束,比如对所有contronller里面的,都必须打上controller注解。
    // 当然这只是一个个人想法。不喜勿喷
    public static <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType)
            throws NoSuchBeanDefinitionException {
        return applicationContext.findAnnotationOnBean(beanName, annotationType);
    }

    /**
     * 返回本地bean工厂是否包含给定名称的bean,忽略祖先上下文中定义的bean
     *
     * @param name
     * @return
     */
    public static boolean containsLocalBean(String name) {
        return applicationContext.containsLocalBean(name);
    }

    /**
     * 将给定的位置模式解析为资源对象。
     *
     * @param locationPattern
     * @return
     * @throws IOException
     */
    public static Resource[] getResources(String locationPattern) throws IOException {
        return applicationContext.getResources(locationPattern);
    }
  • 发布事件
import com.xfr.event.MyEvent;
import com.xfr.extension.SpringContextUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author osy
 * @Date 2022/1/30
 * @Description: TODO
 **/
@RestController
public class EventController {

    @GetMapping("event")
    public String event(String eventName){
        // 发布一个事件
        SpringContextUtils.publishEvent(new MyEvent(eventName));

        return "success";
    }

}
  • 最后看到监听器打印出来的数据如下

在这里插入图片描述

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring事件发布器是Spring框架的一个重要组件,用于实现事件发布与订阅功能。它是基于观察者模式设计的,可以在应用程序实现模块之间的解耦,提高代码的可维护性和可扩展性。 Spring事件发布器的工作原理如下:首先,我们需要定义一个事件类,这个事件类可以是继承自ApplicationEvent类的自定义事件,也可以是Spring提供的一些内置事件,例如ContextStartedEvent、ContextClosedEvent等。然后,我们需要创建一个事件发布器,这个发布器可以是实现了ApplicationEventPublisher接口的类,也可以是Spring提供的实现类如ApplicationContext或ApplicationEventMulticaster等。在需要发布事件的地方,我们可以通过事件发布器的publishEvent方法来发布事件,同时,订阅了该事件的观察者会自动接收到事件通知并做出相应的处理。 Spring事件发布器的优势在于它提供了一种灵活的解耦方式,可以将应用程序的各个模块进行解耦,降低了模块之间的直接依赖关系,使得代码更加灵活、可扩展。另外,Spring事件发布器还提供了多线程的异步事件处理能力,可以在事件发布后,由不同的线程异步处理事件,提高了程序的性能。 总而言之,Spring事件发布器是一个非常强大的工具,可以帮助我们实现模块之间的解耦和事件触发处理,提高了程序的可维护性和可扩展性。在实际应用,我们可以根据具体需求选择合适的事件类和事件发布器来实现事件发布与订阅功能

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值