1 Star 1 Fork 2

Alum / Aim

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

在线文档

https://www.yuque.com/alum/agigf8/gezg25


项目介绍

Aim是一套完全基于Netty的消息推送框架,可应用于信令推送,即时聊天,移动设备指令推送等领域。开发者可沉浸于业务开发,不用关心消息通道链接,消息编解码协议等繁杂处理。

Aim采用业内主流开源技术构建,易于扩展和使用,并完美支持集群部署支持海量链接,目前支持websocket,android,ios,桌面应用,系统应用等多端接入持,可应用于移动应用,物联网,智能家居,嵌入式开发,桌面应用,WEB应用即时消服务。

用时7年 基于Aim的项目已经运行在全国各个地方,包括上司公司,各地政务系统,警务系统等服务于上百家客户,希望Aim也能为您带来价值,如果您也希望加入项目成为贡献者,请联系我。

1.支持TCP、WebSocket统一端口接入管理

2.TEXT、JSON、ProtoBuf、TLV、Binary等数据拆解包协议

3.开源项目中惟一具备完善群组项目的良心组件

4.支持Redis、RabbitMq集群

5.支持Nacos等注册配置中心


项目位置

Gitee: https://gitee.com/alum/aim

Github: https://github.com/AlumXi/aim

演示项目

VUE(Web)项目: https://gitee.com/alum/aim-vue

APP(Net7)项目: https://gitee.com/alum/aim-chat

联系作者

邮箱: alum@live.cn       微信:alum-xi           QQ:349545750


使用说明

1.Maven引入:aim-cluster、aim-starter或者alum-all对应的jar,如下:

<dependency>
    <groupId>xin.alum</groupId>
    <artifactId>aim-all</artifactId>
    <version>${last_version}</version>
</dependency>

2.代码集成:

`Aim.start();` //可参阅Aim-server中的AimStarter类

注:AimReceiver可以被重写,完成自定义业务处理,可参考AimReciveService.java

3.通信数据与握手协议

> 默认收发消息是基于ProtoBuf的Events对象,Events继承自Transportable(可继承此对象实现自定义通信数据)
> Events的Data为泛型ProtoBuf的Message对象(可自定义),通信过程会将Data的Message转换为Any类型
> 若自定义数据包可通过重载AimReceiver的onText和onByte来实现自定义数据接受及业务处理
> 通信数据解封包:目前Aim支持Text、Json、ProtoBuf、Tlv、Binary五种通信数据类型,默认为配置项:aim.agreement
    >、WebSocket连接可通过URL握手时的agreement参数由客户端指定其通道数据类型协议
    >、TCP连接可通过连接后直发0-4字数(测试用,不推荐)确定,也可以通过Packet.Login(推荐)对接来实现握手
> 握手业务认证处理由AimReceiver的onHand**方法来接受处理,认证失败Aim会自动断开其连接

4.集群配置

>、默认为非集群模式
>、开启集群方式为在yml配置文件中设置    aim.cluster.mode为redis、rabbitmq或rocketmq,默认为none;
>、集群模式启动aim-server前需要先准备好Redis、Rabbit或RocketMq,并在对应Server中配置,spring的Redis和Rabbitmqa或RocketMq配置,可参阅aim-server中的配置
>、集群订阅消息处理:集群消息订阅可实现xin.alum.aim.groups.ClusterMessage 接口的onMessage来实现并通过Aim.Start([ClusterMessage])进行传递,可参阅aim-server中的ClusterMessage及AimStarter类
>、ClusterMessage类的实现是非必须的

5.源码部署测试

aim-server和aim-nacos可以作为服务端直接启动,aim-nacos需要nacos-server启动,若无nacos可直接启动aim-server

操作步骤如下:

(1).clone Aim项目源码到本地,通过Idea打开aim项目源码
(2).启动aim-server项目
(3).通过Jmeter等测试工具连接aim-server的Tcp/WebSocket的端口8090(默认)
(4).WebSocket接入地址:ws://127.0.0.1:8090/ws?token={不为空即可}&agreement=Json
(5).Socket接入地址:tcp://127.0.0.1:8090 (TCP可以直连发1-5数字进行握手,1-5为协议编号等同于4中agreement参数,可参阅源码Packet.proto文件中的Agreement对象)
 参数说明:token为用户对象,身份参数,agreement为通信协议能数,默认为json

6. aim-example 实例项目

JAVA: 此项目是基于Java语言实现的服务端(Server)与客户端(Client)控制台演示实例,对应数据协议均有实现
JS/TS:请参阅[aim-vue](https://gitee.com/alum/aim-vue)项目 
C#/App: 请参阅[aim-chat](https://gitee.com/alum/aim-chat)项目

更新日志

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: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and 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 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 2018 Aim 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.

简介

Aim是一套基于Netty的消息JAVA推送框架,可应用于信令推送,即时聊天,移动设备指令推送等领域。开发者可沉浸于业务开发,不用关心消息通道链接,消息编解码协议等繁杂处理;开源技术构建,易于扩展和使用,并完美支持集群部署支持海量链接,目前支持websocket,android,ios,桌面应用,系统应用等多端接入持,可应用于移动应用,物联网,智能家居,嵌入式开发,桌面应用,WEB应用即时消服务。 展开 收起
Java
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/alum/aim.git
git@gitee.com:alum/aim.git
alum
aim
Aim
develop

搜索帮助

53164aa7 5694891 3bd8fe86 5694891