springboot使用ApplicationListener实现观察者模式

观察者模式：当一个对象的状态发生改变时，所有依赖于它的对象都得到通知并被自动更新。例如用户注册时，好几个模块可以接收到事件，并进行各自逻辑处理。

观察者模式：https://www.runoob.com/design-pattern/observer-pattern.html

跨系统可以用消息中间件进行事件通知，本系统可以用ApplicationListener进行事件通知。

观察者模式适用范围很小，要避免刻意使用设计模式导致代码由简单变复杂。

1、监听springboot启动事件

package com.example.listener;

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

@Component
public class TestApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
    @Override
    public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
        System.out.println("contextRefreshedEvent = " + contextRefreshedEvent);
    }
}

spring还有其他许多类似event提供使用，百度。

springboot启动时会打印：

2021-07-22 14:24:33.216  INFO 7336 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
contextRefreshedEvent = org.springframework.context.event.ContextRefreshedEvent[source=org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@bcec361, started on Thu Jul 22 14:24:32 CST 2021]
2021-07-22 14:24:33.224  INFO 7336 --- [           main] com.example.SpringbootdemoApplication    : Started SpringbootdemoApplication in 1.323 seconds (JVM running for 2.017)

2、自定义观察者

定义一个事件，事件是观察者模式的核心。后续有一个推送者推送事件，一个或多个监听者监听事件。

package com.example.listener;

import org.springframework.context.ApplicationEvent;

public class NameEvent extends ApplicationEvent {
    public NameEvent(Object source) {
        super(source);
    }

    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "NameEvent{" +
                "name='" + name + '\'' +
                ", source=" + source +
                '}';
    }
}

推送者：

package com.example.controller;

import com.example.listener.NameEvent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.Map;

@Controller
public class HelloController {
    //注入就可用
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @RequestMapping("/hello")
    @ResponseBody
    public String hello(Map map){
        NameEvent nameEvent = new NameEvent("1");
        nameEvent.setName("aaaa");
        applicationEventPublisher.publishEvent(nameEvent);
        return "hello1111111132323111";
    }
}

监听者1：

package com.example.listener;

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

@Component
public class NameListener implements ApplicationListener<NameEvent> {
    @Override
    public void onApplicationEvent(NameEvent nameEvent) {
        System.out.println("nameEvent = " + nameEvent);
    }
}

监听者2：

package com.example.listener;

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

@Component
public class NameListener2 implements ApplicationListener<NameEvent> {

    @Override
    public void onApplicationEvent(NameEvent nameEvent) {
        System.out.println("nameEvent2 = " + nameEvent);
    }
}

访问http://localhost:8080/hello时日志打印：

nameEvent = NameEvent{name='aaaa', source=1}
nameEvent2 = NameEvent{name='aaaa', source=1}