野火IM解决方案
野火IM是专业级即时通讯和实时音视频整体解决方案,由北京野火无限网络科技有限公司维护和支持。
主要特性有:私有部署安全可靠,性能强大,功能齐全,全平台支持,开源率高,部署运维简单,二次开发友好,方便与第三方系统对接或者嵌入现有系统中。详细情况请参考在线文档。
主要包括一下项目:
GitHub仓库地址(主站) | 码云仓库地址(镜像) | 说明 | 备注 |
---|---|---|---|
im-server | im-server | IM Server | |
android-chat | android-chat | 野火IM Android SDK源码和App源码 | 可以很方便地进行二次开发,或集成到现有应用当中 |
ios-chat | ios-chat | 野火IM iOS SDK源码和App源码 | 可以很方便地进行二次开发,或集成到现有应用当中 |
pc-chat | pc-chat | 基于Electron开发的PC 端 | |
web-chat | web-chat | 野火IM Web 端, 体验地址 | |
wx-chat | wx-chat | 小程序平台的Demo(支持微信、百度、阿里、字节、QQ 等小程序平台) | |
app server | app server | 应用服务端 | |
robot_server | robot_server | 机器人服务端 | |
push_server | push_server | 推送服务器 | |
docs | docs | 野火IM相关文档,包含设计、概念、开发、使用说明,在线查看 |
野火IM后端应用
作为野火IM的后端应用的演示,本工程具有如下功能:
- 短信登陆和注册功能,用来演示登陆应用,获取token的场景.
- PC端扫码登录的功能.
- 群公告的获取和更新功能.
- 客户端上传日志功能.
本工程为Demo工程,实际使用时需要把对应功能移植到您的应用服务中。如果需要直接使用,请按照后面的说明解决掉性能瓶颈问题。
编译
mvn clean package
打包RPM格式
打包会生成Java包和deb安装包,如果需要rpm安装包,请在pom.xml
中取消注释生成rpm包的plugin。另外还需要本地安装有rpm,在linux或者mac系统中很容易安装,在windows系统需要安装cygwin并安装rpm,具体信息请百度查询。
修改之后运行编译命令mvn clean package
,rpm包生成在target
目录下。
短信资源
应用使用的是腾讯云短信功能,需要申请到appid/appkey/templateId
这三个参数,并配置到tencent_sms.properties
中去。用户也可以自行更换为自己喜欢的短信提供商。在没有短信供应商的情况下,为了测试可以使用superCode
,设置好后,客户端可以直接使用superCode
进行登陆。上线时一定要注意删掉superCode
。
修改配置
本演示服务有4个配置文件在工程的config
目录下,分别是application.properties
, im.properties
, aliyun_sms.properties
和tencent_sms.properties
。请正确配置放到jar包所在的目录下的config
目录下。
application.properties
配置中的sms.verdor
决定是使用那个短信服务商,1为腾讯短信,2为阿里云短信
运行
在target
目录找到app-XXXX.jar
,把jar包和放置配置文件的config
目录放到一起,然后执行下面命令:
java -jar app-XXXXX.jar
性能瓶颈
本服务最早只提供获取token功能,后来逐渐增加了群公告/Shiro等功能,需要引入数据库。为了提高用户体验的便利性,引入了数据库H2,让用户可以无需安装任何软件就可以直接运行(JRE还是需要的),另外shiro的session也存储在h2数据库中。提高了便利性的同时导致一方面性能有瓶颈,另外一方面也不能水平扩展和高可用。因此需要使用本工程上线必须修改2个地方。
- 切换到MySQL,切换方法请参考
application.properties
文件中的描述。 - 使用RedisSessionDao,详情请参考 https://www.baidu.com/s?wd=shiro+redis&tn=84053098_3_dg&ie=utf-8
- 从0.53版本开始,应用服务改为无状态服务,可以集群部署。验证码和PC会话等信息都存放到数据库中,如果压力较大,可以二开引入redis缓存。
版本兼容
-
0.40版本引入了shiro功能,在升级本服务之前,需要确保客户端已经引入了本工程0.40版本发布时或之后的移动客户端。并且在升级之后,客户端需要退出重新登录一次以便保存session(退出登录时调用disconnect,需要使用false值,这样重新登录才能保留历史聊天记录,一定要在新版本中改成这样)。如果是旧版本或者没有重新登录,群公告和扫码登录功能将不可用。为了系统的安全性,建议升级。
-
0.43版本把Web和PC登录的短轮询改为长轮询,如果应用服务升级需要对Web和PC进行对应修改。
-
0.45.1 配置文件中添加了
wfc.all_client_support_ssl
开关,当升级到这个版本或之后时,需要配置文件中添加这个开关。 -
0.51版本添加了token认证。可以同时支持token和cookies认证,客户端也做了对应修改,优先使用token。注意做好兼容。
-
从0.53版本开始,所以数据都存储在数据库中,因此应用服务为无状态服务,可以部署多台应用服务做高可用和水平扩展。需要注意数据都是存储在数据库中,如果用户量较大或者业务量比较大,可以自己二开应用服务,添加redis缓存。
注意事项
服务中对同一个IP的请求会有限频,默认是一个ip一小时可以请求200次,可以根据您的实际情况调整(搜索rateLimiter字符串就能找到)。如果使用了nginx做反向代理需要注意把用户真实ip传递过去(使用X-Real-IP或X-Forwarded-For),避免获取不到真实ip从而影响正常使用。
使用到的开源代码
- TypeBuilder 一个用于生成泛型的简易Builder
LICENSE
UNDER MIT LICENSE. 详情见LICENSE文件
使用阿里云短信
请参考说明使用阿里云短信