Spring的event驱动

1.目录概览

2.发布和监听事件

1.Person.java 被监听的对象

package com.sunxiansheng.user.event;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * Description: 自定义的
 * @Author sun
 * @Create 2024/7/24 14:27
 * @Version 1.0
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {

    private Integer age;

    private String name;

}

2.PersonChangeEvent.java 自定义事件对象

package com.sunxiansheng.user.event;

import lombok.Getter;
import org.springframework.context.ApplicationEvent;

/**
 * Description: 自定义的事件对象
 * @Author sun
 * @Create 2024/7/24 14:29
 * @Version 1.0
 */
@Getter
public class PersonChangeEvent extends ApplicationEvent {

    /**
     * 要观察的对象
     */
    private Person person;

    /**
     * 操作类型
     */
    private String operateType;

    public PersonChangeEvent(Person person, String operateType) {
        super(person);
        this.person = person;
        this.operateType = operateType;
    }

}

3.PersonEventPublisher.java 发布事件

package com.sunxiansheng.user.event;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

/**
 * Description: 发布事件
 * @Author sun
 * @Create 2024/7/24 14:32
 * @Version 1.0
 */
@Service
@Slf4j
public class PersonEventPublisher {

    @Resource
    private ApplicationEventPublisher applicationEventPublisher;

    /**
     * 当创建Person对象时发布事件
     * @param person
     */
    public void createPerson(Person person) {
       applicationEventPublisher.publishEvent(new PersonChangeEvent(person, "create"));
    }

    // 其他情况，发布事件

}

4.PersonEventListener.java 监听事件

package com.sunxiansheng.user.event;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.transaction.event.TransactionalEventListener;

/**
 * Description: 监听事件
 * @Author sun
 * @Create 2024/7/24 14:35
 * @Version 1.0
 */
@Service
@Slf4j
public class PersonEventListener {

    /**
     * 监听事件的方法
     * @param personChangeEvent
     */
    @TransactionalEventListener(fallbackExecution = true)
    public void listenEvent(PersonChangeEvent personChangeEvent) {
        switch (personChangeEvent.getOperateType()) {
            case "create":
                // 业务逻辑
                log.info("执行Person创建事件：{}", JSON.toJSONString(personChangeEvent.getPerson()));
                break;
            default:
                break;
        }
    }

}

5.测试

1.PersonEventListenerTest.java

package com.sunxiansheng.user.event;

import com.sunxiansheng.user.UserApplicaion;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

import static org.junit.jupiter.api.Assertions.*;

/**
 * Description: 测试发布和监听事件
 * @Author sun
 * @Create 2024/7/24 14:40
 * @Version 1.0
 */
// 指定项目启动类，并指定随机端口启动，防止与其他的东西冲突
@SpringBootTest(classes = UserApplicaion.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
// 规定配置
@RunWith(SpringRunner.class)
@Slf4j
class PersonEventListenerTest {

    @Resource
    private PersonEventPublisher personEventPublisher;

    @Test
    void listenEvent() {
        personEventPublisher.createPerson(new Person(1, "sun"));
    }
}

2.结果

3.异步发布和监听事件

1.Person.java 不变

package com.sunxiansheng.user.event;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * Description: 自定义的
 * @Author sun
 * @Create 2024/7/24 14:27
 * @Version 1.0
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {

    private Integer age;

    private String name;

}

2.PersonChangeEvent.java 不变

package com.sunxiansheng.user.event;

import lombok.Getter;
import org.springframework.context.ApplicationEvent;

/**
 * Description: 自定义的事件对象
 * @Author sun
 * @Create 2024/7/24 14:29
 * @Version 1.0
 */
@Getter
public class PersonChangeEvent extends ApplicationEvent {

    /**
     * 要观察的对象
     */
    private Person person;

    /**
     * 操作类型
     */
    private String operateType;

    public PersonChangeEvent(Person person, String operateType) {
        super(person);
        this.person = person;
        this.operateType = operateType;
    }

}

3.AsyncConfig.java 配置异步线程池+开启异步事件

package com.sunxiansheng.user.event.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Executor;
/**
 * 配置异步线程池+开启异步事件
 */
@Configuration
// 开启异步事件
@EnableAsync
public class AsyncConfig {

    @Bean(name = "taskExecutor")
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(5);
        executor.setMaxPoolSize(10);
        executor.setQueueCapacity(500);
        executor.setThreadNamePrefix("Async-");
        executor.initialize();
        return executor;
    }
}

4.PersonEventPublisher.java 不变

package com.sunxiansheng.user.event;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

/**
 * Description: 发布事件
 * @Author sun
 * @Create 2024/7/24 14:32
 * @Version 1.0
 */
@Service
@Slf4j
public class PersonEventPublisher {

    @Resource
    private ApplicationEventPublisher applicationEventPublisher;

    /**
     * 当创建Person对象时发布事件
     * @param person
     */
    public void createPerson(Person person) {
       applicationEventPublisher.publishEvent(new PersonChangeEvent(person, "create"));
    }

    // 其他情况，发布事件

}

5.PersonEventListener.java 使用自定义线程池进行异步处理

package com.sunxiansheng.user.event;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
import org.springframework.transaction.event.TransactionalEventListener;

/**
 * Description: 监听事件
 * @Author sun
 * @Create 2024/7/24 14:35
 * @Version 1.0
 */
@Service
@Slf4j
public class PersonEventListener {

    /**
     * 监听事件的方法
     * @param personChangeEvent
     */
    @Async("taskExecutor")
    @TransactionalEventListener(fallbackExecution = true)
    public void listenEvent(PersonChangeEvent personChangeEvent) {
        switch (personChangeEvent.getOperateType()) {
            case "create":
                // 业务逻辑
                log.info("执行Person创建事件：{}，处理的线程：{}", JSON.toJSONString(personChangeEvent.getPerson()),
                        Thread.currentThread().getName());
                break;
            default:
                break;
        }
    }

}

6.测试结果