springboot 自定义监听事件

事件监听模式是一种常用的设计模式，在springboot 中我们如何实现呢？

首先我们要理解事件监听中需要的几个角色

• 事件发布者 （即事件源）
• 事件监听者
• 事件本

定义事件本身

事件本身需要继承ApplicationEvent

package com.test.listener;

import org.springframework.context.ApplicationEvent;

import java.util.List;
import java.util.Map;

public class ApplicationEventTest extends ApplicationEvent {

	private String type;
	private List<Map> msg;

	public String getType() {
		return type;
	}

	public void setType(String type) {
		this.type = type;
	}

	public List<Map> getMsg() {
		return msg;
	}

	public void setMsg(List<Map> msg) {
		this.msg = msg;
	}

	public ApplicationEventTest(Object source, String type, List<Map> msg) {
		super(source);
		this.type = type;
		this.msg = msg;
	}
}

定义事件源

事件源需要注入 ApplicationContext

package com.test.listener;

import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.util.List;
import java.util.Map;

@Component
public class DemoPublisher {

	@Resource
	ApplicationContext applicationContext;

	public void publish(String type , List<Map> msg) {
		applicationContext.publishEvent(new ApplicationEventTest(this,type, msg ));
	}

}

定义监听者

监听者需要实现 ApplicationListener

package com.test.listener;

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;

@Component
public class DemoListener1 implements ApplicationListener<ApplicationEventTest> {

	@Override
	public void onApplicationEvent(ApplicationEventTest event) {
		List<Map> msg = event.getMsg();
		String type = event.getType();
		System.out.println("listener1 接收到了 publisher 发送的消息类型 :" + type +", 消息内容: " + msg);
	}

}

测试

启动类

package com.test;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 项目启动类
 */
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

Controller

package com.test.controller;

import com.test.listener.DemoPublisher;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("/demo")
public class DemoController {

	@Resource
	private DemoPublisher demoPublisher;

	@GetMapping("testListener")
	public String testListener() {
		ArrayList<Map> list = new ArrayList<>();
		HashMap<String, String> m1 =  new HashMap<>();
		m1.put("1", "2");
		HashMap<String, String> m2 =  new HashMap<>();
		m2.put("3", "4");
		HashMap<String, String> m3 =  new HashMap<>();
		m3.put("5", "6");
		list.add(m1);
		list.add(m2);
		list.add(m3);
		demoPublisher.publish("测试消息",list);
		return "消息发布成功";
	}

}

目录结构