Websocket IM 聊天教程 - 教你用 GoEasy 快速实现 IM 聊天

经常有朋友问起 GoEasy 如何实现 IM，今天就手把手的带大家从头到尾用 GoEasy 实现一个完整 IM 聊天，全套代码已经放在了 gitee。

今日的前端技术发展可谓百花争鸣，为了确保本文能帮助到使用任何技术栈的前端工程师，Demo 的源码实现上选择了最简单的 HTML+JQuery 的方式，所以,不论您是准备用 Uniapp 开发移动 APP，还是准备写个小程序，不论你喜欢用 React 还是 VUE，还是 React-native 或 ionic, 或者您直接用原生 Javascript 和 Typescript，都是可以轻松理解，全套代码已经放在 gitee 上了，下载后不需要搭建任何环境，直接用浏览器打开，就可以用来聊天了。

作为一名程序员，在编码之前，首先要做的当然是架构设计！什么？确认不是装逼？当然，别忘了星爷的那句话：我是一名程序员！没有思想的程序员，跟咸鱼有什么区别呢？

咳咳咳，正文开始：

首先我们代码层将整个功能分为四层：

1. 华丽的展示层（index.html）：

你们负责功能优雅强大，我负责貌美如花。展示层其实就是纯静态的 html，显示界面，高端点说，就是负责人机交互的。

1. 承上启下的控制层（controller.js）: 控制层作用就是接受页面操作的参数，调用 service 层，根据页面的操作指令或者 service 层的反馈，负责对页面的展示做出控制。不可以编写任何与展示逻辑无关的代码，也就是不能侵入任何业务逻辑。衡量这一层做的好不好的的标准，就是假设删掉 controller 和 view 层，service 能准确完整的描述所有的业务逻辑。

1. 运筹帷幄的关键核心业务层（service.js）: 接受 controller 层的指令，实现业务逻辑，必要时候调用 goeasy 提供网络通讯支持，或调用 restapi 层完成数据的查询和保存。这一层包含所有的业务逻辑，任何业务逻辑相关的代码，都不可以漏到其他层，确保只要 service 存在，整个项目的灵魂就存在，确保 service 层完全是原生代码实现业务逻辑，而没有类似于 vue 或者小程序前端框架的语法和代码渗入，从而达到 service 层能够在任何前端框架通用。

1. 神通广大的服务器交互层（restapi.js）: 根据传入的参数完成服务器端接口的调用，来实现数据查询或、修改或保存，并且返回结果，不参与任何业务逻辑。在实践中大部分是负责发送 http 请求和服务器交互。

分层的目标就是为了确保除了在核心业务层以外的其他层次能够被轻易的替换。举例：我们当前的版本是使用 html+jquery 完成，如果希望再开发一个 Uniapp 实现的小程序或者 app，只需要用 Uniapp 画个新外壳，对 controller 层做一些修改，就可轻松完成一个小程序或者 APP 版的 IM 聊天，不需要对 service 和 restapi 做任何修改 。同理，如果服务器端发生变化，或者更换了与服务器的交互方式，只需要对 restapi 做出修改，其他三层则不受任何影响。

OK, 有了如此清晰而优秀的代码结构分层设计，就差一段优雅的代码来实现了。

Ready, Go! 编码开始：

1. 登录页面，这个最简单，闭着眼睛画个界面，用户名密码正确后，完成以下几个步骤。

1.1. 根据用户名查询出来的用户，初始化全局变量：当前用户。

1.2. 将 controller 层的 onNewMessage, onFriendOnline，onFriendOffline 赋值给 service 。

1.3. new goeasy 建立长连接，记得要传入 userid。如需在 subscriberPrencese 用户上下线提醒事件，或者在调用 HereNow 获取在线用户列表时，能拿到 userId 以外，更多的信息，可以在 userdata 里传入。

1.4. 调用 restapi，查询该用户的好友列表，根据结果初始化本地好友列表 friendlist。

1.5. 将所有有监听的好友的 friendUUID 放入一个数组，调用 subscriberPrencense，监听所有好友的上下线事件。

1.6. 以当前用户的 uuid 为 channel，调用 subscriber，监听来自所有好友发来的消息。

1.7. 显示好友列表界面。

1.8. 初始化好友的在线状态，以数组形式传入所有好友的 userId，调用 hereNowByUserIds，获得当前在线的好友列表，根据结果将 friendlist 里属于在线状态的 friend 的在线状态改为 true，同时将界面上在线用户的头像改为彩色。

1. 显示好友列表（1.7）

2.1. service 层获取当前用户信息，在页面显示当前用户的 username 和头像。

2.2. service 获取本地好友列表，然后 controller 将每个好友的头像和名称显示到页面上，对于当前在线的用户，旁边显示一个小绿点，并且为每个好友绑定一个点击事件，点击好友时，显示聊天界面, 如果该好友有未读消息的，红色小气泡显示未读消息数量。

1. 点击一个好友，进入与其聊天的界面

3.1. 窗口顶部显示聊天好友的名称。

3.2. 调用 restapi 根据当前用户的 UUID 和好友的 friendUUID，查询与该好友的聊天记录，如果这个聊天记录的 sender 是自己，就显示在页面的右边，如果是朋友发的，则显示在左边。

3.3. 将该好友在本地数据里未读消息恢复为 0。

3.4. 并且将聊天记录滚动到最下边。

3.5. 如果点击返回，就直接调进入第二步。

1. 在聊天界面，输入消息后发送：

4.1. 当前用户 uuid 作为 senderUUID 和消息内容组成 chatMessage。

4.2. 调用 restapi 将 chatMessage 发往“服务器”端，我们建议的方式是所有的消息发往自己的服务器端，在服务器端先保存入库，然后在服务端 publish. 具体做法是将 chatMessage 转换为字符串，入库，然后将该好友的 channel 作为 channel 调用 GoEasy 完成 publish。(当然，你会发现在我们的示例代码这个过程是在 restapi 里直接完成的，原因是为了 demo 的演示方便，我们模拟的服务器端行为，相信你懂的）

4.3. 自己的消息发送成功后，显示在聊天窗口的右边。

1. 收到新消息：

5.1. 在 1.6 定义了接收好友新消息的事件，当收到一条好友的新消息时。

5.2. 首先调用 restapi 保存到服务器。

5.3. 本地好友数据里的未读消息加 1。

5.4. 如果当前界面是好友列表，将来自该朋友的未读消息的数字显示在界面上。

5.5. 如果收到的消息就是来自当前对话窗口，就将消息显示到聊天窗口，并且调用 service 将本地数据里该好友的未读消息清 0。

1. 用户上下线提醒

6.1. 在 1.5 监听了用户上下线，当收到一个用户上线或下线的通知后（注意返回的是一个列表，一次事件有可能有多个好友都发生了状态变化）。

6.2. 修改将本地数据里该好友对象在线状态,如果是上线事件就显示彩色，如果是下线就显示黑白色。

至此，整个聊天功能就完成了，是不是很简单呢。在整个 demo 中只用到了 goeasy 的四个 API

subscriber（接收消息），subscriberPrencense（接受上下线通知），hereNowByUserIds(获取当前在线用户列表）, publish(发送消息)，详情可以参考 goeasy 官方文档：https://www.goeasy.io/cn/developers.html

哼！这难道不是纸上谈兵吗？Talk is cheap, show me the code! 优雅的代码在哪里呢？

别着急，当然有全套代码拉，如果放个 zip 文件的下载连接，显得 B 格太低，老规矩，gitee 见:

注意事项：

1. 在 restapi.js 里 可以找到用户名和密码

2. 在 service.js 里将 appkey 替换为您自己的 common key

3. subscriberPrencense 和 hereNowByUserIds 这两个方法，默认是关闭的，需要扫码添加 GoEasy 客服开通哦~

将代码与本文一起对照阅读后，要写个 IM，比画个 0 还简单，如果使用的是其他的前端技术框架如小程序和 Reactnative，只需要重新画个外壳就好了！

彩弹在最后：

看了代码的你，是不是发现我们的 RESTAPI 其实是个冒牌货，并不会真的和远程的某个服务器交互，这是为了方便演示，我们定义了两个变量来帮助模拟远程数据的查询，然后用 localstorage 来模拟服务器的保存，相信聪明的你，肯定已经 get 到我们的代码思路了。

GoEasy 简介：

GoEasy 是国内知名的第三方 websocket 推送服务，已经稳定运行了 5 年时间，支持千万级消息并发，除了兼容所有常见的浏览器以外，同时也兼容 uni-app，各种小程序，以及 vue、react-native 等常见的前端框架。

GoEasy 官网：https://www.goeasy.io