CubeOnline是一个支持实时在线PK魔方的小程序, 玩家进入房间并创建websocket连接, 然后进行实时竞技. 服务器基于pypy3.6和tornado6.0.4实现.
在部署项目之前, 你需要先在对应的平台注册开发账号, 然后将你的app_id和app_secret填入后端的config.py文件.
对于服务器端, 这个项目需要 redis, docker 和 tnoodle等组件. 安装完成后, 使用docker将代码打包为镜像, 然后实例化容器运行即可. 在运行服务之前, 请确保redis和tnoodle处于正常工作的状态.
对于前端来说, 只需要在app.js中设置你的服务器url即可. 发布小程序可以参考微信小程序发布流程.
目前后端提供/user/login,/room/create和/room/random三个http接口, 负责用户的登录, 以及为用户提供可加入的房间号码. 其工作流程如下:
获取到房间号之后, 用户就可以进入房间页面, 创建WebSocket连接与后端进行通信.
在应用层面, 通信数据的格式为{event:xxx, data:{...}}. 前后端都有负责处理此类消息的Handler对象, 当收到消息时, 通过反射找到event事件对应的处理方法, 将数据交由该方法进行处理. 目前有如下的消息类型:
| 事件类型 | 方向 | 说明 |
|---|---|---|
| on_ready | c->s | 用户点击准备按钮, 告知后端. |
| upload_score | c->s | 用户完成本轮比赛, 向后端上传成绩. |
| initialize_room | s->c | 用户进入房间后, 后端将房间的数据传给前端渲染. |
| add_member | s->c | 有新成员加入后, 后端将该成员的信息发送给房间其他成员. |
| delete_member | s->c | 有成员离开后, 后端将该信息发送给房间其他成员. |
| change_state | s->c | 房间内某个成员改变了自己的状态, 后端告知其他成员. |
| start_round | s->c | 通知前端开始比赛. |
| update_score | s->c | 成员上传自己的成绩后, 后端将成绩发给其他成员来实时更新. |
| finish_round | s->c | 所有成员都完成了比赛, 后端将排名和积分等信息发送给前端. |
进入room页面, 小程序的状态机如下:
在本项目的WebSocket通信中, 后端是被动的一方. 它不主动搞事或者发消息, 而是在接收到前端的消息之后, 基于对应的事件处理方法进行回应.
本项目有多个自行开发的组件, 不光能用于本项目, 也可以用在其它地方.
该组件负责对从前端获得的数据进行提取和验证, 支持处理字典dict, 字符串string和字节bytes格式的数据, 其中字符串和字节会自动解码. 这个组件的工作原理如下图所示:
如有需要, 你可以通过继承的方式自定义新的Field和Form类, 完成更多数据类型和格式验证. 这个组件的源代码可见forms和fields.
该组件是为tornado量身定制的, 使用协程的形式进行耗时操作. 因此在增加了tornado的session能力的同时, 也没有阻塞主线程, 造成性能损失.
这个组件的原理比较简单, 就是基于redis的哈希类型设计的. 源代码可见user.
该模态框内可以放入任意小程序的组件, 因此可定制性强于原生模态框.
首先, 在页面的json文件中引入模态框:
"my-modal": "/components/modal/modal"
然后,在对应的html页面中使用即可:
<my-modal show="{{show_modal}}" height='60%' bindconfirm='modalConfirm'>
你的内容
</my-modal>
这个模态框的源代码可见modal.
- 目前小程序仅支持微信和QQ端. 如果要增加小程序能够发布的平台, 则需要在前端的
app.js->global_data.applet中重写小程序平台的判断方式. - 如果后端服务通过
nginx转发, 那么必须在nginx的http配置中设置underscores_in_headers on, 否则会导致转发的部分数据丢失.
在微信小程序里面搜索"CubeOnline"即可.