初始化仓库：友乐/gameabc 房卡游戏平台脚手架（client + server + docs）
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Claude Opus 5
@@ -0,0 +1,205 @@
|
||||
# 01 · 服务端环境与框架基础
|
||||
|
||||
本篇建立**全局认知**：子游戏运行在什么环境里、平台框架由哪些对象构成、一个数据包如何被路由到你的代码、一个房间从生到死经历哪些阶段。读懂这一篇，后面的接入与协议才有坐标。
|
||||
|
||||
> 举例以麻将类房卡游戏为主，但本篇所有机制对任意子游戏一致。
|
||||
|
||||
> **命名说明**：代码示例里的类/文件/变量名（如 `GameStateManager` 等）均为**示例、可自定**；只有平台接缝上的名字（包字段、`export`/`import` 钩子名、平台 API 如 `cls_mod.new`/`min_loadJsFile`/`sendpack_toseat`）是契约。详见 [README「命名约定」](./README.md)。
|
||||
|
||||
---
|
||||
|
||||
## 1. 运行环境：一套代码，两个运行时
|
||||
|
||||
子游戏代码**同时运行在两套环境**，写每一行都要同时考虑：
|
||||
|
||||
| 运行时 | 场景 | 模块加载方式 | 是否有 `require` |
|
||||
|--------|------|--------------|------------------|
|
||||
| **Node.js** | 本地、单元测试 | `require()` | 有 |
|
||||
| **浏览器 / 友乐平台** | 线上部署 | 由 `mod.js` 用 `min_loadJsFile` 统一加载为**全局对象** | **没有** |
|
||||
|
||||
由此引出两条硬约束（详见 04）：
|
||||
|
||||
1. **严格 ES5**：用 `var`/`function`，禁止 `let`/`const`/箭头函数/模板串/`class`/`Promise` 等；线上浏览器/友乐运行时不保证 ES6+。
|
||||
2. **`require` 只能在文件开头的守卫块内**：
|
||||
|
||||
```js
|
||||
// ✅ 正确：集中在顶部守卫块；运行时按全局名引用
|
||||
if (typeof require !== 'undefined') {
|
||||
var GameStateManager = require('./dataStructures/GameStateManager.js');
|
||||
}
|
||||
// ... 之后直接用全局名 GameStateManager.xxx() ——浏览器由 mod.js 加载为同名全局
|
||||
```
|
||||
|
||||
浏览器运行时没有 `require`，任何**无守卫的、函数体内的中途 `require`** 都会抛 `ReferenceError: require is not defined`，导致功能崩溃。跨模块统一**按全局名引用**：Node 由守卫块 `var X = require(...)` 得到，浏览器由 `mod.js` 加载的同名全局解析，二者靠共享全局作用域下的同名 `var` 统一。
|
||||
|
||||
### 前后端是物理分离的两端
|
||||
|
||||
- 客户端跑在用户浏览器，服务端跑在 Node。两端**不是函数调用，而是 WebSocket/HTTP 收发 JSON 包**，全程异步。
|
||||
- 前端代码不走 npm 构建，**前后端共享代码靠文件复制同步**（见 04 的 shared 同步流程）。
|
||||
- **服务器权威**：凡房卡、胜负、积分、房间状态等关键数据/操作，一律以服务器为准，前端只负责显示，不能"前端说什么就是什么"。
|
||||
|
||||
---
|
||||
|
||||
## 2. 平台代码 vs 子游戏代码
|
||||
|
||||
```
|
||||
server/ ← 平台框架（除子游戏容器目录外，全部禁改）
|
||||
├── packet.js 总收发包入口、应用列表、最终 SendPack
|
||||
├── applist.js 加载各应用（server / youle / update）
|
||||
├── class/ 框架基础类
|
||||
│ ├── class.app.js 应用基类 cls_app（按 route 路由到模块）
|
||||
│ ├── class.mod.js 模块基类 cls_mod（按 rpc 路由到方法）
|
||||
│ └── class.desk.js / ... 桌、牌等基础类
|
||||
├── youle/ 友乐应用（appname = "youle"）
|
||||
│ ├── app.js 创建 youle_app
|
||||
│ └── server_room/ 房间模块 youle_room（routename = "room"）
|
||||
│ ├── class.room.js 房间对象 o_room（含 seatlist、发包方法）
|
||||
│ ├── class.player.js 座位/玩家对象（含 conmode/fromid）
|
||||
│ ├── class.export.js 框架对外服务：check_player / deduct_roomcard / save_grade ...
|
||||
│ └── class.import.js 框架回调子游戏：makewar_deskwar / get_disbandRoom / player_* ...
|
||||
└── <游戏容器目录>/ ← 子游戏容器（目录名由接入方自定，非框架强制）
|
||||
└── <你的游戏>/ ← 子游戏（唯一可编辑目录）
|
||||
├── mod.js 模块入口：创建模块、加载文件、定义 RPC 方法
|
||||
├── export.js 子游戏对平台暴露的一组回调接口（按需实现，见 02）
|
||||
├── import.js 子游戏对平台服务的封装接口（本项目 4 个）
|
||||
└── ... 你的玩法业务代码
|
||||
```
|
||||
|
||||
> **容器目录名不是框架约定**：容器目录名由接入方自定。框架**不按目录名找子游戏**——运行时由 `youle_room.app[o_room.o_game.modename]` **按模块名**定位（见 §5）。接入一个新游戏只需两步：① 在 `server/youle/app.js` 里加一行 `min_loadJsFile("<容器目录>/<你的游戏>/mod.js", ...)` 加载它；② 在 `mod.js` 里用唯一的 `modname/routename` 注册。因此容器目录换成任何不与框架冲突的名字都可以（`app.js` 是唯一必须触碰的平台文件，属游戏注册接入点）。
|
||||
|
||||
**一句话**：平台提供"网络 + 房间 + 玩家 + 房卡 + 战绩"的地基，子游戏只往自己的目录里填"玩法"。两边的接缝就是 **export / import**（详见 02）。
|
||||
|
||||
---
|
||||
|
||||
## 3. 核心对象模型
|
||||
|
||||
理解五个对象的层级关系，就理解了框架的数据骨架：
|
||||
|
||||
```
|
||||
app (youle_app) 一个应用，appname = "youle"
|
||||
└── modlist[] 应用下挂的所有模块
|
||||
├── youle_room 平台房间模块，routename = "room"
|
||||
└── mod_<你的游戏> 你的子游戏模块，routename = "<你的游戏>"
|
||||
|
||||
o_room 房间对象（平台创建，一桌一个）
|
||||
├── roomcode / roomtype / asetcount / battlestate ... 平台基础数据
|
||||
├── seatlist[] 座位列表，长度=满桌人数
|
||||
│ └── seatlist[seat] = o_player 座位上的玩家对象
|
||||
│ ├── playerid / nickname / onstate
|
||||
│ └── conmode / fromid 连接方式与连接ID（发包要用）
|
||||
├── method.sendpack_toseat(msg, seat) 平台发包方法
|
||||
├── method.sendpack_toother(msg, seat)
|
||||
└── o_desk ★ 子游戏的牌桌对象（由你在 makewar 里创建并挂上）
|
||||
├── o_room 反向引用回房间
|
||||
└── data.* ★ 你的对局状态全挂这里（房间隔离的落点）
|
||||
```
|
||||
|
||||
要点：
|
||||
|
||||
- **`o_room` 由平台创建并持有**；`seatlist[seat]` 是玩家对象，发包所需的 `conmode`/`fromid` 就在它上面。
|
||||
- **`o_desk` 由子游戏创建**（在 `makewar` 中），并与 `o_room` 建立双向引用：`o_room.o_desk = desk; desk.o_room = o_room;`。
|
||||
- **对局状态一律挂在 `o_room.o_desk.data.*`**。这是"房间隔离"的物理落点：每桌一份，互不串扰（见 04）。
|
||||
|
||||
> 举例：麻将把游戏状态放在 `o_room.o_desk.data.roomAdapter.gameState`，把操作队列放在 `o_room.o_desk.data.operationQueue`。换成斗地主、跑得快也是同一套落点，只是 `data.*` 下的字段不同。
|
||||
|
||||
---
|
||||
|
||||
## 4. 三层路由：一个包如何到达你的函数
|
||||
|
||||
平台把客户端发来的包，按 `app → route → rpc` 三级精确投递到子游戏的某个函数。
|
||||
|
||||
```
|
||||
{ app: "youle", route: "<你的游戏>", rpc: "playCard", data: { ... } }
|
||||
```
|
||||
|
||||
| 级 | 在哪 | 依据 | 动作 |
|
||||
|----|------|------|------|
|
||||
| 1 | `packet.js` `packet_face.ReceivePack` | `pack.app` | 在 `applist` 里找到 `appname == pack.app` 的应用，调 `app.ReceivePack(pack)` |
|
||||
| 2 | `class/class.app.js` `cls_app.ReceivePack` | `pack.route` | 在 `app.modlist` 里找到 `routename == pack.route` 的模块，调 `mod.DoPack(pack)` |
|
||||
| 3 | `class/class.mod.js` `cls_mod.DoPack` | `pack.rpc` | 若 `mod[pack.rpc]` 存在，调用 `mod[pack.rpc](pack)` |
|
||||
|
||||
证据：
|
||||
- 第 1 级：`server/packet.js` `ReceivePack` 按 `pack.app == applist[i].appname` 分发。
|
||||
- 第 2 级：`server/class/class.app.js` `ReceivePack` 按 `pack.route == modlist[i].routename` 调 `DoPack`。
|
||||
- 第 3 级：`server/class/class.mod.js` `DoPack` 按 `_msg.rpc` 调 `_obj_mod[_msg.rpc](_msg)`。
|
||||
|
||||
**对开发者的含义**：你在 `mod.js` 里写下 `mod_<游戏>.playCard = function(pack){...}`，前端只要发 `{route:"<你的游戏>", rpc:"playCard", ...}`，框架就会自动调到它——**无需自己写路由分发**，更不要在一个总入口里用 `switch(action)` 做二次路由（一个操作对应一个 RPC 方法）。
|
||||
|
||||
### ⚠️ 关于 `DoPack` 的返回值（重要）
|
||||
|
||||
`cls_app.ReceivePack` 在拿到 `DoPack` 的返回值后，确实会执行一次 `app.SendPack(repack)`。但这个回发：
|
||||
|
||||
- 只回给**当前请求的那条连接**，且不经过"按座位定向"的处理；
|
||||
- 在浏览器/友乐链路下**不是子游戏向前端推送状态的可靠通道**。
|
||||
|
||||
因此本项目的铁律是：**子游戏 RPC handler 一律通过 `o_room.method.sendpack_toseat / sendpack_toother` 主动推送**来下发结果，**不依赖 `return`**。这条直接推导出 03 的"成败标志必须放在主动推送的 `data.success` 里"。
|
||||
|
||||
---
|
||||
|
||||
## 5. 模块注册与全局暴露
|
||||
|
||||
子游戏模块用框架基类创建，并自动注册进应用：
|
||||
|
||||
```js
|
||||
// cls_mod.new(模块名, 路由名, 所属应用)
|
||||
var mod_<你的游戏> = mod_<你的游戏> || cls_mod.new("mod_<你的游戏>", "<你的游戏>", youle_app);
|
||||
```
|
||||
|
||||
`cls_mod.new` 做了三件事：把模块 push 进 `app.modlist`、在 `app` 上挂 `app[模块名]=mod`、并通过 `OutputMod` 把模块**暴露为全局名**（`global[modname]`）。这套"双运行时全局暴露"是浏览器/友乐能按全局名找到模块的基础。
|
||||
|
||||
> 双运行时陷阱：凡"构造函数 + 单例实例"式模块，`module.exports` 之后必须**无条件**把全局名暴露出去（不要塞进 `else` 分支），否则线上浏览器拿不到该全局，报 `xxx is not a function`，而 Node 测试却测不出来。
|
||||
|
||||
`export.js` / `import.js` 在各自文件末尾把接口对象挂到 `mod.export` / `mod.import`，`mod.js` 只负责按顺序加载它们（见 02）。
|
||||
|
||||
---
|
||||
|
||||
## 6. 房间生命周期
|
||||
|
||||
一个房间从创建到回收，平台与子游戏分工如下。**理解每个阶段"谁调用谁"，是接入的关键**：
|
||||
|
||||
```
|
||||
创建房间
|
||||
平台调 export.get_needroomcard / get_asetcount / get_needroomcard_joinroom
|
||||
→ 决定房卡与总局数（此时还没有 o_desk，子游戏不需要知道谁坐在哪）
|
||||
|
||||
满桌/房主开战
|
||||
平台调 export.makewar(o_room, o_game_config)
|
||||
→ 子游戏创建 o_desk、初始化对局状态、返回开战数据包
|
||||
→ 平台把开战包下发所有客户端（对应前端 StartWar）
|
||||
→ o_room.battlestate = 1
|
||||
|
||||
对局进行中
|
||||
客户端发 RPC → mod[rpc](pack) → 子游戏处理 → 主动推送结果
|
||||
|
||||
断线重连 / 中途加入
|
||||
平台调 export.get_deskinfo(o_room, seat)
|
||||
→ 子游戏返回该座位「当前完整快照」（对应前端 Reconnect）
|
||||
|
||||
每小局结算
|
||||
第一小局结算时：子游戏调 import.deduct_roomcard(o_room) 扣房卡（仅此一次）
|
||||
|
||||
大局（整场）结束
|
||||
子游戏算完最终战绩后调 import.save_grade(o_room, ...)
|
||||
→ 平台保存战绩并「自动释放房间」，子游戏无需再回收房间本身
|
||||
|
||||
解散房间
|
||||
平台调 export.get_disbandRoom(o_room) 取解散数据包下发
|
||||
|
||||
玩家中途进出
|
||||
平台调 export.player_enter / player_leave 通知子游戏处理
|
||||
```
|
||||
|
||||
**子游戏自己创建的东西，自己负责回收**：定时器、托管/决策状态、各类缓存等，必须能按房间定位，并在小局结束、解散、开新局时清理干净，禁止泄漏到下一局或别的房间（见 04 的房间隔离）。
|
||||
|
||||
---
|
||||
|
||||
## 7. 小结
|
||||
|
||||
- 一套代码两个运行时 → 强制 ES5 + 守卫块 require。
|
||||
- 对象层级：`app → mod`、`o_room → seatlist[seat](o_player) / o_desk(.data.*)`。
|
||||
- 三层路由：`app(按app) → route(按route) → rpc(按rpc)`，框架自动投递，你只写 `mod.rpc 方法`。
|
||||
- `DoPack` 的 `return` 不是可靠下发通道 → **一律主动 `sendpack_toseat` 推送**。
|
||||
- 房间生命周期由 export/import 接缝串起：`makewar` 开局、`get_deskinfo` 重连、`deduct_roomcard` 首局扣卡、`save_grade` 终局保存并自动回收。
|
||||
|
||||
下一篇 [02-子游戏接入与开发流程](./02-子游戏接入与开发流程.md) 讲：这三个文件具体怎么写、8+4 个接口各做什么、一次操作的完整数据流。
|
||||
</content>
|
||||
@@ -0,0 +1,309 @@
|
||||
# 02 · 子游戏接入与开发流程
|
||||
|
||||
本篇讲**怎么动手**：一个子游戏由哪三个必需文件构成、`export.js` 的一组回调接口与 `import.js` 的封装接口各做什么、`makewar`/重连怎么写，以及一次玩家操作从收包到推送的完整数据流。
|
||||
|
||||
> 仍以麻将举例，但"三文件架构 + export/import 接口 + 主动推送"对任意子游戏一致。
|
||||
|
||||
> **命名说明**：本篇代码里的业务 `rpc` 名（`playCard`、`declareHu` 等）与 handler/类/文件名（`RpcHandler.handlePlayCard`、`OperationManager`、`ResponseBuilder`、`BroadcastManager` 等）均为**示例、可自定**（业务 `rpc` 名只需前后端一致）；只有平台接缝上的名字（包字段、`export`/`import` 钩子名、平台 API、`data.success`）是契约。详见 [README「命名约定」](./README.md)。
|
||||
|
||||
---
|
||||
|
||||
## 1. 文件结构
|
||||
|
||||
### 必需三件套（固定文件名）
|
||||
|
||||
```
|
||||
server/<游戏容器目录>/<你的游戏>/ （容器目录名由接入方自定，非框架强制，见 01）
|
||||
├── mod.js 模块入口：创建模块、按序加载文件、定义 RPC 方法
|
||||
├── export.js 对平台暴露的一组回调接口（平台按需回调，子游戏按需实现）
|
||||
└── import.js 对平台服务的封装接口（本项目 4 个）
|
||||
```
|
||||
|
||||
### 业务分层（复杂游戏推荐）
|
||||
|
||||
按职责拆分，**一个文件一个明确职责**，被依赖者先加载（见 04 的"模块职责边界"）：
|
||||
|
||||
```
|
||||
├── game/ 对局编排：状态管理、控制器、对平台的适配器
|
||||
├── rpc/ 收发包：各 RPC handler、广播、响应构建、序列化
|
||||
├── rules/ 规则解析与规则引擎
|
||||
├── shared/ 前后端共享代码（改这里，再用脚本同步到前端）
|
||||
├── utils/ 日志、错误处理等工具
|
||||
└── tests/ 单元/集成测试
|
||||
```
|
||||
|
||||
> 举例（麻将）：`game/RoomAdapter.js`(房间↔对局适配)、`game/GameController.js`(对局编排)、`rpc/BroadcastManager.js`(差异化广播)、`rpc/handlers/*`(各操作处理)。换个玩法，分层思路不变，文件内容不同。
|
||||
|
||||
---
|
||||
|
||||
## 2. `mod.js` —— 模块入口
|
||||
|
||||
`mod.js` 做三件事：**创建模块 → 按依赖顺序加载文件 → 定义 RPC 方法**。
|
||||
|
||||
### 2.1 创建模块
|
||||
|
||||
```js
|
||||
// cls_mod.new(模块名, 路由名, 所属应用)
|
||||
var mod_<你的游戏> = mod_<你的游戏> || cls_mod.new("mod_<你的游戏>", "<你的游戏>", youle_app);
|
||||
```
|
||||
|
||||
路由名即前端包里的 `route`：**必须与前端包的 `route` 一致、且在应用内唯一**；它与目录名并无绑定关系（`routename` 与目录同名只是约定，非框架要求）。
|
||||
|
||||
### 2.2 按依赖顺序加载文件
|
||||
|
||||
被依赖的先加载；`export.js`/`import.js` 通常在业务类之后加载（它们会用到业务模块）：
|
||||
|
||||
```js
|
||||
// 浏览器/友乐：min_loadJsFile 异步链式加载
|
||||
min_loadJsFile("<容器目录>/<你的游戏>/常量与工具.js", function(){
|
||||
min_loadJsFile("<容器目录>/<你的游戏>/数据结构.js", function(){
|
||||
min_loadJsFile("<容器目录>/<你的游戏>/export.js", function(){
|
||||
min_loadJsFile("<容器目录>/<你的游戏>/import.js", function(){
|
||||
min_loadJsFile("<容器目录>/<你的游戏>/业务与rpc.js", function(){
|
||||
console.log("模块 [" + mod_<你的游戏>.modname + "] 加载完成");
|
||||
});});});});});
|
||||
```
|
||||
|
||||
> 推荐分层加载顺序：**常量 → 工具 → 数据结构 → export/import → 收发包层 → 业务层 → 规则引擎**。Node 测试侧用 `require`（写在守卫块内），浏览器侧用 `min_loadJsFile`，两套并存但按全局名统一引用（见 01）。
|
||||
|
||||
### 2.3 定义 RPC 方法（规范）
|
||||
|
||||
RPC 方法是**前后端交互的服务端入口**。以下是必须遵守的规范（**规则是契约**，示例里的具体方法名/handler 名可自定，见 [README「命名约定」](./README.md)）。
|
||||
|
||||
#### 规则一：函数名 = 前端包的 `rpc` 字段（无二次路由）
|
||||
|
||||
框架的第三层路由（`class.mod.js` 的 `DoPack`）**直接用 `pack.rpc` 当函数名去 `mod` 上取方法调用**——`if (mod[pack.rpc]) mod[pack.rpc](pack)`。所以：
|
||||
|
||||
- 你在 `mod` 上挂一个**与前端 `rpc` 同名**的方法，框架就会自动调到它；这个"同名映射"是**契约**。
|
||||
- **一个操作 = 一个 RPC 方法**。**禁止**把多个操作塞进一个入口再用 `switch(action)` 二次路由——那等于绕开框架路由、退化成自建分发。
|
||||
- 方法名本身（`playCard`/`declareHu`…）由你和前端约定，只要**两端字符串一致**即可；大小写/风格随子游戏。
|
||||
|
||||
#### 规则二：方法体只"接住并委托"，逻辑放 handler（`mod.js` 保持薄）
|
||||
|
||||
RPC 方法本身**不写业务逻辑**，只把 `pack` 转交给收发包层的 handler；真正的参数校验、业务编排、广播都在 handler 里：
|
||||
|
||||
```js
|
||||
// mod_<你的游戏> 上挂的 RPC 方法（示例名，可自定）
|
||||
mod_<你的游戏>.playCard = function(pack) {
|
||||
// 就绪守卫：handler 由 min_loadJsFile 异步加载，未就绪时防御性返回（见规则四）
|
||||
if (typeof RpcHandler === 'undefined' || !RpcHandler) {
|
||||
return { success: false, error: 'RPC处理器未就绪' };
|
||||
}
|
||||
return RpcHandler.handlePlayCard(pack); // 委托到收发包层，真正逻辑在这里
|
||||
};
|
||||
mod_<你的游戏>.declareHu = function(pack) {
|
||||
return RpcHandler.handleDeclareHu(pack);
|
||||
};
|
||||
```
|
||||
|
||||
> `RpcHandler`、`handlePlayCard` 这些是**本项目的命名示例**；换成任何风格都行，关键是"薄入口 + 委托"的分层。
|
||||
|
||||
#### 规则三：`return` 不是给前端的下发通道
|
||||
|
||||
RPC 方法/handler 的 `return` 值**不会可靠地下发到前端**（机制见 01 §4、03 §4）。上面示例里 `return { success:false, ... }` 只是**服务端内部/防御用途**；真正让前端看到的结果（含成功/失败）**必须靠 handler 内部主动推送** `o_room.method.sendpack_toseat/sendpack_toother`，且推送 `data` 自带 `success`（见 03 §5）。
|
||||
|
||||
#### 规则四：注册时机——handler 就绪后再挂 RPC 方法
|
||||
|
||||
浏览器/友乐运行时用 `min_loadJsFile` **异步**加载各文件，RPC 方法委托的 handler 可能**晚于** `mod.js` 主体就绪。因此：
|
||||
|
||||
- 把 RPC 方法的定义收敛到一个"**依赖加载完成后再执行**"的注册函数里（本项目为 `defineRpcMethods()`，在加载链回调末尾调用），避免在 handler 尚未加载时就引用它。
|
||||
- 每个 RPC 方法开头再加一道**就绪守卫**（如上例 `typeof RpcHandler === 'undefined'`）兜底，防止极端时序下 `undefined` 崩溃。
|
||||
|
||||
#### 新增一个前后端接口的完整步骤
|
||||
|
||||
1. 服务端：在 `mod.js` 的 RPC 注册处加 `mod_<游戏>.<rpc> = function(pack){ return XxxHandler.handleXxx(pack); }`；
|
||||
2. 服务端：在 handler 层实现 `handleXxx`（安检 → 委托权威业务 → 主动推送，见 03 §2）；
|
||||
3. 前端：发包时带 `rpc: "<rpc>"`（与服务端方法名一致）。
|
||||
|
||||
**不要**在受限前端接口文件里新增接口（见 04），也**不要**用 `switch(action)` 二次路由。
|
||||
|
||||
#### 本项目已定义的 RPC 方法（示例参考）
|
||||
|
||||
`jinxianmahjong` 实际挂了这些 RPC（名字均为示例，仅示范"一操作一方法"的粒度）：
|
||||
`playCard`、`declareHu`、`declareGang`/`mingGang`/`anGang`/`buGang`/`declareJingGang`、`declarePeng`、`declareChi`、`passAction`、`playerReady`、`gameStart`、`getRoomInfo`、`declareBaoding`、`rollDiceSelectJing`/`playerRollDice`、`setHostingState`/`cancelHostingState`/`getHostingInfo`。可见：**每个玩家动作/查询各占一个独立 RPC**，无一处用 `action` 二次分发。
|
||||
|
||||
---
|
||||
|
||||
## 3. `export.js` —— 平台回调子游戏的接口（按需实现）
|
||||
|
||||
平台在房间生命周期的各节点回调子游戏 `export` 上的一组接口。**这些接口全部是"可选钩子"**：平台侧每一个调用都写成 `if (mod_game.export.<接口>) { ... }`（见 `youle/server_room/class.import.js`），**没有任何一个是框架强制必须实现的**——子游戏**按玩法需要实现其中的一部分**，未实现的钩子平台会跳过（部分钩子有平台默认行为）。用工厂模式创建，文件末尾挂到 `mod.export`：
|
||||
|
||||
```js
|
||||
var cls_<游戏>_export = cls_<游戏>_export || {
|
||||
new: function() {
|
||||
var exp = {};
|
||||
exp.get_needroomcard = function(roomtype, o_game_config) { /* ... */ };
|
||||
exp.get_asetcount = function(roomtype, o_game_config) { /* ... */ };
|
||||
exp.get_needroomcard_joinroom = function(roomtype, o_game_config) { return 0; };
|
||||
exp.makewar_playercount = function(roomtype, o_game_config) { /* ... */ };
|
||||
exp.makewar = function(o_room, o_game_config) { /* ... */ };
|
||||
exp.get_deskinfo = function(o_room, seat) { /* ... */ };
|
||||
exp.get_disbandRoom = function(o_room) { /* ... */ };
|
||||
exp.player_enter = function(o_room, seat) { /* ... */ };
|
||||
exp.player_leave = function(o_room, seat) { /* ... */ };
|
||||
// …按需再实现 restore_room / player_prepare / check_*_permission 等
|
||||
return exp;
|
||||
}
|
||||
};
|
||||
mod_<你的游戏>.export = cls_<游戏>_export.new(); // 文件末尾自动挂载
|
||||
```
|
||||
|
||||
### 3.0 最常用的一批接口
|
||||
|
||||
绝大多数房卡玩法都会实现下面这批：
|
||||
|
||||
| 接口 | 何时被调 | 返回 | 职责 |
|
||||
|------|----------|------|------|
|
||||
| `get_needroomcard` | 创建房间 | Number | 该房型创建需要的房卡数（由你解析 `roomtype`） |
|
||||
| `get_asetcount` | 创建房间 | Number | 该房型总局数（小局数量） |
|
||||
| `get_needroomcard_joinroom` | 他人加入 | Number | 加入需要的房卡数（多数玩法返回 0） |
|
||||
| `makewar` | 开战 | Object | **创建 `o_desk`、初始化对局、返回开战数据包** |
|
||||
| `get_deskinfo` | 重连/中途加入 | Object | **返回该座位当前完整快照** |
|
||||
| `get_disbandRoom` | 解散达成 | Object | 返回解散数据包 |
|
||||
| `player_enter` | 中途进入 | Object? | 处理新玩家加入 |
|
||||
| `player_leave` | 中途退出 | Object? | 处理玩家离开（如清理其托管/占位） |
|
||||
|
||||
### 3.0.1 其它常见可选钩子（按需实现）
|
||||
|
||||
平台还暴露一批可选钩子，本项目实际用到的有：
|
||||
|
||||
| 接口 | 何时被调 | 职责 |
|
||||
|------|----------|------|
|
||||
| `makewar_playercount` | 未满桌但有人准备时 | 返回"达到几人准备即自动开战"的人数（无则等满桌） |
|
||||
| `restore_room` | **服务器重启后恢复房间** | 用平台持久化的 `o_deskinfo` 重建对局状态 |
|
||||
| `player_prepare` / `createroom_needprepare` | 准备机制 | 是否需要准备、玩家点准备时的处理 |
|
||||
| `check_joinroom_permission` / `check_createroom_permission` | 加入/创建房间前 | 自定义准入校验 |
|
||||
|
||||
> 平台的完整钩子清单以 `youle/server_room/class.import.js` 为准（如 `deduct_roomcard_mode`、`owner_beanpush`、`getWinnerByGameInfo` 等）；用到哪个就实现哪个，**不要因为"文档列了就全实现"**。
|
||||
|
||||
> `roomtype` 是一个由子游戏**自定义、自解析**的房型编码（数组或数字串），各位代表局数/人数/扣卡方式/玩法开关等。它的含义只有你的子游戏知道，平台不解释它。
|
||||
|
||||
### 3.1 `makewar` 是接入的核心
|
||||
|
||||
`makewar` 必须完成三件事，缺一不可：
|
||||
|
||||
```js
|
||||
exp.makewar = function(o_room, o_game_config) {
|
||||
// 1) 创建子游戏牌桌对象，并与房间建立【双向引用】
|
||||
if (!o_room.o_desk) { o_room.o_desk = {}; }
|
||||
if (!o_room.o_desk.data) { o_room.o_desk.data = {}; }
|
||||
o_room.o_desk.o_room = o_room; // 反向引用
|
||||
|
||||
// 2) 创建对局状态，挂到 o_room.o_desk.data.*（房间隔离的落点）
|
||||
var gameState = createGameState(o_room, o_game_config);
|
||||
o_room.o_desk.data.gameState = gameState; // 此后所有业务都从这里读对局态
|
||||
|
||||
// 3) 返回开战数据包（通常按座位差异化下发）
|
||||
return {
|
||||
success: true,
|
||||
sendtype: 1, // 差异化标记：平台逐座位下发
|
||||
seatlist: [ { seat: 0, data: {/* 0号位能看到的 */} }, /* ... */ ]
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
要点：
|
||||
- **此时不需要知道"谁"坐在每个位置**，只需知道有几个位置有人——身份由平台管理。
|
||||
- **对局状态挂 `o_room.o_desk.data.*`**，不要放模块级单例/全局（见 04）。
|
||||
- 开战包对应前端的 `Game_Modify.StartWar`：**改了 `makewar` 下发结构，必须同步改前端 StartWar 解析**（见 03）。
|
||||
|
||||
### 3.2 `get_deskinfo` 处理重连
|
||||
|
||||
重连/中途加入时，平台带着 `seat` 来要"当前快照"。你要把该座位此刻该看到的一切（手牌仅本人可见、弃牌区、轮到谁、可用操作、倒计时、比分等）从 `o_room.o_desk.data.*` 组装返回。它对应前端的 `Game_Modify.Reconnect`。
|
||||
|
||||
> 关键：重连快照应与正常对局推送**复用同一套状态组装逻辑**，避免两份并行实现随规则演化而分叉（数据权威原则，见 04）。
|
||||
|
||||
---
|
||||
|
||||
## 4. `import.js` —— 子游戏调用平台的 4 个接口
|
||||
|
||||
这 4 个接口是对平台 `youle_room.export` 的薄封装，**逻辑由平台实现，你只管在正确时机调用**：
|
||||
|
||||
```js
|
||||
mod_<你的游戏>.import = (function() {
|
||||
var imp = {};
|
||||
imp.check_player = function(agentid, gameid, roomcode, seat, playerid, conmode, fromid) {
|
||||
return mod_<你的游戏>.app.youle_room.export.check_player(
|
||||
agentid, gameid, roomcode, seat, playerid, conmode, fromid);
|
||||
};
|
||||
imp.deduct_roomcard = function(o_room) {
|
||||
return mod_<你的游戏>.app.youle_room.export.deduct_roomcard(o_room);
|
||||
};
|
||||
imp.save_grade = function(o_room, o_gameinfo1, o_gameinfo2, freeroomflag) {
|
||||
return mod_<你的游戏>.app.youle_room.export.save_grade(
|
||||
o_room, o_gameinfo1, o_gameinfo2, freeroomflag);
|
||||
};
|
||||
imp.finish_gametask = function(agentid, o_player, taskid, finishamount) {
|
||||
return mod_<你的游戏>.app.youle_room.export.finish_gametask(
|
||||
agentid, o_player, taskid, finishamount);
|
||||
};
|
||||
return imp;
|
||||
})();
|
||||
```
|
||||
|
||||
| 接口 | 调用时机（关键） | 作用 |
|
||||
|------|------------------|------|
|
||||
| `check_player` | **每个 RPC handler 开头** | 校验玩家位置/连接，返回 `o_room` 或 `null` |
|
||||
| `deduct_roomcard` | **第一小局结算时（仅一次）** | 扣房卡。注意**不是开战时扣** |
|
||||
| `save_grade` | **大局完全结束、战绩算好后** | 保存战绩；调用后**平台自动释放房间** |
|
||||
| `finish_gametask` | 完成游戏内任务时（可选） | 上报任务进度 |
|
||||
|
||||
> 时机错误是高频 bug：`deduct_roomcard` 放到开战时会导致重复/错误扣卡；`save_grade` 在结算数据没算完就调用会保存到残缺战绩。
|
||||
|
||||
---
|
||||
|
||||
## 5. 一次玩家操作的完整数据流
|
||||
|
||||
把 01 的路由和本篇的接口串起来，一次"出牌"从收包到下发如下（其它操作同构）：
|
||||
|
||||
```
|
||||
① 客户端发包 { app:"youle", route:"<游戏>", rpc:"playCard", data:{ roomcode, seat, ... } }
|
||||
│ 三层路由（见 01）
|
||||
▼
|
||||
② mod.<游戏>.playCard(pack) → 委托 RpcHandler.handlePlayCard(pack)
|
||||
│
|
||||
▼
|
||||
③ handler：参数提取 + 校验
|
||||
var o_room = mod.import.check_player(...); // 校验玩家；失败直接 return
|
||||
if (!o_room) return;
|
||||
var o_desk = o_room.o_desk; if (!o_desk) return;
|
||||
// 状态/轮次/合法性校验（轮到该座？这张牌在手里？）
|
||||
│
|
||||
▼
|
||||
④ 执行业务（委托给权威业务模块，handler 不内联规则）
|
||||
var result = OperationManager.handleOperation(o_room, params);
|
||||
│
|
||||
▼
|
||||
⑤ 构建响应（按需补充摸牌、可用操作、倒计时、比分、游戏状态等）
|
||||
var responseData = ResponseBuilder.buildPlayCardResponse(...);
|
||||
│
|
||||
▼
|
||||
⑥ 差异化广播：为每个座位定制其「可见数据」并主动推送
|
||||
BroadcastManager.broadcastPlayCard(o_room, responseData);
|
||||
→ 内部对每个座位组 msg，调用 o_room.method.sendpack_toseat(msg, seat)
|
||||
→ 前端按既有 playCard 逻辑解析（无需区分触发源）
|
||||
```
|
||||
|
||||
每个环节的纪律：
|
||||
|
||||
- **③ 校验必做且失败静默 `return`**：不要给客户端回作弊提示，`check_player` 失败、状态不对、轮次不对都直接 `return`。
|
||||
- **④ 不在 handler 内重造规则**：胡牌检测、听牌分析、合法操作枚举等核心算法调用权威模块，handler 只编排（见 04）。
|
||||
- **⑥ 主动推送、自带成败**：下发**唯一靠 `sendpack_toseat/toother` 主动推送**；凡有成败语义的推送，`data` 必须带 `success`（见 03）。
|
||||
- **服务端代替玩家操作（如 AI 托管）走的是同一条 ④⑤⑥ 链路**，只是触发源从"前端请求"变成"服务端决策"，对前端透明（见 04）。
|
||||
|
||||
---
|
||||
|
||||
## 6. 接入自检清单
|
||||
|
||||
新接入或改动子游戏时，逐条核对：
|
||||
|
||||
- [ ] `mod.js` 用 `cls_mod.new` 创建，路由名与前端 `route` 一致；文件按依赖顺序加载。
|
||||
- [ ] `export.js` 按玩法需要实现相应回调接口（至少含"最常用的一批"，见 §3）并在末尾挂到 `mod.export`。
|
||||
- [ ] `makewar` 创建了 `o_desk`、建立 `o_room.o_desk` ↔ `o_desk.o_room` 双向引用、对局态挂 `o_desk.data.*`、返回开战包。
|
||||
- [ ] `get_deskinfo` 能给出与正常对局一致的当前快照（复用状态组装，不另写一份）。
|
||||
- [ ] `import.js` 4 接口就位；`deduct_roomcard` 在首局结算调、`save_grade` 在终局调。
|
||||
- [ ] 每个 RPC handler：先 `check_player` → 取 `o_desk` → 校验 → 委托业务 → 主动推送。
|
||||
- [ ] 改了下发结构，前端 `StartWar`/`Reconnect`/对应操作解析同步检查。
|
||||
|
||||
下一篇 [03-数据收发与通信协议](./03-数据收发与通信协议.md) 详解包结构、发包方式、主动推送与 `success` 成败协议。
|
||||
</content>
|
||||
@@ -0,0 +1,264 @@
|
||||
# 03 · 数据收发与通信协议
|
||||
|
||||
本篇是**日常手册**：数据包长什么样、收包要做哪些固定步骤、三种发包方式怎么选、为什么"主动推送"是唯一可靠的下发通道，以及本项目最重要的一条——**成败标志只认 `data.success`**。
|
||||
|
||||
> **命名说明**：本篇代码里的业务 `rpc` 名（`playCard` 等）与 handler/类/函数名（`BroadcastManager`、`deepCopy` 等）均为**示例、可自定**；只有平台接缝上的名字（包四字段、平台 API `sendpack_toseat`/`sendpack_toother`、成败字段 `data.success`）是契约。详见 [README「命名约定」](./README.md)。
|
||||
|
||||
---
|
||||
|
||||
## 1. 数据包结构
|
||||
|
||||
所有前后端数据包统一四字段：
|
||||
|
||||
```js
|
||||
{
|
||||
app: "youle", // 应用名（游戏固定 "youle"）
|
||||
route: "<你的游戏>", // 路由名 = 服务端 cls_mod.new 第二参 routename（见 §1.1）
|
||||
rpc: "playCard", // 方法名，决定调到 mod 的哪个函数 / 前端走哪个解析分支（见 02 §2.3）
|
||||
data: { /* 业务数据 */ }
|
||||
}
|
||||
```
|
||||
|
||||
- `app/route/rpc` 三字段驱动三层路由（见 01）。
|
||||
- `data` 里**必含平台参数**：`agentid`、`playerid`、`gameid`、`roomcode`、`seat` 等；数值参数收包时要 `parseInt`。
|
||||
- **一包多信息**：一个响应包应携带本次状态变更的完整信息（出了什么牌、轮到谁、各家剩余、倒计时、比分……），减少往返。
|
||||
|
||||
### 1.1 `route` / `routename` 从哪来、在哪定义、怎么匹配
|
||||
|
||||
`route` 决定包被投到**哪个模块**，是前后端必须对齐的字符串。它的权威定义与匹配链如下（均可在代码验证）：
|
||||
|
||||
- **服务端：`routename` 的唯一定义点**是 `mod.js` 里创建模块的 `cls_mod.new(模块名, 路由名, 所属应用)` 的**第二个参数**：
|
||||
|
||||
```js
|
||||
// server/games2/<你的游戏>/mod.js
|
||||
var mod_<你的游戏> = global.mod_<你的游戏>
|
||||
|| cls_mod.new("mod_<你的游戏>", "<你的游戏>", youle_app);
|
||||
// ▲ 第一参 modname ▲ 第二参 routename（就是 route 要用的值）
|
||||
```
|
||||
|
||||
`cls_mod.new` 把第二参存进 `mod.routename`，并把模块 `push` 进 `app.modlist`（`server/class/class.mod.js`）。
|
||||
- **它是你自定义的字符串**：由你起名，只要**在应用内唯一**即可；与目录名、与模块名 `modname`（第一参，用于全局暴露 `global[modname]`、`app[modname]`）都**无强制绑定**——本项目三者恰好都叫 `jinxianmahjong` 只是约定（见 02 §2.1、01 §5）。
|
||||
- **平台按它匹配模块**：收包时 `cls_app.ReceivePack` 用 `pack.route == modlist[i].routename` 找到模块，再 `DoPack` 进第三层按 `rpc` 调方法（`server/class/class.app.js`，见 01 §4）。
|
||||
- **前端发包的 `route` 必须与它逐字一致**：前端把该值固化为常量（本项目 `codes/game/network/RpcSender.js` 里 `var ROUTE_NAME = 'jinxianmahjong'`，经 `Utl.sendData(app, route, rpc, data)` 发出）。**两端字符串不一致 → 平台匹配不到模块，包被静默丢弃**（前端也收不到任何响应）。
|
||||
- **与平台房间模块区分**：平台自带的房间模块 `routename` 是 `"room"`，处理创建/加入/开战（`createRoom`、`self_join_room`、`self_makewar` 等）；**你的子游戏自定义 RPC**（`playCard` 等）走**你自己的 `routename`**。两者不要混用：平台流程发 `route:"room"`，玩法操作发 `route:"<你的游戏>"`。
|
||||
|
||||
> 一句话：**`routename` 在服务端 `cls_mod.new` 第二参定义（自定、应用内唯一），前端发包 `route` 必须与它逐字相同，平台据此把包投到你的模块**；改名要两端同步改。
|
||||
|
||||
---
|
||||
|
||||
## 2. 收包处理的固定步骤（在 handler 里）
|
||||
|
||||
`mod` 上的 RPC 方法只是**薄入口**（`return XxxHandler.handleXxx(pack)`，见 02 §2.3）；下面这套"安检流程"发生在**它委托到的 handler 内部**，**不可省略、不可简化**：
|
||||
|
||||
```js
|
||||
XxxHandler.handlePlayCard = function(pack) { // 由 mod_<游戏>.playCard 委托进来
|
||||
try {
|
||||
// 1) 提取并校验参数：列出必填字段 + 数值型字段的类型要求
|
||||
// （本项目用统一工具 ValidationHelper.extractAndValidateParams 做这件事）
|
||||
// 等价于：agentid/playerid/gameid/roomcode/seat 必填，playerid/roomcode/seat 需为数值
|
||||
var params = extractAndValidateParams(
|
||||
pack,
|
||||
['agentid', 'playerid', 'gameid', 'roomcode', 'seat', 'cardUniqueId'],
|
||||
{ playerid: 'number', roomcode: 'number', seat: 'number' });
|
||||
if (!params.success) return { success: false, error: params.error };
|
||||
var p = params.params;
|
||||
|
||||
// 2) 校验玩家与房间（必做）——失败直接 return
|
||||
// ⚠️ conmode / fromid 取自 pack 顶层（不是 pack.data），是发包定向要用的连接信息
|
||||
var o_room = mod_<游戏>.import.check_player(
|
||||
p.agentid, p.gameid, p.roomcode, p.seat, p.playerid, pack.conmode, pack.fromid);
|
||||
if (!o_room) return { success: false, error: '玩家验证失败' };
|
||||
|
||||
// 3) 取桌对象与对局状态
|
||||
var o_desk = o_room.o_desk;
|
||||
if (!o_desk) return { success: false, error: '游戏桌不存在' };
|
||||
|
||||
// 4) 调试记录（若框架提供）——便于复盘
|
||||
if (o_desk.debug && o_desk.debug.save_receivepack) {
|
||||
o_desk.debug.save_receivepack(pack, p.seat, p.playerid);
|
||||
}
|
||||
|
||||
// 5) 业务校验 + 执行业务：委托权威模块（handler 不内联规则，见 04）
|
||||
// 如：OperationExecutor.executePlayCard(o_room, {...})
|
||||
// 6) 构建响应 + 【主动推送】：ResponseBuilder 组包 → BroadcastManager 逐座位 sendpack_toseat
|
||||
// 推送 data 自带 success（见 §5）；return 不是下发通道（见 §4）
|
||||
} catch (e) { /* 记录日志；必要时给该座推送失败包 */ }
|
||||
};
|
||||
```
|
||||
|
||||
- **参数提取要校验类型**：数值字段（`playerid`/`roomcode`/`seat` 等）必须转成数值再用；缺字段/类型不符即判失败。用统一工具集中做（本项目 `ValidationHelper.extractAndValidateParams`）比每处手写 `parseInt` 更不易漏。
|
||||
- **`check_player` 是强制安检**：校验座位、连接、身份，返回 `o_room` 或 `null`；`null` 一律 `return`。它的第 6/7 个参数 `pack.conmode`、`pack.fromid` 来自**包顶层**（框架收包时注入），是后续定向发包的连接凭据。
|
||||
- **校验失败不回作弊提示**：对客户端不下发"你作弊了"之类反馈，直接结束（如需可只给本座推送一个通用失败包），避免给作弊者信息。
|
||||
- **`return` 值仅服务端内部用**：例中的 `return {success:false,...}` 不会下发前端（见 §4）；要让前端看到的结果一律走第 6 步主动推送。
|
||||
|
||||
---
|
||||
|
||||
## 3. 三种发包方式
|
||||
|
||||
| 方式 | 接口 | 用于 |
|
||||
|------|------|------|
|
||||
| 点对点 | `o_room.method.sendpack_toseat(msg, seat)` | 只发给某个座位（个人状态、定向数据） |
|
||||
| 广播其他人 | `o_room.method.sendpack_toother(msg, seat)` | 发给除 `seat` 外所有人（`seat=-1` 即全发） |
|
||||
| 差异化广播 | 逐座位组 `msg` 后各自 `sendpack_toseat` | 每个玩家看到的内容不同（如手牌只发本人） |
|
||||
|
||||
平台发包内部会**从 `seatlist[seat]` 上取 `conmode`/`fromid`** 填入包，再交给底层 `SendPack` 按 TCP/HTTP 下发——**这两个连接字段不需要你手工设置**，只要座位上有在线玩家即可。
|
||||
|
||||
### 差异化广播：棋牌最常用
|
||||
|
||||
牌类游戏里"同一动作、各家可见不同"，所以广播时为每个座位**深拷贝一份基础数据再定制**：
|
||||
|
||||
```js
|
||||
for (var seat = 0; seat < o_room.seatlist.length; seat++) {
|
||||
if (!o_room.seatlist[seat]) continue; // 空座跳过
|
||||
var msg = {
|
||||
app: "youle", route: "<游戏>", rpc: "playCard",
|
||||
data: deepCopy(baseData) // 公共信息
|
||||
};
|
||||
if (seat === actionSeat) {
|
||||
msg.data.handCards = hands[seat]; // 仅本人可见手牌
|
||||
} else {
|
||||
msg.data.handCards = []; // 他人看不到
|
||||
}
|
||||
o_room.method.sendpack_toseat(msg, seat);
|
||||
}
|
||||
```
|
||||
|
||||
> 敏感信息（手牌、暗牌、未公开的判定）**只发给该看到的人**，这是服务器权威的一部分。
|
||||
|
||||
---
|
||||
|
||||
## 4. 主动推送是唯一可靠的下发通道
|
||||
|
||||
**前端收包的唯一通道是服务端主动推送**（`sendpack_toseat / toother` → 底层 `SendPack`）。
|
||||
|
||||
而 RPC 方法的 **`return` 值不可靠下发前端**：框架虽会对 `DoPack` 的返回值做一次回发，但它只回当前请求连接、不按座位定向，浏览器/友乐链路下不能当作状态推送通道（机制见 01 §4）。
|
||||
|
||||
**推论**：凡需要让前端看到的结果（包括操作的成功/失败），都必须放进**主动推送的 `data`** 里。
|
||||
|
||||
---
|
||||
|
||||
## 5. 成败标志协议（本项目最重要的一条）
|
||||
|
||||
> 这条覆盖并修正了早期文档里"用 HTTP 风格 `status` 码判成败"的写法。**以本协议为准。**
|
||||
|
||||
### 规则
|
||||
|
||||
1. **成败唯一权威字段是 `data.success`（boolean）**。前端一律 `if (!data.success)` 判断操作成败。
|
||||
2. **禁止用 `data.status`（如 `status === 200`）或 `data.code` 判成败**。`status`/`code` 只能作展示/日志用的细分信息，不参与成败裁定。
|
||||
3. **主动推送必须自带 `success`**：因为 `return` 不下发前端，凡有成败语义的**推送包**，其 `data` 必须显式带 `success: true/false`，不能只放 `status`。
|
||||
4. **禁止双轨/兼容兜底**：前端不得写 `status !== 200 && !success` 之类的 `status` 兜底；新增/改动的推送一律补齐 `success`，前端一律只认 `success`。
|
||||
|
||||
### 正反例
|
||||
|
||||
```js
|
||||
// ❌ 错误：推送只带 status，前端读 data.success 恒 undefined → 误判失败
|
||||
o_room.method.sendpack_toseat({
|
||||
app:"youle", route:"<游戏>", rpc:"setHostingState",
|
||||
data: { status: 200, hosting: true } // 少了 success
|
||||
}, seat);
|
||||
|
||||
// ✅ 正确：成败语义放 success，status 仅作细分
|
||||
o_room.method.sendpack_toseat({
|
||||
app:"youle", route:"<游戏>", rpc:"setHostingState",
|
||||
data: { success: true, status: 200, hosting: true }
|
||||
}, seat);
|
||||
```
|
||||
|
||||
```js
|
||||
// 前端：只认 success
|
||||
if (!data.success) { /* 失败处理 */ return; }
|
||||
// data.status / data.code 仅用于展示或日志细分
|
||||
```
|
||||
|
||||
> 典型事故：托管状态推送 `{ status: 200, ... }` 不带 `success`，前端读 `data.success` 恒为 `undefined`，于是"已进入托管却报失败"。根因就是违反了本协议第 3 条。
|
||||
|
||||
---
|
||||
|
||||
## 6. 端到端收发全链路（前后端对照）
|
||||
|
||||
本节把**一个包从前端出发、到服务端处理、再推回前端**的完整链路摊开，标出**每一步在谁的哪个文件/函数**，供前端与服务端开发共同对照。下面的锚点里，**平台/契约名**（包字段、`packet_face.ReceivePack`、`Utl.sendData`、`Game_Modify.*`、`sendpack_toseat`、`data.success`）是真实且固定的；**子游戏侧命名**（`RpcSender`、`SubGameHooks`、收包分发器、各 handler）是本项目示例、可自定（见 [README「命名约定」](./README.md)）。
|
||||
|
||||
### 6.1 方向 A：玩家主动操作（请求 → 处理 → 推送）
|
||||
|
||||
```
|
||||
前端 client 服务端 server
|
||||
──────────────── ────────────────
|
||||
业务/控制器
|
||||
└ 发包封装 / RpcHelper（自动补 agentid/playerid/roomcode/seat…）
|
||||
└ Utl.sendData(app, route, rpc, data) ──WS/HTTP──▶ packet_face.ReceivePack （按 app 找应用）
|
||||
(平台 08_Utl_Output.js) └ cls_app.ReceivePack （按 route 找模块，01 §4）
|
||||
└ cls_mod.DoPack （按 rpc 找方法）
|
||||
└ mod[rpc](pack) RPC 薄入口（02 §2.3）
|
||||
└ XxxHandler.handleXxx(pack)
|
||||
check_player → 取 o_desk → 校验
|
||||
→ 委托权威业务模块（04）
|
||||
→ o_room.method.sendpack_toseat(msg, seat)
|
||||
（填 conmode/fromid）
|
||||
Game_Modify._ReceiveData(_msg) ◀──WS/HTTP── → app.SendPack → packet_face.SendPack
|
||||
(平台 02_SubGame_Input.js，受限文件) （只定向该座位的那条连接，01 §4）
|
||||
└ 转交子游戏收包分发器（SubGameHooks._ReceiveData）
|
||||
└ 按 _msg.rpc 查路由表 → 对应 rpc 处理器
|
||||
└ if(!data.success) 失败处理；否则改数据模型 → 表现（04 篇）
|
||||
```
|
||||
|
||||
- **前端出口只有一个**：所有请求经发包封装/`RpcHelper` 最终落到平台 `Utl.sendData(app, route, rpc, data)`，业务不手拼包（前端 04 §1）。
|
||||
- **服务端入口只有一个**：`packet_face.ReceivePack`，随后三层路由 `app→route→rpc` 精确投递（01 §4）。
|
||||
- **服务端出口只有一个**：`o_room.method.sendpack_toseat/sendpack_toother`——它从 `seatlist[seat]` 取 `conmode/fromid` 填入包，交 `app.SendPack` 定向下发（`class.room.js`）。**`return` 不算下发**（§4）。
|
||||
- **前端收口只有一个**：平台 `09_Net.js` 收到主动推送后调 `Game_Modify._ReceiveData(_msg)`（受限文件只转交，不写业务），再由子游戏**收包分发器按 `_msg.rpc`** 分到对应处理器（前端 04 §2）。
|
||||
|
||||
### 6.2 方向 B：服务端主动推送（无前端请求）
|
||||
|
||||
超时、AI 托管、他人操作波及本座、每小局/大局结算等，都是**服务端主动发起**、前端没有对应请求的推送。它**复用方向 A 的后半段**——同样 `sendpack_toseat/toother` → 前端 `_ReceiveData` → 按 `rpc` 分发：
|
||||
|
||||
```
|
||||
服务端某处业务（定时器/AI决策/结算）
|
||||
→ o_room.method.sendpack_toseat(msg, seat) （与真人操作完全相同的出口与包结构）
|
||||
→ 前端 _ReceiveData → 收包分发器按 rpc → 对应处理器
|
||||
```
|
||||
|
||||
> 因此前端**无法也无需区分**一个推送是"我请求的响应"还是"服务端主动发的"——两者走同一条收口、同一张分发表。服务端替玩家操作必须保持这种一致（§7、04 §7）。
|
||||
|
||||
### 6.3 谁在哪：收 / 发 / 路由一览
|
||||
|
||||
| 环节 | 前端（client） | 服务端（server） |
|
||||
|------|----------------|------------------|
|
||||
| **发包出口** | 发包封装/`RpcHelper` → `Utl.sendData(app,route,rpc,data)`（平台 `08_Utl_Output.js`） | `o_room.method.sendpack_toseat` / `sendpack_toother` → `app.SendPack` |
|
||||
| **传输** | WebSocket/HTTP（平台 `09_Net.js` / `00_minhttp.js`） | 平台 `packet.js`（`SendPack_Tcp` / `SendPack_Http`） |
|
||||
| **收包入口** | 平台 `09_Net.js` → `Game_Modify._ReceiveData(_msg)`（受限文件转交） | `packet_face.ReceivePack`（`packet.js`） |
|
||||
| **路由依据** | 子游戏收包分发器按 `_msg.rpc` → 处理器 | 三层 `app→route→rpc`（01 §4），`rpc` 直取同名 `mod` 方法 |
|
||||
| **处理** | 对应 `rpc` 处理器，先判 `data.success` | RPC handler：`check_player` → 取 `o_desk` → 校验 → 委托权威业务 |
|
||||
| **成败标志** | 只认推送 `data.success`（§5） | 推送 `data` 必自带 `success`（§5） |
|
||||
| **开局** | `Game_Modify.StartWar(_msg)`（取本座数据，02 篇/前端 04 §3） | `export.makewar` 返回包（`sendtype:1 + seatlist[]` 差异化） |
|
||||
| **重连/中途加入** | `Game_Modify.Reconnect(_deskinfo)`（据快照重画） | `export.get_deskinfo` 返回该座完整快照 |
|
||||
|
||||
### 6.4 对接接缝：改一端必核对另一端
|
||||
|
||||
`rpc` 是前后端的**共同契约字符串**：服务端推送用哪个 `rpc`，前端就必须在收包分发表里注册同名处理器；反之前端请求的 `rpc`，服务端 `mod` 上必须有同名方法。因此：
|
||||
|
||||
| 场景 | 服务端产出 | 前端接收 |
|
||||
|------|------------|----------|
|
||||
| 开战 | `export.makewar` 的返回包 | `Game_Modify.StartWar(_msg)` → 开局处理 |
|
||||
| 重连/中途加入 | `export.get_deskinfo` 的返回 | `Game_Modify.Reconnect(_deskinfo)` → 重画 |
|
||||
| 对局/推送 | RPC handler 或主动推送（按 `rpc`） | 收包分发表里同名 `rpc` 的处理器 |
|
||||
|
||||
**改服务端下发结构 = 同步核对前端对应 `rpc` 的解析**；**新增一种推送 = 服务端选定 `rpc` + 前端在分发表加同名处理器**。任一端单方面改，另一端必按旧结构解析出错。前端侧的收发细节以 [`client/docs/development-guide/04-网络对接与启动编排`](../../../client/docs/development-guide/04-网络对接与启动编排.md) 为权威。
|
||||
|
||||
---
|
||||
|
||||
## 7. 服务端代替玩家操作时的透明性
|
||||
|
||||
服务端自动替玩家执行的操作（如 AI 托管出牌/碰杠胡），**必须复用真人操作的同一套数据包与广播链路**：产生的包结构、`rpc`、`data` 与真人操作**完全一致**，前端无需也禁止为它单开一套接收/解析分支。唯一区别只在触发源（前端请求 → 服务端决策），其后的数据组织、协议、广播路径不变。（详见 04 的对应红线。）
|
||||
|
||||
---
|
||||
|
||||
## 8. 小结
|
||||
|
||||
- 包结构恒为 `{app, route, rpc, data}`；收包先 `check_player`，失败静默 `return`。
|
||||
- 三种发包方式按"谁该看到什么"选；差异化广播逐座位定制，敏感信息只发本人。
|
||||
- **主动推送是唯一可靠下发通道**，`return` 不算。
|
||||
- **成败只认 `data.success`**，推送必自带 `success`，禁止 `status`/`code` 判成败与兼容兜底。
|
||||
- **端到端一条链**（§6）：前端 `Utl.sendData` → 服务端 `packet_face.ReceivePack`→三层路由→handler→`sendpack_toseat` → 前端 `Game_Modify._ReceiveData`→按 `rpc` 分发；`rpc` 是前后端共同契约，改一端必核对另一端。
|
||||
- 改下发结构必同步核对前端 `StartWar`/`Reconnect`/对应 `rpc` 解析。
|
||||
|
||||
下一篇 [04-开发规范与红线](./04-开发规范与红线.md) 汇总所有必须遵守的工程纪律。
|
||||
</content>
|
||||
@@ -0,0 +1,181 @@
|
||||
# 04 · 开发规范与红线
|
||||
|
||||
本篇汇总所有**必须遵守**的工程纪律。每一条都对应过真实事故或返工，是代码审查的清单来源。改任何代码前，按相关条目自检。
|
||||
|
||||
> **命名说明**：本篇提到的模块/类/文件名（如 `GameStateManager`、`RoomAdapter` 等）多为**示例、可自定**，红线约束的是**做法**而非具体名字；只有平台接缝上的名字（包字段、`export`/`import` 钩子、平台 API、`data.success`）是契约。详见 [README「命名约定」](./README.md)。
|
||||
|
||||
---
|
||||
|
||||
## 1. 可编辑范围
|
||||
|
||||
### 服务端
|
||||
|
||||
- **唯一可编辑目录**：子游戏自己的目录 `server/<游戏容器目录>/<你的游戏>/`。容器目录名由接入方自定，**非框架强制**，换任何不与框架冲突的目录皆可（框架按 `modename` 而非目录名定位子游戏，见 01）。
|
||||
- **禁改**：`server/` 其余一切均为平台代码——`server/class/`、`server/config/`、`server/server/`、`server/youle/`、`server/update/`、`server/packet.js`、`server/applist.js`、`server/minhttp.js` 等。
|
||||
- **唯一例外**：接入新游戏时需在平台文件 `server/youle/app.js` 里加一行 `min_loadJsFile("<容器目录>/<你的游戏>/mod.js", ...)` 完成注册加载——这是必须触碰平台代码的**唯一游戏接入点**，除此之外不得改动 `server/youle/`。
|
||||
|
||||
### 前端
|
||||
|
||||
- **平台代码禁改**：`client/js/00_Surface/` 下全部文件。
|
||||
- **受限接口文件**（不可新增对外接口，尽量不改，确需则只在现有接口内部加逻辑）：
|
||||
`client/js/01_SubGame/00_SubGame_Config.js`、`01_SubGame_modify.js`、`02_SubGame_Input.js`。
|
||||
- **新增前后端交互**一律走 `mod.js` 的 `mod_<游戏>.<rpc>` 机制，**不在受限文件里新增接口**。
|
||||
|
||||
---
|
||||
|
||||
## 2. 语言标准：严格 ES5
|
||||
|
||||
- 全部 JS **必须严格符合 ES5**：用 `var`/`function`、字符串用 `+` 拼接。
|
||||
- **禁止** ES6+：`let`/`const`、箭头函数、模板字符串、解构、默认参数、展开运算符、`class`、`for...of`、`Promise`/`async`/`await`、对象简写等。
|
||||
- 原因：线上浏览器/友乐运行时不保证 ES6+ 支持。
|
||||
|
||||
---
|
||||
|
||||
## 3. 模块加载：require 双运行时守卫
|
||||
|
||||
- **所有 `require` 必须写在文件开头的 `if (typeof require !== 'undefined') { ... }` 守卫块内。**
|
||||
- **禁止函数体内 / 中途 `require`**（含"延迟 require 规避循环依赖"的写法）。浏览器/友乐运行时无 `require`，无守卫的 `require` 会抛 `ReferenceError: require is not defined`。
|
||||
- 跨模块运行时**按全局名引用**：Node 由守卫块 `var X = require(...)` 得到，浏览器由 `mod.js` 加载的同名全局解析。
|
||||
|
||||
```js
|
||||
// ✅ 正确
|
||||
if (typeof require !== 'undefined') {
|
||||
var GameStateManager = require('./dataStructures/GameStateManager.js');
|
||||
}
|
||||
function foo() { GameStateManager.doSomething(); } // 直接用全局名
|
||||
|
||||
// ❌ 错误：函数体内中途 require —— 浏览器崩溃
|
||||
function bar() { var GSM = require('./dataStructures/GameStateManager.js'); }
|
||||
```
|
||||
|
||||
### 双运行时全局暴露陷阱
|
||||
|
||||
"构造函数 + 单例实例"式模块，`module.exports` 之后必须**无条件**把全局名暴露出去（**不要放进 `else` 分支**），否则线上浏览器拿不到该全局，报 `xxx is not a function`，而 Node 测试测不出来。
|
||||
|
||||
---
|
||||
|
||||
## 4. 数据权威原则
|
||||
|
||||
- **数据源唯一**：同一业务数据只有一个权威来源；上游计算/写入/校验，下游只读取/消费，**不重复推断、不重复拼装**。
|
||||
- **禁止猜测兜底**：不用默认值掩盖缺失数据。**关键权威字段缺失要显式报错或返回 `null`**，由上层决定是否终止，**禁止** `|| 0`、`|| []`、`|| ''`、双源回退等掩盖。
|
||||
- **下游不修补**：下游不得为"让流程跑起来"而补写/重算上游本该提供的数据；发现下游在修补，应把责任前移到权威来源。
|
||||
- **边界**：只有展示层、纯 UI 兼容、非关键日志字段，才可在明确边界内用安全默认值。
|
||||
|
||||
> 审查信号：看到 `|| []`、`|| 0`、`|| ''`、三元默认、双源字段，先判断它是不是**权威字段**（影响发牌/庄家/手牌/规则/结算/重连/状态流转）。是 → 改成权威读取；只是展示/日志 → 才可保留默认。
|
||||
|
||||
---
|
||||
|
||||
## 5. 模块职责边界
|
||||
|
||||
- **一个职能只在一个模块实现**，其他模块**只调用、不重造**。
|
||||
- 需要某能力时，调用对应**权威模块**；权威能力不满足，应在权威模块内扩展，而非在调用方旁路重写。
|
||||
- **禁止**：在 A 模块内联 B 模块核心算法的"简化版"；同一职能在两处各有一份实现并行演化。
|
||||
- 后果：交叉实现产生双份并行逻辑，必随规则演化分叉、互相矛盾——这是数据权威原则在"代码职责"维度的同一条红线。
|
||||
|
||||
### "自动操作"模块只做决策，不重造规则
|
||||
|
||||
服务端自动替玩家操作的模块（如 AI 托管）**只负责决策**（出哪张、是否碰/杠/吃/胡/过），**核心算法一律复用权威实现**：胡牌检测、听牌/做牌分析、合法操作枚举、牌型判定等都已在权威模块实现，决策模块只能**读取/调用其结果**，禁止自行重算。
|
||||
|
||||
- 判别：回答"能否胡/听什么/有哪些合法操作"——属核心算法，必须复用；回答"在合法选项中选哪个更好"——才属决策。
|
||||
|
||||
---
|
||||
|
||||
## 6. 房间隔离
|
||||
|
||||
服务端同进程并发多张牌桌（多个 `o_room`）。**任何随对局变化的状态都必须以房间为单位隔离**：
|
||||
|
||||
- **状态挂房间**：对局数据存 `o_room.o_desk.data.*`，由 `o_room` 携带。**禁止存在模块级单例 / 全局变量 / 静态字段**。
|
||||
- **不得只用 `seat` 作 key**：座位号仅 0–3，多房并发必碰撞。缓存、定时器表、决策状态、计数器等**必须用 `房间 + seat` 复合维度**（或每房一份实例）。
|
||||
- **定时器随房生命周期**：所有 `setTimeout`/`setInterval` 必须能按房间定位与清理；小局结束、解散房间、开新局时，**清理该房名下全部定时器与残留状态**，禁止泄漏到下一局或别房。
|
||||
- 覆盖范围：自动托管/决策表、算法中间态缓存（听牌/胡牌检测）、超时与回合定时器、待响应队列等，任一项跨房共享都会导致 A 房误改 B 房。
|
||||
|
||||
> 一句话：一切随对局变化的东西都属于某个房间，必须能用 `o_room` 唯一定位、隔离与回收。
|
||||
|
||||
---
|
||||
|
||||
## 7. 服务端自动操作复用真人链路
|
||||
|
||||
服务端代替玩家执行的操作（AI 托管等）：
|
||||
|
||||
- **必须复用真人手动操作的同一套数据包链路**：走与真人相同的服务端处理入口与广播下发路径，产生的包结构与真人**完全一致**。
|
||||
- **对前端透明**：前端只按既有"玩家操作"逻辑解析表现，**禁止为"自动操作"单开一套接收/解析/表现分支**，无需区分触发源。
|
||||
- **唯一区别在触发源**：由"前端请求"变为"服务端决策"，其后数据组织、下发协议、广播路径不变。
|
||||
|
||||
---
|
||||
|
||||
## 8. Shared 文件同步流程
|
||||
|
||||
### `shared/` 是什么：子游戏自己的游戏逻辑，与平台无关
|
||||
|
||||
- **`shared/` 属于子游戏，不是平台代码**：它存放**本玩法自身**的规则、算法、常量、数据结构（本项目如胡牌检测 `WinDetectionFactory`、精牌 `JingAlgorithm`、计分 `ScoreCalculation`、牌型/比精，以及 `constants/` 下各类常量）。平台**既不提供也不感知** `shared/`——它完全落在子游戏可编辑范围内，是你玩法逻辑的一部分。
|
||||
- **为什么要"共享"**：**同一份玩法逻辑需要在两处运行**——服务端(Node)做**权威裁定**，前端(浏览器)做**即时表现/预校验**。若两端各写一份，必随规则演化而分叉、算出不一致结果。因此把这类"前后端必须完全一致"的纯逻辑收进 `shared/`，两端跑**逐字相同**的代码。
|
||||
- **它与"数据权威"的关系**：`shared/` 是**逻辑同源**（两端同一套算法），不改变**数据权威**（结果仍以服务端为准，见 §4）；前端算出的只是表现/预判，最终以服务端 `shared/` 算的为准。
|
||||
|
||||
### 同步流程：服务端权威源 → 前端只读副本
|
||||
|
||||
前后端各持一份 `shared/`，**必须**经同步流程单向更新，禁止直接编辑前端副本：
|
||||
|
||||
| 角色 | 路径 |
|
||||
|------|------|
|
||||
| 权威源（服务端，唯一可改） | `server/<游戏容器目录>/<你的游戏>/shared/` |
|
||||
| 前端副本（只读，脚本生成） | `client/js/01_SubGame/codes/shared/` |
|
||||
|
||||
1. **只改服务端** `shared/` 下文件。
|
||||
2. 改完运行根目录的同步脚本（如 `sync-shared.ps1`）同步到前端。
|
||||
3. **禁止直接编辑前端 `codes/shared/`**（同步脚本会覆盖）。
|
||||
|
||||
> 判别一段逻辑该不该进 `shared/`：**它是不是"前后端必须算出完全相同结果"的玩法逻辑**？是（胡牌/听牌/比精/牌型/计分/规则常量）→ 放 `shared/`；只是服务端流程编排或只是前端表现 → 各自放自己那侧，不进 `shared/`。
|
||||
|
||||
---
|
||||
|
||||
## 9. 硬编码常量准则
|
||||
|
||||
**需提取为常量**（满足任一）：会随规则变化、跨模块复用、裸值无法自解释。典型：分数数值、状态/类型字符串标识、配置阈值、跨模块共享的 key 名。常量按语义归入 `shared/constants/` 下对应文件（分数类、规则配置类、类型枚举类）。
|
||||
|
||||
**不必提取**（避免过度设计）：单函数内一次性临时值（循环初值 `0`、空数组 `[]`）、框架约定固定串（`require` 路径）、自解释布尔开关、纯展示标点文字。
|
||||
|
||||
---
|
||||
|
||||
## 10. 测试纪律
|
||||
|
||||
- **测试唯一目的是验证业务正确性**。失败是有价值的信号，第一反应是**定位根因**，不是"让测试变绿"。
|
||||
- **禁止任何掩盖手段**：skip/条件 return、软化断言、放宽阈值、try-catch 吞异常、把硬断言改成"存在才校验"。
|
||||
- **每个失败必须裁定归属**（基于证据）：【业务代码缺陷】还是【测试脚本缺陷】，二选一。手段：临时诊断探针、打印中间态、最小复现；拿证据再下结论，**禁止凭猜测定性**（诊断日志定位后清理）。
|
||||
- **按归属修复**：业务缺陷 → 修业务、单独提交、写明根因；脚本缺陷 → 修置场/时序，断言保持硬断言。优先级：**确定性构造场景 > 有界重试采样 > 条件跳过**。
|
||||
- **flaky 同样是缺陷**：要么业务竞态、要么测试非确定性置场，须根治；验收标准是**连跑 ≥5 次全绿**。
|
||||
|
||||
### 测试不绑架正式代码
|
||||
|
||||
- **正式核心代码禁止存在专为测试服务的逻辑**，更禁止为"让测试通过/兼容测试"而新增或修改正式代码。
|
||||
- 方向永远是**测试适配正式代码的生产契约**，而非正式代码迁就测试的简化输入/不规范 stub。测试要构造符合生产契约的输入与 stub。
|
||||
- 违例信号：正式代码注释出现"仅兼容测试 stub""如单元测试传 X"之类，即是违例。
|
||||
|
||||
---
|
||||
|
||||
## 11. Git 提交规范
|
||||
|
||||
- **及时自动提交**：每完成一个可独立成立的逻辑改动（一个修复/功能/重构/一批测试）就**立即提交**，不堆积工作区。
|
||||
- **无需逐次询问**：完成阶段性改动后主动提交（`push` 按需）。
|
||||
- **提交信息用中文**，简明说明"做了什么/为什么"，一次提交聚焦一件事，结尾保留 `Co-Authored-By` 署名行。
|
||||
|
||||
---
|
||||
|
||||
## 12. 审查速查表
|
||||
|
||||
| 维度 | 红线 |
|
||||
|------|------|
|
||||
| 范围 | 只改子游戏目录 `<容器目录>/<游戏>/` 与允许的前端范围 |
|
||||
| 语言 | 纯 ES5；`require` 仅在顶部守卫块 |
|
||||
| 成败 | 只认 `data.success`，推送必自带，禁 `status` 兜底 |
|
||||
| 数据 | 权威唯一、缺失报错/返回 null、禁兜底、下游不修补 |
|
||||
| 职责 | 一职能一模块，调用不重造 |
|
||||
| 隔离 | 状态挂 `o_desk.data.*`，禁全局；`房间+seat` 作 key；定时器随房清理 |
|
||||
| 自动操作 | 复用真人链路，对前端透明 |
|
||||
| Shared | 只改服务端 `shared/`，跑同步脚本 |
|
||||
| 测试 | 失败裁定归属、禁掩盖；正式代码不迁就测试 |
|
||||
| Git | 一事一提交、中文信息、及时提交 |
|
||||
|
||||
---
|
||||
|
||||
至此，从框架运作（01）、子游戏接入（02）、收发协议（03）到工程红线（04），构成一套完整的服务端子游戏开发指导。回到 [README](./README.md) 查看导航与一页纸模型。
|
||||
</content>
|
||||
@@ -0,0 +1,98 @@
|
||||
# 服务端 · 子游戏开发指导文档
|
||||
|
||||
> 本套文档是**友乐游戏平台**下「子游戏服务端」开发的通用指导与规范。
|
||||
> 它讲清楚三件事：**框架怎么运作**、**子游戏怎么接进去**、**开发时必须守哪些规矩**。
|
||||
>
|
||||
> 文中以「麻将」一类房卡棋牌作举例，但所有结论都是**框架通用**的，不绑定任何具体玩法。
|
||||
> 新开发者按本套文档即可理解运作流程、动手接入并写出符合规范的子游戏。
|
||||
|
||||
---
|
||||
|
||||
## 这套文档写给谁
|
||||
|
||||
- **新接手子游戏服务端的开发者**：先读完 01、02 建立全局认知，再按 03、04 动手。
|
||||
- **正在开发/维护某个子游戏的开发者**：03、04 是日常红线，改任何东西前回查。
|
||||
- **做代码审查的人**：04 是审查清单的来源。
|
||||
|
||||
## 阅读顺序
|
||||
|
||||
| 篇 | 文档 | 解决什么问题 |
|
||||
|----|------|--------------|
|
||||
| 00 | 本文 README | 这套文档是什么、怎么读、红线速查 |
|
||||
| 01 | [01-服务端环境与框架基础.md](./01-服务端环境与框架基础.md) | 平台与子游戏的关系、核心对象模型、三层路由、房间生命周期 |
|
||||
| 02 | [02-子游戏接入与开发流程.md](./02-子游戏接入与开发流程.md) | 三文件架构、export/import 接口、makewar/重连、一次操作的完整数据流 |
|
||||
| 03 | [03-数据收发与通信协议.md](./03-数据收发与通信协议.md) | 包结构、收发包方式、主动推送、成败标志协议、前后端对接点 |
|
||||
| 04 | [04-开发规范与红线.md](./04-开发规范与红线.md) | 可编辑范围、ES5/require、数据权威、模块职责、房间隔离、测试纪律 |
|
||||
|
||||
建议第一次**从 01 顺序读到 04**；之后把 03/04 当手册随用随查。
|
||||
|
||||
---
|
||||
|
||||
## 一页纸：核心运作模型
|
||||
|
||||
```
|
||||
客户端数据包 { app, route, rpc, data }
|
||||
│
|
||||
▼
|
||||
packet_face.ReceivePack 按 pack.app 找到「应用」
|
||||
│
|
||||
▼
|
||||
app.ReceivePack 按 pack.route 找到「模块」(子游戏)
|
||||
│
|
||||
▼
|
||||
mod.DoPack 按 pack.rpc 调到「方法」 mod[rpc](pack)
|
||||
│
|
||||
▼
|
||||
子游戏 RPC handler 校验玩家 → 取对局状态 → 执行业务 → 主动推送
|
||||
│
|
||||
▼
|
||||
o_room.method.sendpack_toseat 按座位取连接信息(conmode/fromid) → 下发客户端
|
||||
```
|
||||
|
||||
- **平台框架**负责：网络收发、应用/模块/房间/玩家对象、路由、房卡、战绩、房间生命周期。
|
||||
- **子游戏**负责：玩法规则、对局状态、每个操作的处理与广播。两者通过 **export / import** 两组接口对接。
|
||||
|
||||
> 上图是**入站半程**（前端 → 服务端 handler）。完整的往返链路（含服务端 `sendpack_toseat` 推回 → 前端 `Game_Modify._ReceiveData` 按 `rpc` 分发）见 [03 §6「端到端收发全链路」](./03-数据收发与通信协议.md#6-端到端收发全链路前后端对照)，前端侧细节见 [`client/docs/development-guide/04`](../../../client/docs/development-guide/04-网络对接与启动编排.md)。
|
||||
|
||||
---
|
||||
|
||||
## 命名约定：哪些是框架契约，哪些只是示例
|
||||
|
||||
本套文档的代码示例里出现的**具体名字，绝大多数是举例，并非强制标准**。请区分两类：
|
||||
|
||||
- **框架契约（必须照用）**——由平台代码决定，改了就对接不上：
|
||||
- 数据包四字段 `{ app, route, rpc, data }`，其中 `app` 固定为 `"youle"`；
|
||||
- 平台真实回调的 export 钩子名、你调用的 import 接口名（如 `makewar`、`get_deskinfo`、`check_player`、`deduct_roomcard`、`save_grade`）；
|
||||
- 成败字段 `data.success`；
|
||||
- 平台 API 名（`cls_mod.new`、`min_loadJsFile`、`o_room.method.sendpack_toseat` / `sendpack_toother` 等）。
|
||||
- **示例命名（可自定）**——本项目的举例，你的子游戏可按自己的风格命名：
|
||||
- 业务 `rpc` 名（如 `playCard`、`declareHu`，只需**前后端约定一致**即可）；
|
||||
- handler / 类 / 文件 / 变量 / 分层目录名（如 `RpcHandler.handlePlayCard`、`OperationManager`、`ResponseBuilder`、`BroadcastManager`、`RoomAdapter`、`GameController`、`game/`、`rpc/`、`rules/` 等）。
|
||||
|
||||
> 一句话：**平台接缝上的名字是契约、要照用；接缝之内你自己代码里的名字都是示例、可自定。** 后续 01–04 的代码块同样遵循这条约定，不再逐处重复声明。
|
||||
|
||||
---
|
||||
|
||||
## 红线速查（详见 04）
|
||||
|
||||
> 以下每一条都有过真实事故或返工，**改代码前先对照**。
|
||||
|
||||
- **可编辑范围**：服务端只能改子游戏目录 `server/<游戏容器目录>/<你的游戏>/`（容器目录名由接入方自定，**非框架强制**，换任何不与框架冲突的目录皆可），`server/` 其余皆平台代码，禁改。接入新游戏还需在 `server/youle/app.js` 里加一行 `min_loadJsFile` 加载其 `mod.js`（唯一必须触碰的平台文件，属游戏注册接入点）。
|
||||
- **双运行时**：代码同时跑在 Node 与浏览器/友乐平台。必须严格 **ES5**；`require` 只能写在文件开头 `if (typeof require !== 'undefined') {}` 守卫块内，**禁止函数体内/中途 require**。
|
||||
- **成败标志唯一是 `data.success`**：前端只认 `if (!data.success)`；**主动推送的 `data` 必须自带 `success`**（mod 的 `return` 值不可靠下发前端）；禁止用 `status`/`code` 判成败、禁止 `status` 兼容兜底。
|
||||
- **数据权威**：同一业务数据只有一个权威来源，下游只读不重算；权威字段缺失要**显式报错/返回 null**，禁止 `|| 0`、`|| []`、`|| ''` 兜底掩盖。
|
||||
- **模块职责边界**：一个职能只在一个模块实现，其他模块**调用而非重造**。
|
||||
- **房间隔离**：一切随对局变化的状态都挂 `o_room.o_desk.data.*`；**禁止模块级单例/全局变量存对局态**；缓存/定时器/决策表不得只用 `seat` 作 key，必须 `房间 + seat`；结束/解散/开新局时按房间清理全部定时器与残留状态。
|
||||
- **服务端自动操作复用真人链路**：服务端代替玩家做的操作（如 AI 托管）必须复用「真人操作」的同一套处理入口与广播链路，对前端透明，不为它单开一套下发分支。
|
||||
- **服务器权威**：房卡、胜负、积分、状态等关键数据与操作一律以服务器为准，前端数据仅供显示。
|
||||
- **测试纪律**：测试失败先用证据裁定「业务缺陷 vs 测试脚本缺陷」，禁止 skip/软化断言/吞异常掩盖；**正式代码不得为兼容测试而加逻辑**。
|
||||
|
||||
---
|
||||
|
||||
## 与既有文档的关系
|
||||
|
||||
- 平台级、面向「所有子游戏」的总纲在 `docs/important/server/`（友乐框架收发包规范、子游戏开发要求）。
|
||||
- 本套文档是其**落地版**：结合本仓库真实代码，给出可直接照做的接入步骤与红线，并对其中已被本项目实践修正的部分（如成败标志由 `status` 收敛为 `success`）以本套为准。
|
||||
- 各子游戏内部的架构细节（模块划分、算法）仍以各自 `<游戏容器目录>/<游戏>/docs/` 为准。
|
||||
</content>
|
||||
</invoke>
|
||||
Reference in New Issue
Block a user