GOT项目开发规范文档（10.17）

前言

考虑项目开发周期非常紧张，故服务端开发选用Go和NodeJS开发，实时通信要求较高部分走Socket通信（Go），其他接口统一走Http协议（Node JS），两边同时进行，后期再进行调整优化。

技术选型

服务端：Go、NodeJS

客户端：Lua (Cocos Quick版本)

数据库：MySQL

Go和NodeJS服务间通信，通过调用彼此暴露的接口进行交互。

接口规范

Socket通信
通信数据格式：Protobuf

Http通信
通信数据格式：Json
HTTP请求：统一使用Post

接口命名、参数命名
统一使用小写字母 + _下划线

接口返回数据格式

{
    "status": 1,    // 接口调用状态码，1表示成功，非1表示失败，或为其他状态；具体以接口文档为主
    "data": {
        "desc": "接口返回的所有数据统一放此键值中",
        "key_name_desc": "键名统一使用[小写字母 + _下划线分隔]"
    },
    "msg": "接口返回消息，如：xxx成功/失败"
}

数据库规范

详见wiki中的《MySQL数据库规范》

服务端模块划分

Socket协议通信功能模块
- 游戏房间
- 游戏部分（决战商场、利旺营销）
- 游戏战绩等实时要求较高模块

HTTP协议通信功能模块
- 登录系统
- 主界面
- 玩家信息
- 创建游戏
- 房间大厅
- 邀请功能

代码托管

项目代码使用Git管理，统一托管于码云平台。
Git使用教程可查看《Git教程》；Git版本/分支管理规范请查看《如何正确使用Git Flow》

Mac OS GUI工具：Source Tree
Windows GUI工具：Tortoise Git

相关资料

• 项目计划文档：svn下的/Design/项目计划/GOT项目开发计划.xlsx
• API接口文档，访问密码：123456