{"id":15019356,"url":"https://github.com/likavn/eventbus","last_synced_at":"2025-04-05T05:05:25.198Z","repository":{"id":65213032,"uuid":"585961058","full_name":"likavn/eventbus","owner":"likavn","description":"eventbus基于Spring Boot Starter的分布式业务消息分发总线组件（发布/订阅模式），支持延时消息。可使用Redis、RabbitMQ、RocketMQ等任意一种做底层的消息引擎，🔝 🔝 🔝开源不易，点个Star关注更新吧。","archived":false,"fork":false,"pushed_at":"2025-03-05T10:30:10.000Z","size":1299,"stargazers_count":154,"open_issues_count":0,"forks_count":11,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T04:04:52.681Z","etag":null,"topics":["async-message","delay-event","event","eventbus","eventbus-spring-boot-starter","message-subscribe","rabbitmq","redis","rocketmq","springboot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/likavn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-06T15:04:19.000Z","updated_at":"2025-03-17T13:57:50.000Z","dependencies_parsed_at":"2023-02-17T14:00:45.712Z","dependency_job_id":"252e3318-0b38-406c-8411-30eb6801ef63","html_url":"https://github.com/likavn/eventbus","commit_stats":{"total_commits":97,"total_committers":2,"mean_commits":48.5,"dds":"0.27835051546391754","last_synced_commit":"f547a704476e94242f69204b5bb2e467246fc526"},"previous_names":["likavn/eventbus","likavn/notify-spring-boot-starter"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likavn%2Feventbus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likavn%2Feventbus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likavn%2Feventbus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/likavn%2Feventbus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/likavn","download_url":"https://codeload.github.com/likavn/eventbus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289426,"owners_count":20914464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async-message","delay-event","event","eventbus","eventbus-spring-boot-starter","message-subscribe","rabbitmq","redis","rocketmq","springboot"],"created_at":"2024-09-24T19:53:22.602Z","updated_at":"2025-04-05T05:05:25.175Z","avatar_url":"https://github.com/likavn.png","language":"Java","funding_links":[],"categories":["进程间通信"],"sub_categories":[],"readme":"![MIT](https://img.shields.io/badge/License-Apache2.0-blue.svg) ![JDK](https://img.shields.io/badge/JDK-8+-green.svg) ![SpringBoot](https://img.shields.io/badge/Spring%20Boot-2.3.0+-green.svg) ![redis](https://img.shields.io/badge/Redis-5.0+-green.svg) ![rabbitmq](https://img.shields.io/badge/RabbitMQ-3.8.0+-green.svg)![rocketmq](https://img.shields.io/badge/RocketMQ-4.0+-green.svg)\n\neventbus是基于Spring Boot Starter的分布式业务消息分发总线组件（发布/订阅模式），支持延时消息。可使用Redis、RabbitMQ、RocketMQ等任意一种做底层的消息引擎，🔝 🔝 🔝开源不易，点个Star关注更新吧。\n\nGithub项目地址：[https://github.com/likavn/eventbus](https://github.com/likavn/eventbus) \u003cbr/\u003e\nGitee项目地址：[https://gitee.com/likavn/eventbus](https://gitee.com/likavn/eventbus)\n\n## eventbus简介\n\neventbus是分布式业务消息分发总线组件，支持广播及时消息、延时消息等（即发布/订阅模式）。组件通过屏蔽底层不同种类的消息引擎，并提供统一的接口调用，可发送及时消息和延时消息，同时可订阅及时消息或延时消息等。当我们的应用引入eventbus组件时可降低系统耦合度。目前可选择基于Redis、RabbitMQ、RocketMQ等任意一种做底层的消息引擎，其他消息引擎中间件将被陆续支持。\n\n注意：它不属于`消息中间件`，它是通过和消息中间件进行整合，来完成服务之间的消息通讯，类似于消息代理。\n\n## 支持的消息中间件\n\n- Redis\n- RabbitMQ\n- RocketMQ\n\n## 有哪些特点\n\n我们不是另外开发一个MQ，而是屏蔽底层不同种类的消息中间件，并提供统一的接口调用，旨在提供简单的事件处理编程模型，让基于事件的开发更灵活简单，结构清晰易于维护，扩展方便，集成使用更简单。\n\n## 有哪些功能\n\n- 消息：支持及时消息、延时消息的投递和接收，支持通过多种方式订阅消息，可通过统一的接口和注解方式去订阅接收消息；\n- 失败重试：支持消息投递失败时投递重试，可自定义失败重试投递次数及下次投递时间；\n- 拦截器：支持全局拦截器，可自主实现拦截逻辑，支持发送前拦截（`SendBeforeInterceptor `）、发送后拦截（`SendAfterInterceptor `\n ）、投递前拦截（`DeliverBeforeInterceptor`）、投递后拦截（`DeliverAfterInterceptor`）、最后一次投递仍然失败时拦截（\n `DeliverThrowableLastInterceptor`）；\n- 消息轮询：通过注解[@Polling](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/Polling.java) 自定义消息的轮询行为；\n- 及时消息转换为延时消息：通过注解[@ToDelay](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/ToDelay.java)定义消息类型转换，支持消息发送时，将消息转换为延时消息，延时消息支持延时投递，支持延时投递时间配置；\n- 提供消息持久化示例，可参考[BsHelper](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/helper/BsHelper.java)，持久化消息投递状态，可便于后续处理；\n- 可控的消息订阅监听器开关，如通过`Nacos`下线某个服务实例时需要同时关闭消息的监听；\n- 支持无需修改代码，无缝切换消息中间件；\n- 消息中间件网络断开重连机制，支持重连；\n\n## 有哪些场景可以使用\n\n- 单一业务分发消息进行异步处理时，比如业务完成推送业务数据给第三方；\n- 支付时，后端服务需要定时轮询支付接口查询是否支付成功（可配置消息轮询）；\n- 系统业务消息传播解耦，降低消息投递和接收的复杂度（消息可靠性传递）；\n- 当我们需要切换消息中间件时，可以做到无缝切换，不需要修改业务代码；\n\n## 版本要求\n\n1. SpringBoot 2.3.0+\n2. Redis 5.0+\n3. RabbitMQ 3.8.0+\n4. RocketMQ 4.0+\n\n## 快速开始\n\n### 引入依赖\n\n项目中必须引入`eventbus-spring-boot-starter`组件依赖\u003c/br\u003e\nSpring Boot2\n\n```xml\n\u003c!-- 必须引入 eventbus-spring-boot-starter组件--\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.github.likavn\u003c/groupId\u003e\n \u003cartifactId\u003eeventbus-spring-boot-starter\u003c/artifactId\u003e\n \u003cversion\u003e2.5.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nSpring Boot3\n\n```xml\n\u003c!-- 必须引入 eventbus-spring-boot-starter组件--\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.github.likavn\u003c/groupId\u003e\n \u003cartifactId\u003eeventbus-spring-boot3-starter\u003c/artifactId\u003e\n \u003cversion\u003e2.5.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n`Json`序列化工具支持`Fast2json`、`Fastjson`、`Jackson`、`Gson`等任意一种。项目已引入`spring-boot-starter-web`时自带`Jackson`依赖，不需要单独引入其他`Json`工具依赖。如果项目中存在多个`Json`序列化工具依赖，序列化时的优先级如下:\n\n```xml\n\u003c!-- 各JSON序列化工具 任选一个--\u003e\n\u003c!-- fastjson2 --\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.alibaba.fastjson2\u003c/groupId\u003e\n \u003cartifactId\u003efastjson2\u003c/artifactId\u003e\n \u003cversion\u003e${version}\u003c/version\u003e\n\u003c/dependency\u003e\n\u003c!-- fastjson --\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.alibaba\u003c/groupId\u003e\n \u003cartifactId\u003efastjson\u003c/artifactId\u003e\n \u003cversion\u003e${version}\u003c/version\u003e\n\u003c/dependency\u003e\n\u003c!-- jackson 如果项目已引入spring-boot-starter-web，项目自带jackson依赖，不需要单独引入--\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.fasterxml.jackson.core\u003c/groupId\u003e\n \u003cartifactId\u003ejackson-databind\u003c/artifactId\u003e\n \u003cversion\u003e${version}\u003c/version\u003e\n\u003c/dependency\u003e\n\u003c!-- gson --\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003ecom.google.code.gson\u003c/groupId\u003e\n \u003cartifactId\u003egson\u003c/artifactId\u003e\n \u003cversion\u003e${version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### 设置消息中间件\n\n在application.yml文件中配置消息引擎类型，如下：\n\n```yaml\neventbus:\n type: redis #redis或者rabbitmq、rocketmq\n```\n\n#### redis\n\n使用Redis5.0 新功能Stream，Redis Stream 提供了消息的持久化和主备复制功能，可以让任何客户端访问任何时刻的数据，并且能记住每一个客户端的访问位置，还能保证消息不丢失。默认使用非阻塞轮询拉取Stream中的消息，可配置使用阻塞模式拉取消息。\n\n注：redis 5.0~\u003c6.2的版本删除过期消息是通过截取stream长度实现的，默认保留stream中的数据长度为10000条，\u003e=6.2版本时可配置消息的超时时间，默认保留5天内的消息数据。延时消息接收并处理后，默认即刻删除stream中的消息。\n\n需要在pom.xml单独引入，如下：\n\n```xml\n\u003cdependency\u003e\n \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n \u003cartifactId\u003espring-boot-starter-data-redis\u003c/artifactId\u003e\n\u003c/dependency\u003e\n\u003cdependency\u003e\n \u003cgroupId\u003eorg.apache.commons\u003c/groupId\u003e\n \u003cartifactId\u003ecommons-pool2\u003c/artifactId\u003e\n\u003c/dependency\u003e\n```\n\n#### RabbitMQ\n\n底层使用`RabbitMQ`发送延时消息时，需安装`RabbitMQ`的延时消息插件`rabbitmq_delayed_message_exchange`。\n\nrabbitmq需要在pom.xml单独引入，如下：\n\n```xml\n\u003cdependency\u003e\n \u003cgroupId\u003eorg.springframework.boot\u003c/groupId\u003e\n \u003cartifactId\u003espring-boot-starter-amqp\u003c/artifactId\u003e\n\u003c/dependency\u003e\n```\n\n#### RocketMQ\n\nrocketmq需要在pom.xml单独引入（rocketMQ会引入fastjson），如下：\n\n```xml\n\u003cdependency\u003e\n \u003cgroupId\u003eorg.apache.rocketmq\u003c/groupId\u003e\n \u003cartifactId\u003erocketmq-spring-boot-starter\u003c/artifactId\u003e\n \u003cversion\u003e2.3.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### 发送与订阅及时消息\n\n#### 显示编码\n\n发送与订阅消息都显示的指定消息编码\n\n发送消息\n\n```java\n@Resource\nprivate MsgSender msgSender;\n\n// 发送及时消息\n// 第一个参数是业务消息code\n// 第二个参数是业务消息Object实体对象数据\nmsgSender.send(\"testMsgSubscribe\", \"charging\");\n```\n\n订阅消息\n\n```java\n/**\n * 订阅及时消息\n * 继承接口【MsgListener】并设置监听的消息实体对象\n */\n@Component\n@EventbusListener(codes = \"testMsgSubscribe\")\npublic class DemoMsgListener implements MsgListener\u003cString\u003e {\n // 接收业务消息体对象数据\n @Override\n public void onMessage(Message\u003cString\u003e message) {\n String body = message.getBody();\n }\n}\n```\n\n#### 消息实体继承MsgBody接口\n\n可让消息实体继承接口`MsgBody`，并可在实体中定义消息编码（可重写code方法，也可不重写，此时默认为继承`MsgBody`接口的bean实体类名称），使得同一消息编码的消息在定义监听器或发送消息时不需要单独设置消息编码。\n\n定义消息实体\n\n```java\n@Data\npublic class TestBody implements MsgBody {\n private String content;\n\n // 可重写code方法，也可不重写，这里不重写时默认的消息编码code=TestBody （继承MsgBody接口类的名称）\n @Override\n public String code() {\n return MsgConstant.TEST_MSG_SUBSCRIBE_LISTENER;\n }\n}\n```\n\n发送消息\n\n```java\n@Resource\nprivate MsgSender msgSender;\n\n// 发送消息\nTestBody testBody = new TestBody();\ntestBody.setContent(\"这是一个测试消息！！！\");\n// 第一个参数是业务消息Object实体对象数据\nmsgSender.send(testBody);\n```\n\n订阅消息\u003c/br\u003e\n定义消息监听器（不需要指定消息编码），如下：\n\n```java\n@Slf4j\n@Component\n@EventbusListener\npublic class DemoMsgListener2 implements MsgListener\u003cTestBody\u003e {\n\n @Override\n public void onMessage(Message\u003cTestBody\u003e message) {\n TestBody body = message.getBody();\n }\n}\n```\n\n#### 指定监听器实现类\n\n发送消息\n\n```java\n// 发送消息\n@Resource\nprivate MsgSender msgSender;\n\n// 发送消息\nString testBody = \"这是一个测试消息！！！\";\n// 第一个参数是及时消息监听器实现类\n// 第二个参数是业务消息Object实体对象数据\nmsgSender.send(DemoMsgListener3.class, testBody);\n```\n\n订阅消息\u003c/br\u003e\n定义消息监听器（不需要指定消息编码，默认消息编码为监听器类名），如下：\n\n```java\n@Component\n@EventbusListener\npublic class DemoMsgListener3 implements MsgListener\u003cString\u003e {\n @Override\n public void onMessage(Message\u003cString\u003e message) {\n String body = message.getBody();\n }\n}\n```\n\n### 发送与订阅延时消息\n\n注意：当消息引擎为rocketMq时，延时时间对应为rocketMq的18个延时级别。\n\n#### 显示编码\n\n发送与订阅消息都显示的指定消息编码\n\n发送延时消息\n\n```java\n@Resource\nprivate MsgSender msgSender;\n\n// 发送延时消息\n// 第一个参数是业务消息code\n// 第二个参数是业务消息Object实体对象数据\n// 第三个参数为延时时间，单位：秒，当消息引擎为rocketMq时，延时时间对应为rocketMq的18个延时级别。\nmsgSender.sendDelayMessage(\"testMsgSubscribe\", \"charging\", 5);\n```\n\n订阅延时消息\n\n```java\n/**\n * 订阅延时消息\n * 继承接口【MsgDelayListener】并设置监听的消息实体对象\n */\n@Component\n@EventbusListener(codes = \"testMsgSubscribe\")\npublic class DemoDelayMsgListener implements MsgDelayListener\u003cString\u003e {\n // 接收业务消息体对象数据\n @Override\n public void onMessage(Message\u003cString\u003e message) {\n String body = message.getBody();\n }\n}\n```\n\n#### 消息实体继承MsgBody接口\n\n可让消息实体继承接口`MsgBody`，并可在实体中定义消息编码（可重写code方法，也可不重写，此时默认为继承`MsgBody`接口的bean实体类名称），使得同一消息编码的消息在定义监听器或发送消息时不需要单独设置消息编码。\n\n定义延时消息消息实体\n\n```java\n@Data\npublic class TestBody implements MsgBody {\n private String content;\n\n // 可重写code方法，也可不重写，这里不重写时默认的消息编码code=TestBody （继承MsgBody接口类的名称）\n @Override\n public String code() {\n return \"DelayCode\";\n }\n}\n```\n\n发送延时消息\n\n```java\n@Resource\nprivate MsgSender msgSender;\n\n// 消息实体\nTestBody testBody = new TestBody();\ntestBody.setContent(\"这是一个测试消息！！！\");\n\n// 第一个参数是业务消息Object实体对象数据\n// 第二个参数为延时时间，单位：秒，当消息引擎为rocketMq时，延时时间对应为rocketMq的18个延时级别。\nmsgSender.sendDelayMessage(testBody, 2);\n```\n\n订阅延时消息\u003c/br\u003e\n定义延时消息监听器（不需要指定消息编码），如下：\n\n```java\n@Slf4j\n@Component\n@EventbusListener\npublic class DemoDelayMsgListener2 implements MsgDelayListener\u003cTestBody\u003e {\n\n @Override\n public void onMessage(Message\u003cTestBody\u003e message) {\n TestBody body = message.getBody();\n }\n}\n```\n\n#### 指定监听器实现类\n\n发送延时消息\n\n```java\n@Resource\nprivate MsgSender msgSender;\n\n// 发送延时消息\nString testBody = \"这是一个测试消息！！！\";\n// 第一个参数是延时消息监听器实现类\n// 第二个参数是业务消息Object实体对象数据\n// 第三个参数为延时时间，单位：秒，当消息引擎为rocketMq时，延时时间对应为rocketMq的18个延时级别。\nmsgSender.sendDelayMessage(DemoDelayMsgListener3.class, testBody, 2);\n```\n\n订阅延时消息\u003c/br\u003e\n定义延时消息监听器（不需要指定消息编码，默认消息编码为监听器类名），如下：\n\n```java\n@Component\n@EventbusListener\npublic class DemoDelayMsgListener3 implements MsgDelayListener\u003cString\u003e {\n @Override\n public void onMessage(Message\u003cString\u003e message) {\n String body = message.getBody();\n }\n}\n```\n\n## 高级使用\n\n### 定义监听器\n\n使用`@EventbusListener`注解定义消息监听器，通常与`@Component`或`@Service`组合使用，提供4个参数进行配置：\n\n1. `serviceId` 消息所属来源服务ID或服务名。默认订阅本服务{@link BusConfig#getServiceId()}配置的ID，需要跨服务订阅消息时，可设置此值为对应的服务名；\n2. `codes` 消息编码数组，可订阅多个不同的业务消息；\n3. `concurrency` 消费者并发数量，及消费者数，默认：2；\n4. `retryConcurrency` 重试消息的并发数量，默认：1。\n\n如下：\n\n```java\n@Component\n@EventbusListener(\n \tserviceId = \"EBServer\", // 监听消息所属服务ID \n codes = \"testStringListener\", // 消息编码\n concurrency = 3, // 消息接收并发数量\n retryConcurrency = 2 // 重试消息并发数量)\npublic class TestStringListener implements MsgListener\u003cString\u003e {\n\n @Override\n public void onMessage(Message\u003cString\u003e message) {\n System.out.println(message.getRequestId());\n }\n}\n```\n\n### 异常捕获与重试\n\n当消息投递失败时，可以自定义消息重复投递次数和下次消息投递时间间隔（系统默认重复投递3次，每次间隔10秒），即便这样，消息还是有可能会存在投递不成功的问题，可以使用注解`@FailRetry`标识在消息处理器的接收方法上。\u003cbr/\u003e\n\n提供三个参数进行配置：\n\n1. `count` 消息投递失败时，一定时间内再次进行投递的次数，\u003ccode\u003ecount \u003c 0\u003c/code\u003e 时根据全局配置{@link BusConfig.Fail#getRetryCount()} 默认为3次；\n2. `nextTime` 投递失败时，下次投递触发的间隔时间,单位：秒，用于固定间隔时间；\n3. `interval` 定义了投递失败时，下次重试消息的时间间隔，可通过表达式（支持“+”、“-”、“*”、“/”等运算符）配置，表达式中可以使用三个变量：count（当前失败重试次数）、deliverCount（当前投递次数）和intervalTime（本次重试与上次投递的时间间隔，单位：秒）， 这使得可以灵活地根据重试次数和时间间隔来动态确定下一次重试的时间。\n\n 引用变量时使用`$`+变量名，例如`$count`。 示例：\n\n - `interval=7`表示重试间隔为7秒;\n - `interval=$count*$intervalTime`表示重试间隔为当前重试次数与上次投递的时间间隔的乘积；\n - `interval=$deliverCount * 2`表示随着投递次数增加，下次重试时间也随着递增。\n\n另外可通过编码`FailRetry.Keep.setNextTime()`方式动态设置下次重试时间，单位：秒。\n\n几种获取有效的（间隔时间\u003e0）下一次重试时间的方式，优先级从上至下：\u003c/br\u003e\n1.通过{@link FailRetry.Keep#setNextTime(long)}编码设置下次重试时间；\u003c/br\u003e\n2.通过{@link FailRetry#nextTime()}注解设置下次重试时间；\u003c/br\u003e\n3.通过{@link FailRetry#interval()}注解设置下次重试时间的表达式；\u003c/br\u003e\n4.根据全局配置{@link BusConfig.Fail#getNextTime()} 设置下次重试时间。\u003c/br\u003e\n\n如要捕获异常，需重写`failHandler`方法即可捕获投递错误异常及数据。如下：\n\n```java\n@Slf4j\n@Component\n@EventbusListener(codes = \"testMsgSubscribe\")\npublic class DemoMsgSubscribeListener implements MsgListener\u003cString\u003e {\n // 接收业务消息体对象数据\n // @FailRetry消息投递失败时重试，这里设置重试2次，下次重试间隔5秒（引擎为rocketMq时，此处延时时间对应为rocketMq的18个延时级别）后触发\n @Override\n @FailRetry(retry = 2, nextTime = 5)\n public void onMessage(Message\u003cString\u003e message) {\n String body = message.getBody();\n log.info(\"接收数据: {}\", message.getRequestId());\n // throw new RuntimeException(\"DemoMsgSubscribeListener test\");\n }\n\n /**\n * 消息投递异常捕获\n */\n @Override\n public void failHandler(Message\u003cString\u003e message, Throwable throwable) {\n log.error(\"消息投递失败！: {}，{}\", message.getRequestId(), throwable.getMessage());\n }\n}\n```\n\n### 消息轮询\n\n在消息监听器的方法上配置注解[@Polling](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/Polling.java)\n即可让同一消息重复轮询接收，可配置count（最大轮询次数，可通过编码方式`Polling.Keep.over()`\n提前终止轮询）、nextTime（下一次轮询触发的时间间隔，单位：秒，用于固定间隔时间）、interval（轮询间隔时间，单位：秒），值可以为数字也可为计算间隔时间的表达式（引用变量时使用`$`+变量名，例如`$count`）。\n\n注：`interval`表达式中可以使用以下三个变量，count（当前轮询次数）、deliverCount（当前投递次数）和intervalTime（本次轮询与上次轮询的时间间隔，单位为秒，非延时消息初始时为:1）\n\n示例：\n\n1. `interval=7`，表示轮询间隔为7秒。\n2. `interval=$count*$intervalTime`，表示轮询间隔为当前轮询次数与上次轮询的时间间隔的乘积。\n3. `interval=$deliverCount * 3`表示随着投递次数增加，下次重试时间也随着递增。\n\n另外可通过编码`Polling.Keep.setNextTime()`方式动态设置下次轮巡时间间隔，单位：秒。\n\n几种计算下一次轮巡时间的方式，优先级从上至下：\u003c/br\u003e\n1.通过{@link Polling.Keep#over()}或{@link Keep#setNextTime(long)}设置；\u003c/br\u003e\n2.通过{@link Polling#nextTime()}设置；\u003c/br\u003e\n3.通过{@link Polling#interval()}设置；\u003c/br\u003e\n\n如下：\n\n```java\n@Component\n@EventbusListener(codes = \"testMsgPolling\")\npublic class DemoMsgListener implements MsgListener\u003cTestBody\u003e {\n @Override\n @Polling(count = 2, interval = \"$count * $intervalTime + 5\")\n public void onMessage(Message\u003cTestBody\u003e message) {\n TestBody body = message.getBody();\n log.info(\"接收数据: {}\", message.getRequestId());\n // throw new RuntimeException(\"DemoMsgListener test\");\n\n if (message.getDeliverCount() \u003e 1) {\n // 终止轮询\n Polling.Keep.over();\n }\n }\n}\n```\n\n### 及时转成延时消息\n\n在及时消息监听器的方法上配置注解[@ToDelay](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/ToDelay.java) 即可让及时消息转成延时消息并接收处理。示例：[DemoMsgListener](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/DemoMsgListener.java) \u003c/br\u003e\n\n参数配置：\u003c/br\u003e\ndelayTime ：延迟时间，单位：秒。\u003c/br\u003e\nfirstDeliver ：是否需要及时消息进行首次投递，默认：false (第一次接收到及时消息时不投递，只投递延时消息）。\u003c/br\u003e\n\n```java\n/**\n * codes : 消息code\n * concurrency : 并发数\n */\n@Component\n@EventbusListener(codes = \"testMsgToDelay\")\npublic class DemoMsgListener implements MsgListener\u003cTestBody\u003e {\n\n @Override\n @ToDelay(delayTime = 3)\n public void onMessage(Message\u003cTestBody\u003e msg) {\n TestBody body = msg.getBody();\n }\n}\n```\n\n### 自定义消息ID\n\nRequestId（消息ID）默认使用UUID，若需修改为其他类型的ID，可实现接口[RequestIdGenerator](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/RequestIdGenerator.java) 时重写`nextId()`方法并配置即可。\n\n接口：\n\n```java\npublic interface RequestIdGenerator {\n /**\n * 获取请求ID\n *\n * @return 请求ID\n */\n String nextId();\n}\n```\n\n实现并配置：\n\n```java\n@Configuration\npublic class EventbusConfiguration {\n\n @Bean\n public RequestIdGenerator requestIdGenerator() throws UnknownHostException {\n Sequence sequence = new Sequence(InetAddress.getLocalHost());\n // RequestIdGenerator接口实现\n return () -\u003e String.valueOf(sequence.nextId());\n }\n}\n```\n\n### 自定义JSON序列化工具\n\n当前`Json`序列化支持`Fast2json`、`Fastjson`、`Jackson`、`Gson`等任意一种，如果当前项目同时存在相关依赖时，序列化使用的`Json`工具优先级也同上顺序。若需调整顺序或使用其他`Json`序列化工具时，可以自定义`Json`实现，需实现接口[IJson](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/support/spi/IJson.java)。\n\n接口：\n\n```java\npublic interface IJson {\n /**\n * json工具类名称,如：\"com.alibaba.fastjson2.JSON\"\n *\n * @return name\n */\n String className();\n\n /**\n * to json string\n *\n * @param value v\n * @return json str\n */\n String toJsonString(Object value);\n\n /**\n * json 转对象\n *\n * @param text text\n * @param type to bean class\n * @return bean\n */\n \u003cT\u003e T parseObject(String text, Type type);\n\n /**\n * 当存在多个可用的json工具时，优先使用order最小的\n *\n * @return order 顺序\n */\n int getOrder();\n}\n```\n\n创建JsonProvider并实现接口IJson，需重写className、toJsonString、parseObject、getOrder等方法即可，可参考[Fast2jsonProvider](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/support/Fast2jsonProvider.java)的实现，实现代码如下：\n\n```java\npublic class Fast2jsonProvider implements IJson { \n @Override\n public String className() {\n return \"com.alibaba.fastjson2.JSON\";\n }\n\n @Override\n public String toJsonString(Object value) {\n return JSON.toJSONString(value);\n }\n\n @Override\n public \u003cT\u003e T parseObject(String text, Type type) {\n return JSON.parseObject(text, type);\n }\n\n @Override\n public int getOrder() {\n return 1;\n }\n}\n```\n\n这里使用的是Java的`SPI`机制，故需在项目的`META-INF/services`目录下添加`com.github.likavn.eventbus.core.support.spi.IJson`文件，文件内容如下：\n\n```java\ncom.github.likavn.eventbus.core.support.Fast2jsonProvider\n```\n\n### 消息监听器开关\n\n可控的消息监听器开关，如通过`Nacos`下线某个服务实例时需要同时关闭消息的监听。\n\n```java\n@Resource \nMsgListenerContainer msgListenerContainer;\n\n// 打开消息监听\nmsgListenerContainer.startup();\n\n// 关闭消息监听\nmsgListenerContainer.shutdown();\n```\n\n### 切换消息中间件\n\neventbus支持多种消息引擎，如：redis、rabbitmq、rocketmq，如果项目前期使用redis，后续需要切换到rabbitmq，可不在修改代码的同时使得当前服务可以监听原有redis中的消息，配置如下：\n\n```yaml\neventbus:\n oldType: redis # 原消息引擎类别，消息引擎没做迁移时可不做配置\n type: rabbitmq # 切换后的消息引擎类别\n```\n\n### 全局消息拦截器\n\n`eventbus`提供全局的消息拦截器，包含消息发送前拦截器、消息发送后拦截器、消息投递前拦截器、消息投递后拦截器、异常重试最后一次投递仍然失败拦截器。可根据消息的重要性需求实现对应的拦截器接口，如对消息及消息的投递消费者状态进行数据库持久化操作，参考：[BsHelper](eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/helper/BsHelper.java)。\n如果存在多个同类型拦截器实例可使用[@Order](eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/Order.java)注解标识优先级。\n\n#### 发送前拦截器\n\n消息发送前拦截器：[SendBeforeInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/SendBeforeInterceptor.java)实现接口方法`execute`即可，如下示例是消息发送前持久化消息的实例代码，参考：[DemoSendBeforeInterceptor](eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoSendBeforeInterceptor.java)\n\n```java\n@Slf4j\n@Component\npublic class DemoSendBeforeInterceptor implements SendBeforeInterceptor {\n @Lazy\n @Resource\n private BsHelper bsHelper;\n\n @Override\n public void execute(Request\u003cString\u003e request) {\n // 重试时，不记录消息\n if (request.isRetry()) {\n return;\n }\n bsHelper.saveMessage(request);\n }\n}\n```\n\n#### 发送后拦截器\n\n消息发送后拦截器：[SendAfterInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/SendAfterInterceptor.java)实现接口方法`execute`即可。\n\n#### 消费前拦截器\n\n消息投递消费者前拦截器：[DeliverBeforeInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverBeforeInterceptor.java)\n实现接口方法`execute`即可，如下示例是消息消费成功后更新消息的投递状态示例代码，\n\n```java\n@Component\npublic class DemoDeliverBeforeInterceptor implements DeliverBeforeInterceptor {\n @Resource\n private BsHelper bsHelper;\n\n @Override\n public void execute(Request\u003cString\u003e request) {\n bsHelper.deliverSuccess(request);\n }\n}\n```\n\n#### 消费后拦截器\n\n消息投递消费者后拦截器：[DeliverAfterInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverAfterInterceptor.java)\n实现接口方法`execute`\n即可，如下示例是消息消费后更新消息的投递状态示例代码，参考：[DemoDeliverAfterInterceptor](eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoDeliverAfterInterceptor.java)\n\n```java\npublic class DemoDeliverAfterInterceptor implements DeliverAfterInterceptor {\n @Lazy\n @Resource\n private BsHelper bsHelper;\n\n @Override\n public void execute(Request\u003cString\u003e request, Throwable throwable) {\n // 无异常信息标识当前消息成功投递\n if (null == throwable) {\n bsHelper.deliverSuccess(request);\n return;\n }\n log.info(\"消息投递异常 execute-\u003e{}\", throwable.getMessage());\n bsHelper.deliverException(request, throwable);\n }\n}\n```\n\n#### 消费异常最后一次重试拦截器\n\n消息投递消费者失败拦截器（消息重试投递都失败时，最后一次消息投递仍然失败时会调用该拦截器）：[DeliverThrowableLastInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverThrowableLastInterceptor.java)\n实现接口方法`execute`即可，\n如下示例是消息消费失败后更新消息的投递状态示例代码，参考：[DemoDeliverThrowableLastInterceptor](eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoDeliverThrowableLastInterceptor.java)\n\n```java\n@Component\npublic class DemoDeliverThrowableLastInterceptor implements DeliverThrowableLastInterceptor {\n @Resource\n private BsHelper bsHelper;\n\n @Override\n public void execute(Request\u003cString\u003e request, Throwable throwable) {\n bsHelper.deliverException(request, throwable);\n }\n}\n```\n\n## 配置\n\n`BusProperties`，在application.yaml中eventbus配置以 `eventbus` 开头，所有配置如下：\n\n\n| 节点 | key | 数据类型 | 备注 |\n| ----------- | ------------------------------- | -------- | --------------------------------------------------------------------------------------------------------- |\n| eventbus | | | eventbus配置 |\n| eventbus | serviceId | string | 服务ID/消息来源ID，可以不用配置，默认等于${spring.application.name}的值。 |\n| eventbus | type | string | 消息引擎类别（redis、rabbitmq、rocketmq） |\n| eventbus | oldType | string | 原消息引擎类别（redis、rabbitmq、rocketmq），用于消息引擎切换时兼容原始消息，消息引擎没做迁移时可不做配置 |\n| eventbus | concurrency | int | 消息接收并发数，默认为：2 |\n| eventbus | retryConcurrency | int | 重发/重试消息接收并发数，默认为：1 |\n| eventbus | msgBatchSize | int | 单次获取消息数量，默认：16条 |\n| eventbus | testConnect | | 消息引擎服务节点联通性配置 |\n| testConnect | pollSecond | int | 轮询检测时间间隔，单位：秒，默认：35秒进行检测一次 |\n| testConnect | loseConnectMaxMilliSecond | int | 丢失连接最长时间大于等于次值设置监听容器为连接断开，单位：秒，默认：120秒 |\n| eventbus | fail | | 消息投递失败时配置 |\n| fail | retryCount | int | 消息投递失败时，一定时间内再次进行投递的次数，默认：3次 |\n| fail | nextTime | int | 失败重试下次触发时间，单位：秒，默认10秒 。（rocketMq请修改为对应为18个延时消息级别） |\n| eventbus | redis | | redis配置 |\n| redis | pollThreadPoolSize | int | 轮询时拉取Redis Stream中消息的线程池大小，默认为：2 |\n| redis | pollBlockMillis | long | 轮询时拉取Redis Stream中消息的阻塞时间，单位：毫秒，默认为：5ms |\n| redis | deliverGroupThreadPoolSize | int | 投递消息的初始化线程池大小，默认为：5 |\n| redis | deliverGroupThreadKeepAliveTime | long | 投递消息线程池中空闲线程存活时长，单位：毫秒，默认为：60s |\n| redis | deliverTimeout | int | 消息超时时间，超时消息未被确认，才会被重新投递，单位：秒，默认：5分钟 |\n| redis | pendingMessagesBatchSize | int | 未确认消息，重新投递时每次最多拉取多少条待确认消息数据，默认：100条 |\n| redis | streamExpiredHours | int | stream 过期时间，6.2及以上版本支持，单位：小时，默认：3 天 |\n| redis | streamExpiredLength | int | stream 过期数据截取，值为当前保留的消息数，5.0~\u003c6.2版本支持，单位：条，默认：10000条 |\n\n## 接口信息\n\n\n| 接口 | 说明 | 示例 |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [MsgSender](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/MsgSender.java) | 消息的生产者sender,用于消息的发送 | [TriggerController](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/controller/TriggerController.java) |\n| [MsgListener](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/MsgListener.java) | 接收及时消息的处理器接口类 | [MsgListener ](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListener.java)\u003cbr/\u003e[MsgListener2](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListener2.java) |\n| [MsgDelayListener](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/MsgDelayListener.java) | 接收延时消息的处理器接口类 | [MsgDelayListener ](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgDelayListener.java) |\n| [@EventbusListener](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/EventbusListener.java) | @EventbusListener 注解，用于标识是Eventbus消息监听器的注解 | [MsgListener ](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListener.java)\u003cbr/\u003e[MsgDelayListener ](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgDelayListener.java) |\n| [@FailRetry](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/FailRetry.java) | @FailRetry 注解，用于在接收消息投递异常时定义重试次数和下次触发时间 | [MsgListener](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListener.java) |\n| [SendBeforeInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/SendBeforeInterceptor.java) | 发送前全局拦截器 | [DemoSendBeforeInterceptor](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoSendBeforeInterceptor.java) |\n| [SendAfterInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/SendAfterInterceptor.java) | 发送后全局拦截器 | [DemoSendAfterInterceptor](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoSendAfterInterceptor.java) |\n| [DeliverBeforeInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverBeforeInterceptor.java) | 投递消费者前全局拦截器 | |\n| [DeliverAfterInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverAfterInterceptor.java) | 投递消费者后全局拦截器 | [DemoDeliverAfterInterceptor](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoDeliverAfterInterceptor.java) |\n| [DeliverThrowableLastInterceptor](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/api/interceptor/DeliverThrowableLastInterceptor.java) | 投递消费者异常全局拦截器\u003cbr/\u003e * 注：消息重复投递都失败时，最后一次消息投递失败时才会调用该拦截器 | [DemoDeliverThrowableLastInterceptor](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/interceptor/DemoDeliverThrowableLastInterceptor.java) |\n| [@ToDelay](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/ToDelay.java) | @ToDelay 注解用于接收及时消息的方法上，使得当前消息转成延时消息。 | [MsgListenerClassName](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListenerClassName.java) |\n| [@Polling](./eventbus-core/src/main/java/com/github/likavn/eventbus/core/annotation/Polling.java) | @Polling 注解用在接收消息的方法上，以控制消息订阅的轮询行为。 | [MsgListener](./eventbus-demo/springboot-demo/src/main/java/com/github/likavn/eventbus/demo/listener/MsgListener.java) |\n\n更多信息请查阅相关接口类...\n\n## 架构\n\n详情见[架构知之](./doc/架构知之.md)\n\n## 示例\n\n示例项目需配置数据库，初始化数据库sql：[demo-init.sql](./doc/sql/demo-init.sql)\n\n启动springboot-demo访问http://localhost:8080/index.html \u003cbr/\u003e\n\u003cimg src=\"./doc/picture/event_send.jpg\" alt=\"event_send\" style=\"zoom: 33%; margin-left: 0px;\" /\u003e\n\n## 注意事项\n\n**订阅、广播消息在消息引擎中是以监听器实现类全类名实现，请谨慎重新命名监听器，当我们不在需要某个监听器请及时在消息引擎中删除此分组或队列，避免不必要的存储空间浪费。消息监听器只能是及时/延时其中的一种类型，同一个消息监听器不可能同时监听及时和延时消息**\n\n## 联系我\n\n本项目会持续更新和维护，喜欢别忘了Star，有问题可通过微信、QQ及时与我联系(请备注来源平台及来意)，谢谢您的关注。\n\n微信：likavn\n\nQQ：1085257460\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flikavn%2Feventbus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flikavn%2Feventbus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flikavn%2Feventbus/lists"}