SpringBoot使用自定义事件监听器的demo

最新推荐文章于 2023-09-13 17:02:22 发布
最新推荐文章于 2023-09-13 17:02:22 发布
阅读量441 收藏
点赞数
分类专栏： SpringBoot+Demo 文章标签： SpringBoot监听器 自定义监听器 Spring监听器 自定义事件监听
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/myyhtw/article/details/131864725
版权

记录一下SpringBoot自定义事件监听器的使用方法

案例源码:SpringBoot使用自定义事件监听器的demo

使用的SpringBoot2.0.x版本

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

自定义事件监听： 自定义事件 和 自定义监听两部分

自定义事件
继承自ApplicationEvent抽象类，定义自己的构造器

自定义监听
实现ApplicationListener接口，然后实现onApplicationEvent方法

首先自定义事件
ApplicationEvent抽象类
myw
实现继承，用对象方式，新建对象

DemoUser.java

package boot.example.event.events;

public class DemoUser {

    private String username;

    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

EventDemoUser.java

package boot.example.event.events;

import org.springframework.context.ApplicationEvent;

public class EventDemoUser extends ApplicationEvent {

    private final DemoUser demoUser;

    public EventDemoUser(Object source, DemoUser demoUser) {
        super(source);
        this.demoUser = demoUser;
    }

    public DemoUser getDemoUser() {
        return demoUser;
    }
}

ApplicationListener接口
myw
自定义监听类
EventDemoUserListener.java

package boot.example.event.listener;

import boot.example.event.events.EventDemoUser;
import org.springframework.context.ApplicationListener;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;

//  将监听器装载入spring容器
@Component
//@Service
public class EventDemoUserListener implements ApplicationListener<EventDemoUser> {

    @Async
    @Override
    public void onApplicationEvent(EventDemoUser eventDemoUser) {
        System.out.println("自定义事件监听器（EventDemoUserListener）收到发布的消息: " + eventDemoUser.getDemoUser().getUsername());
        System.out.println("自定义事件监听器（EventDemoUserListener）收到发布的消息: " + eventDemoUser.getDemoUser().getPassword());
    }
}

我这里使用接口的方式来触发
EventDemoUserController.java

package boot.example.event.controller;

import boot.example.event.events.DemoUser;
import boot.example.event.events.EventDemo;
import boot.example.event.events.EventDemoUser;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
@RequestMapping(value="/eventDemoUser")
public class EventDemoUserController {

	@Resource
	private ApplicationContext applicationContext;

	@RequestMapping(value="/test1")
	public String test1() {
		DemoUser demoUser = new DemoUser();
		demoUser.setUsername("admin");
		demoUser.setPassword("123456");

		applicationContext.publishEvent(new EventDemoUser(this, demoUser));
		return "testEventDemo";
	}

	@Resource
	private ApplicationEventPublisher applicationEventPublisher;

	@RequestMapping(value="/test2")
	public String test2() {
		DemoUser demoUser = new DemoUser();
		demoUser.setUsername("admin2");
		demoUser.setPassword("654321");

		applicationContext.publishEvent(new EventDemoUser(this, demoUser));
		return "testEventDemo";
	}

}

这里使用了两种触发方式

@Resource
private ApplicationContext applicationContext;

@Resource
private ApplicationEventPublisher applicationEventPublisher;

控制台输出查看
myw
自定义监听的几种方式

1.启动时手动向ApplicationContext中添加监听器

EventDemo.java

package boot.example.event.events;

import org.springframework.context.ApplicationEvent;

public class EventDemo extends ApplicationEvent {

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

AppEventDemo.java

package boot.example.event;

import boot.example.event.listener.EventDemoListener1;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.scheduling.annotation.EnableAsync;

@SpringBootApplication
@EnableAsync
public class AppEventDemo {

    public static void main( String[] args ) {
        ConfigurableApplicationContext context = SpringApplication.run(AppEventDemo.class, args);

        // 手动向ApplicationContext中添加监听器
        context.addApplicationListener(new EventDemoListener1());
        System.out.println( "Hello World!" );
    }

    //  事件监听，自定义事件和自定义监听器类
    //  自定义事件：继承自ApplicationEvent抽象类，定义自己的构造器
    //  自定义监听：实现ApplicationListener接口，实现onApplicationEvent方法



}

EventDemoListener1.java

package boot.example.event.listener;

import boot.example.event.events.EventDemo;
import org.springframework.context.ApplicationListener;

//  手动向ApplicationContext中添加监听器  不要@Component注解就能监听到
public class EventDemoListener1 implements ApplicationListener<EventDemo> {

    @Override
    public void onApplicationEvent(EventDemo eventDemo) {
        Object msg = eventDemo.getSource();
        System.out.println("自定义事件监听器（MyEventListener1）收到发布的消息: " + msg);
    }
}

2.使用@Component注解自动监听

EventDemoListener2.java

package boot.example.event.listener;

import boot.example.event.events.EventDemo;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;


//  将监听器装载入spring容器
@Component
public class EventDemoListener2 implements ApplicationListener<EventDemo> {
    @Override
    public void onApplicationEvent(EventDemo eventDemo) {
        Object msg = eventDemo.getSource();
        System.out.println("自定义事件监听器（MyEventListener2）收到发布的消息: " + msg);
    }
}

3.在application.properties中配置监听器,可以不用注解

EventDemoListener3.java

package boot.example.event.listener;

import boot.example.event.events.EventDemo;
import org.springframework.context.ApplicationListener;


//  在application.properties中配置监听器,可以不用注解
public class EventDemoListener3 implements ApplicationListener<EventDemo> {
    @Override
    public void onApplicationEvent(EventDemo eventDemo) {
        Object msg = eventDemo.getSource();
        System.out.println("自定义事件监听器（MyEventListener3）收到发布的消息: " + msg);
    }

}

application.properties配置

context.listener.classes=boot.example.event.listener.EventDemoListener3

4.通过@EventListener注解实现事件监听(使用最方便)

EventDemoListener4.java

package boot.example.event.listener;

import boot.example.event.events.EventDemo;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;


//  通过@EventListener注解实现事件监听
@Component
public class EventDemoListener4 {
    @EventListener
    public void listener(EventDemo eventDemo) {
        Object msg = eventDemo.getSource();
        System.out.println("自定义事件监听器（MyEventListener4）收到发布的消息: " + msg);
    }

}

触发监听

EventDemoController .java

package boot.example.event.controller;

import boot.example.event.events.EventDemo;
import org.springframework.context.ApplicationContext;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
@RequestMapping(value="/eventDemo")
public class EventDemoController {

	@Resource
	private ApplicationContext applicationContext;

	@RequestMapping(value="/test")
	public String test() {
		applicationContext.publishEvent(new EventDemo("测试监听事件"));
		return "testEventDemo";
	}
}

控制台查看 四种方式执行默认是有先后顺序的
myw
还有一种方式 这种方式使用更方便

DemoRole.java 和 DemoUser.java

package boot.example.event.events;

public class DemoRole {

    private Integer roleId;

    private String roleName;

    public Integer getRoleId() {
        return roleId;
    }

    public void setRoleId(Integer roleId) {
        this.roleId = roleId;
    }

    public String getRoleName() {
        return roleName;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }
}


package boot.example.event.events;

public class DemoUser {

    private String username;

    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

监听类EventDemoListenerMultiple.java

package boot.example.event.listener;


import boot.example.event.events.DemoRole;
import boot.example.event.events.DemoUser;
import org.springframework.context.event.EventListener;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;

@Component
//@Service
public class EventDemoListenerMultiple {

    @Async
    @EventListener(DemoUser.class)
    public void listenerDemoUser(DemoUser demoUser) {
        String name = demoUser.getUsername();
        System.out.println("listenerDemoUser---"+name);
    }

    @Async
    @EventListener(DemoRole.class)
    public void listenerDemoUser(DemoRole demoRole) {
        String name = demoRole.getRoleName();
        System.out.println("listenerDemoUser---"+name);
    }

}

监听器触发类EventDemoMultipleController.java

package boot.example.event.controller;

import boot.example.event.events.DemoRole;
import boot.example.event.events.DemoUser;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;

@RestController
@RequestMapping(value="/eventDemo")
public class EventDemoMultipleController {

	@Resource
	private ApplicationContext applicationContext;

	@RequestMapping(value="/demoUser")
	public String demoUser() {
		DemoUser demoUser = new DemoUser();
		demoUser.setUsername("admin");
		demoUser.setPassword("123456");

		applicationContext.publishEvent(demoUser);
		return "testEventDemo";
	}

	@Resource
	private ApplicationEventPublisher applicationEventPublisher;

	@RequestMapping(value="/demoRole")
	public String demoRole() {
		DemoRole demoRole = new DemoRole();
		demoRole.setRoleId(4);
		demoRole.setRoleName("角色");

		applicationContext.publishEvent(demoRole);
		return "testEventDemo";
	}

}

Servlet渐渐地淡出视野，也记录一下使用

CustomServletContextListener.java

package boot.example.event.config;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;


/**
 *  servelt的监听器
 */
@WebListener
public class CustomServletContextListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        //  SpringBoot WEB启动间执行一次
        System.out.println("CustomServletContextListener--contextInitialized");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        //  SpringBoot WEB销毁执行
        System.out.println("CustomServletContextListener--contextDestroyed");
    }


}

在启动类加上扫描注解

@ServletComponentScan("boot.example.event.config")

项目结构
myw

记录到此！

蚂蚁舞
关注
专栏目录
SpringBoot : SpringBoot自定义的ApplicationContext实现类
九师兄
01-11 1115
1.美图 2.概述 在学习spring容器初始化的过程中，发现spring容器预留了一些扩展点，我们可以写子类来做功能扩展，例如AbstractApplicationContext类的initPropertySources、postProcessBeanFactory、onRefresh等方法都是空方法，留给子类来扩展用。 3.在传统spring框架下的扩展方式 传统的spring框架下使用哪个...
SpringBoot 自定义事件
风雨踏梦行
06-27 1144
1 . 自定义事件需要继承 ApplicationListener 重写 onApplicationEvent 例如 : @Component public class TestEventApp implements ApplicationListener { @Override public void onApplicationEvent(ApplicationEv...
SpringBoot Event Demo【QuickStart】
qq_17303159的博客
01-08 160
项目结构 公共配置 pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.ap
Spring事件监听Demo
weixin_34029680的博客
03-15 99
Spring事件监听实现了观察者模式。本Demo在junit4测试环境中实现 主要有三个类事件类、监听器类、事件发布类（入口） 事件类必须继承 ApplicationEvent，代码如下： import org.junit.runner.RunWith; import org.springframework.context.ApplicationEvent; import org.s...
springboot事件监听demo
最新发布
qq_14955661的博客
09-13 82
【代码】springboot事件监听demo。
SpringBoot--自定义事件--同步与异步
IT利刃出鞘的博客
11-09 1954
原文网址： 简介 说明 本文用示例介绍SpringBoot中的事件的用法及原理。 SpringBoot的启动过程用到了事件监听机制，它属于观察者模式。学习事件监听机制可以让我们更好地理解SpringBoot的启动流程，也有利于将观察者模式应用于项目。 事件监听简述 事件的发布与监听从属于观察者模式；和MQ相比，事件的发布与监听偏向于处理“体系内”的某些逻辑。 多个监听器可以监听同一个事件。例如：发布了事件A，监听器A和监听器B都.........
Spring 监听事件Demo
weixin_45589671的博客
08-26 317
####本篇文章主要介绍spring 监听事件 同步和异步的方法 1：先定义一个事件本身 extends ApplicationEvent类 代码如下： /** * 事件类 */ @Setter@Getter@ToString public class IEvent extends ApplicationEvent { private Long id; private String name; /** * Create a new ApplicationEvent.
SpringBoot（十六）自定义事件监听
yhahaha_的博客
04-20 2336
SpringBoot版本：2.1.1 相信走完SpringBoot2.1.1启动流程分析以后，对事件应该是很熟悉了。 监听实现方式 1、在SpringApplication的构造方法中就会从META-INF/spring.factories得到ApplicationListener的实现类对象集合。 2、在发布ApplicationEnvironmentPreparedEvent事件时De...
【SpringBoot】自定义监听器
好学若饥，谦卑若愚
08-07 1596
前言 可以通过自定义监听器，监听系统中的某些事件，在某些系统事件执行之后，触发自己业务内容执行。 内容 第一种 实现ApplicationListener接口，spring.factories内填写接口实现，key值为org.springframework.context.ApplicationListener package com.mooc.sb2.listener; import org.springframework.boot.context.event.ApplicationStar
SpringBoot(13)过滤器+拦截器+监听器
weixin_38380811的博客
03-31 1460
SpringBoot(12)过滤器+拦截器+监听器
springboot整合netty的demo
01-22
为了实现SpringBoot与Netty的交互，我们还需要创建一个`WebFluxConfigurer`的实现类，重写`addtolisteners()`方法，将Netty的`HttpServer`实例注册为监听器。同时，通过`WebFluxConfig`可以定制Reactor Netty的相关...
springboot-监听器，过滤器，拦截器，aop,自定义注解
2010yhh
11-12 3306
springboot基础-监听器，过滤器，拦截器，aop,自定义注解 环境 idea2018，jdk1.8， springboot版本：1.5.9.RELEASE 代码下载： https://github.com/2010yhh/springBoot-demos.git 测试:启动项目后，访问： http://localhost:8080/springboot-demo2/test1 ...
springboot 2.x整合rabbitmq之使用自定义Listener
adminit的博客
03-30 2304
1、在pom.xml中引入相关依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation...
Springboot - 自定义事件
简简单单Onlinezuozuo
07-18 4190
文章目录Springboot - 自定义事件1、自定义一个事件2、编写监听者3、编写测试代码 Springboot - 自定义事件 1、自定义一个事件 public class CustomEvent extends ApplicationEvent { public CustomEvent(Object source) { super(source); } ...
springboot 自定义监听事件
g56467467464的博客
04-03 890
事件监听模式是一种常用的设计模式，在springboot 中我们如何实现呢？ 首先我们要理解事件监听中需要的几个角色 事件发布者 （即事件源） 事件监听者 事件本 定义事件本身 事件本身需要继承ApplicationEvent package com.test.listener; import org.springframework.context.ApplicationEvent; ...
SpringBoot 自定义事件及自定义监听
david-lee的博客
05-31 499
首先自定义事件 首先介绍下用到此功能的场景： 我这里有个需求在用户信息修改后，可能触发一系列的其他操作，所以想到了观察者模式，又找了些帖子，springboot中可以通过发布事件，然后通过监听器监听到后，在进行业务处理。 首先进行定义一个事件 import lombok.Getter; import org.springframework.context.ApplicationEvent; /** * 用户信息改变事件--就是个标志 * 不局限于服务的启动，而是在特定的场景下面触发 * * @
SpringBoot下使用自定义监听事件
flash_love的博客
08-05 1099
Component// 异步处理@Async@Overridelog.info("监听到事件--邮箱地址:" + event.getEmailAddress());//模拟处理的耗时3stry {log.info("事件处理完成");Spring的事件机制是一个很实用的一个功能，在监听和异步处理相关的功能比较适合。
SpringBoot自定义事件发布
hxt的博客
05-17 1056
1、自定义事件 Spring中自定义事件需要继承ApplicationEvent /** * 自定义事件,继承ApplicationEvent */ @Data public class MailSendEvent extends ApplicationEvent { private String to; private String message; public MailSendEvent(Object source, String to, String message)
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值