2 Star 11 Fork 4

开源小分队 / rocketONS-starter

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

rocketONS-starter

License Gitee Stars Gitee fork

介绍

rocketONS-starter 是一个基于阿里云ONS消息服务的轻量级Spring Boot Starter。它为您提供了一个简单高效的封装,使您能够快速创建RocketMQ生产者和消费者,实现应用之间的消息传递。适用于高并发、高吞吐、低延迟的分布式消息场景。

软件架构

rocketONS-starter 基于Spring的ApplicationContext容器管理,自动扫描consumer监听器,并注册启动消费者,用于接收和处理来自阿里云ONS服务分发的消息。根据配置文件动态创建消费者和生产者,自定义消费者的启停开关,并自动序列化和解析消息实体。同时,它还支持消息过滤、顺序消息和延时消息等高级功能,满足不同场景的需求。

主要特点

  • 简单易用:提供简洁的配置和API,快速上手,轻松实现消息生产和消费。
  • 高性能:基于阿里云ONS消息服务,享受高并发、高吞吐、低延迟的分布式消息服务。
  • 弹性扩展:根据业务需求自由添加消费者和生产者,实现弹性扩展。
  • 高级功能支持:支持消息过滤、顺序消息和延时消息等高级功能,满足不同场景的需求。

安装

将以下依赖添加到您的项目中:


<dependency>
    <groupId>io.gitee.zhucan123</groupId>
    <artifactId>rocket-ons-spring-boot-starter</artifactId>
    <version>1.0.8</version>
</dependency>

使用说明

1. 将配置添加到项目中

rocket:
  address: http://xxxx
  secretKey: xxxx
  accessKey: xxxx
  topic: xxxx
  groupSuffix: GID_
  enable: true
  delay: 1000
参数名 类型 是否必填 默认值 描述
accessKey String - 用于身份认证的AccessKeyId,创建于阿里云账号管理控制台。
secretKey String - 用于身份认证的AccessKeySecret,创建于阿里云账号管理控制台。
address String - 设置TCP协议接入点。
groupSuffix String GID_ 控制台创建的Group ID的前缀,通常以"GID_"开头。
topic String - 当生产者未指定topic时使用的默认绑定topic。
delay Integer 1000 消息发送延迟毫秒数。
enable Boolean true 是否启用starter。

2. 在主程序中启用rocketONS-starter

@EnableRocketONS
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

3. 示例代码:使用consumer

@ConsumerListener(tags = "msg_tag", consumers = 2)
@OnsConfiguration(topic = "topic-example", group = "GID_${example.group}")
public class ExampleConsumerListener implements RocketListener<MessageData> {

  @Override
  public Action consume(Message message, MessageData messageBody, ConsumeContext consumeContext) {

    // 处理业务逻辑

    return Action.CommitMessage;
  }
}
  • @OnsConfiguration:注册成一个Spring容器,并设置消费者绑定的topic和group。可设置固定值,也可使用${propertiesKey}的方式读取配置文件中的配置。
  • @ConsumerListener:标识这是一个ONS消息消费者监听器。可以设置tags来进行消息过滤,设置consumers来指定消费者线程数。

4. 示例代码:使用producer

@Service
public class ExampleProducerService {
    @Autowired
    private RocketMQTemplate rocketMQTemplate;

    public void sendMessage(MessageData messageData) {
        rocketMQTemplate.syncSend("topic-example:msg_tag", messageData);
    }
}

通过注入RocketMQTemplate,使用syncSend方法同步发送消息。方法参数中的字符串格式为topic:tag,表示发送到指定topic并设置消息tag。

高级功能

1. 顺序消息

使用RocketMQTemplate的syncSendOrderly方法发送顺序消息,确保消费者按照发送顺序进行消息处理。

rocketMQTemplate.syncSendOrderly("topic-example:msg_tag", messageData, orderId);

2. 延时消息

在发送消息时,通过设置messageDelayLevel参数指定延时级别。

rocketMQTemplate.syncSend("topic-example:msg_tag", messageData, messageDelayLevel);

3. 消息过滤

使用@ConsumerListener注解的tags属性来实现消息过滤。设置对应的tag值,消费者将只会消费带有该tag的消息。

@ConsumerListener(tags = "msg_tag", consumers = 2)
public class ExampleConsumerListener implements RocketListener<MessageData> { ... }

请注意,您需要在生产消息时设置相应的tag。


rocketMQTemplate.syncSend("topic-example:msg_tag", messageData); 

4. 异步发送消息

除了同步发送消息,RocketMQTemplate还提供了异步发送消息的方法。使用asyncSend方法发送消息,提供一个回调函数来处理发送结果。

rocketMQTemplate.asyncSend("topic-example:msg_tag", messageData, new SendCallback() {
  @Override 
  public void onSuccess(SendResult sendResult) { 
    // 处理发送成功的逻辑
  }
  @Override 
  public void onException(Throwable e) {
    // 处理发送失败的逻辑 
  } 
});

5. 广播模式

广播模式允许您将消息发送给所有消费者。要启用广播模式,需要在消费者监听器中设置broadcast属性为true。

@ConsumerListener(tags = "msg_tag", consumers = 2, broadcast = true)
public class ExampleConsumerListener implements RocketListener<MessageData> { ... }

6. 消息重试策略

当消费者处理消息失败时,可以通过返回Action.ReconsumeLater来触发消息重试。您可以在配置文件中设置重试策略。

yamlCopy code
rocket:
  retry: 3
  delay: 1000
参数名 类型 是否必填 默认值 描述
retry Integer 3 消息重试次数。
delay Integer 1000 消息发送延迟毫秒数。

7. 自定义序列化与反序列化

默认情况下,rocketONS-starter 使用 Java 序列化和反序列化消息。但您可以通过实现MessageSerializer接口来自定义序列化和反序列化策略。 public class CustomMessageSerializer implements MessageSerializer { @Override public byte[] serialize(Object obj) { // 实现自定义的序列化逻辑 } @Override public T deserialize(byte[] data, Class clazz) { // 实现自定义的反序列化逻辑 } }

然后,在配置文件中指定自定义序列化器。


rocket:
  serializer: com.example.CustomMessageSerializer

注意事项

  • 确保在生产和消费环境中使用相同的序列化和反序列化策略。
  • 当使用Action.ReconsumeLater触发消息重试时,务必注意避免重试风暴,以免影响整体性能。

8. 延迟消息

RocketMQ 支持延迟消息发送,可以在发送时指定延迟级别。要发送延迟消息,请使用 sendDelay 方法。


int delayLevel = 3; // 延迟级别,具体延迟时间需要参考 RocketMQ 的延迟级别配置
rocketMQTemplate.sendDelay("topic-example:msg_tag", messageData, delayLevel);

9. 事务消息

RocketMQ 支持发送事务消息,可以在发送消息时关联一个本地事务。使用 sendMessageInTransaction 方法发送事务消息。


rocketMQTemplate.sendMessageInTransaction("topic-example:msg_tag", messageData, new LocalTransactionExecuter() {
    @Override
    public LocalTransactionState executeLocalTransactionBranch(Message msg, Object arg) {
        // 执行本地事务
        // 返回事务状态
    }
}, null);

10. 集成测试

为了方便集成测试,您可以使用 RocketMQTestListener 注解启动一个测试消费者。测试消费者会把收到的消息存储在内存中,以便测试时验证。


@RocketMQTestListener(topics = "topic-example", tags = "msg_tag")
public class ExampleConsumerListener implements RocketListener<MessageData> { ... }

在测试用例中,您可以使用 RocketMQTestListener.getMessages() 方法获取收到的消息。

11. 性能调优

为了提高系统性能,您可以通过以下方式调优 RocketMQ:

  • 调整线程池大小。
  • 优化网络参数,如连接超时时间。
  • 调整消费者拉取批次大小。
  • 优化消息堆积参数。

具体参数配置请参考 RocketMQ 官方文档

12. 社区与支持

  • 有问题请在 码云 提交 issue。
  • 欢迎参与项目开发,可通过 Fork 仓库并提交 Pull Request。
  • 更多信息请关注作者 码云主页
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

轻量级springBootStarter,基于阿里云ONS消息服务的一个简易封装,能快捷的创建rocketMQ的生产者和消费者, 实现应用之间的消息传递 展开 收起
Java
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/zc_oss/rocketONS-starter.git
git@gitee.com:zc_oss/rocketONS-starter.git
zc_oss
rocketONS-starter
rocketONS-starter
master

搜索帮助