122 Star 470 Fork 11

常康 / webim

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

设计思路不过时!

说明(本项目重点不在如何使用如何部署,而是给大家提供一个IM解决方案,提供一个思路,如何设计topic,如何设计最简单的数据库)

  • 数据库文件可能与本项目有一丝丝差别但是不影响运行,因为阿里云没续费,导致资源被释放,数据库没有来得及备份,所以我也没有最新版数据库设计文件了
  • 第一版,写的比较仓促,好多想法没有实现,模块没有划分,命名和编码规范都不好,还有几个明显的漏洞,请不要错误利用。
  • 架构图(看此图胜读10年书):https://www.processon.com/view/link/5a50a4bee4b0a447b9910216
  • 数据库(适合所有IM):https://www.processon.com/view/link/598876dde4b0e56e5d07f787
  • 作者微信:875079028。其实功能很简单,大家都会就是没有人去写,都没有时间或者怕麻烦,于是我就写了,本项目主要是用来提供思路和理念!!!。
  • 项目很简单总共就一个controller,两个页面(登录页面,聊天页面)
  • 用户id或者账号就是mqtt的topic,用户账号密码就是mqtt连接的账号和密码(项目配置文件内默认了mqtt服务器地址,可以暂时不用自己架设mqtt服务器)
  • webim后台管理版暂不开源(为公司统一添加分组,部门和好友,网站客服等)
  • 项目现在也不过时,项目不更新是因为没有要升级的部分了,比较非常稳定(当年还不流行springboot,也不流行前后端分离)。
  • 项目视频:点击查看

主要技术

网页即时通讯系统,登陆后所有操作无需刷新(收/发/离线)。

采用mqtt,可以利用协议本身优势,省去群组发送消息和接收消息的开发,多端登录接收消息的开发,本质只是往订阅的主题中推送消息。

采用jfinal,前期写起来简单又快,但是后期扩展起来非常难,各种不支持,各种不能集成,改为springboot很好改,已经有很多同学改成功了

但是本项目主要是用来理解即时通讯的思路和原理,扩展不是重点。

通讯协议使用的是MQTT,需要自己架设MQ服务器(哪公司的MQ都可以,支持MQTT协议就行),

至于为什么要用这个协议,主要是因为订阅/发布模式,并且各种系统和开发语言的客户端sdk都有,个人认为订阅/发布模式是目前用来开发即时通讯最快最简单的通讯协议,

强烈建议自己开发IM的同学使用此协议(难点是topic的逻辑设计)。

在线状态的处理也是巧妙的利用的mqtt协议

消息的获取是推送还是拉取,都行合适就行。技术虽然简单但是功能实用,有漏洞希望理解。

mqtt下载地址

https://docs.emqx.cn/cn/broker/latest/getting-started/install.html
https://docs.emqx.cn/cn/broker/latest/development/resource.html

主要功能

  1. 聊天记录
  2. 添加好友
  3. 添加群组
  4. 创建群组
  5. 好友私聊
  6. 好友群聊
  7. 离线消息 (重点,不丢失消息)
  8. 发送文件
  9. 上下线通知 (重点)
  10. 好友分组管理
  11. 查找好友
  12. 消息撤回(重点,测试中)
  13. 删除好友
  14. 退出群组
  15. 好友在线状态(重点,实时准确)
  16. 异常掉线处理(重点,不管是主动退出离线,刷新网页,关闭网页,关闭浏览器,兼容所有浏览器,在线离线准确率100%)
  17. 修改个人信息(第二版)
  18. 查看好友详细信息(第二版)
  19. 接收消息(支持多端登录,收到消息)
  20. 好友移动分组(第二版)
  21. 查看好友详细资料(第二版)
  22. 修改备注(好友备注/群备注)
  23. 消息加密(第二版)

系统截图

添加好友 好友操作 输入图片说明 修改头像 创建群组 查看群成员 发送文件 消息通知

未提交移动版

未提交电脑板

输入图片说明 输入图片说明 输入图片说明 输入图片说明 输入图片说明 输入图片说明 输入图片说明

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.

简介

webim —— 网页即时通讯系统详细注释教学版(教科书式保姆级操作) 展开 收起
Java 等 4 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/kangchang/webim.git
git@gitee.com:kangchang/webim.git
kangchang
webim
webim
master

搜索帮助