mirror of
https://gitee.com/dgflash/oops-plugin-framework.git
synced 2026-06-23 19:22:47 +08:00
ecs 命名空间:统一导出所有 API,业务只需 import { ecs } from './ECS'
核心类型别名:ecs.Entity / ecs.Comp / ecs.RootSystem / ecs.ComblockSystem
接口再导出:ecs.IComp / ecs.IMatcher / ecs.IEntityEnterSystem / ecs.IEntityRemoveSystem / ecs.ISystemFirstUpdate / ecs.ISystemUpdate
实体工厂:ecs.getEntity(ctor, world?) — 创建或从对象池获取实体
动态查询:ecs.query(matcher, world?) — 按匹配器查询实体
过滤器工厂:ecs.allOf() / ecs.anyOf() / ecs.onlyOf() / ecs.excludeOf() — 组合匹配规则
单例组件:ecs.getSingleton() / ecs.addSingleton() — 全局唯一组件访问
子模块门面:ecs.world / ecs.pool / ecs.system / ecs.storage / ecs.network / ecs.serialize / ecs.entityRef
2. 驱动器 — ECSDriver.ts
封装默认世界的 init / execute / destroy 生命周期
add(system) — 向默认世界添加业务系统
init() — 初始化 ECS(并入 @ecs.register 注册的系统、拓扑排序、init)
execute(dt) — 驱动默认世界一帧
destroy() — 清理所有子系统
3. 实体 — ECSEntity.ts
组件容器:位掩码 mask + 按 tid 索引的密集数组,get/has 为 O(1)
双重重载 add():
add(组件类) — 从对象池取实例或恢复软移除缓存
add(组件实例) — 挂载外部实例(如 cc.Component),设 canRecycle=false
remove(ctor, isRecycle?):
isRecycle=true(默认):reset + 回池/释放 SoA 槽位
isRecycle=false:软移除,数据暂存 compTid2Obj,下次 add 同 tid 恢复
父子层级:addChild / removeChild,带循环引用检测
destroy():断开父子 → 移除全部组件 → 清理软移除缓存 → 回收实体 + 释放 eid
forEachComponent(cb):遍历当前挂载的所有组件
4. 组件 — ECSComp.ts
抽象基类,子类须实现 reset() 方法
canRecycle — 是否可回收(外部创建的组件设 false)
ent — 拥有该组件的实体引用
变更检测:markDirty() / isChangedSince(sinceEpoch) / lastWriteEpoch — 基于 epoch 的帧级脏标记
5. 位掩码 — ECSMask.ts
基于 Uint32Array 的位运算,支持 set / has / delete / and / or / bitCount
对象池复用,clearPool() 清理
6. 注册系统 — ECSRegister.ts + ECSTypeRegistry.ts
@ecs.register('Name') 类装饰器:自动识别注册类型
组件:分配 tid,写入 compCtors 表
实体:记录 ctor → name 映射
系统:注册到全局表或指定世界
ECSTypeRegistry:全局类型注册表(跨世界共享),记录组件/实体/系统元数据
7. 查询 — ECSMatcher.ts + ECSGroup.ts
四种规则:AllOf / AnyOf / OnlyOf / ExcludeOf,规则间为"与"关系
flyweight 缓存:相同组合共享同一 Matcher 实例
小规则优化:tid 数 ≤ 4 时直接 mask.has,否则分配 ECSMask
ECSGroup:SparseSet 实现,O(1) 增删(swap-pop),稳定快照遍历
进入/离开追踪:watchEntityEnterAndRemove 供系统帧内查询变化
8. 系统 — ECSComblockSystem.ts + ECSRootSystem.ts
ComblockSystem:业务系统基类
生命周期:init → entityEnter → firstUpdate → update → entityRemove → onDestroy
filter() — 声明实体匹配规则
interval — 执行间隔(0=每帧,>0=固定间隔)
被动系统:isPassiveSystem() 返回 true 时不参与每帧 update
构造时探测子类钩子,选定 execute 变体(零开销分支)
RootSystem:根系统,一世界一个
init() — 并入 @ecs.register 系统 + 拓扑排序 + 绑定世界 + init
execute(dt) — 切换当前世界 → 递增 epoch → tick 各系统 → flush 命令缓冲
9. 系统调度 — SystemScheduler.ts
声明式执行顺序:@ecs.system.executeBefore / @ecs.system.executeAfter / @ecs.system.inSet
拓扑排序(Kahn 算法):无约束系统保持原始顺序,循环依赖抛 CycleDependencyError
集合机制:inSet('名') 把系统加入虚拟分组,其他系统用 executeAfter('set:名') 批量依赖
10. 世界 — ECSWorld.ts + ECSWorldManager.ts
ECSWorld:运行期数据容器
entities — 活动实体表(eid → 实体)
groups — 响应式查询分组
singletons — 单例组件表
refs — @entityRef 引用追踪
commands — 延迟结构变更命令队列
epoch — 世代号(每帧递增,变更检测用)
getEntity(ctor) — 创建/从池获取实体
assignEid(entity, eid) — 反序列化时保持 eid 一致
ECSWorldManager(ecs.world):多世界管理
get(name?) / default() / current — 获取/切换世界
use(world) — 切换当前世界,返回切换前的世界
inWorld(world, fn) — 在指定世界中执行,自动还原
createSystems(world, ...ctors) — 批量装配系统并 init
defer(fn) / flushCommands() — 延迟结构变更
11. 命令缓冲 — ECSCommandBuffer.ts
延迟结构变更队列,帧末由 RootSystem.execute 统一 flush
push(fn) 入队,flush() 先快照再执行(避免本帧新入队命令在本帧执行)
12. 对象池 — ECSPoolManager.ts + ECSDynamicPool.ts
ecs.pool:统一管理实体/组件动态对象池
getPool(name, factory) — 获取或创建池
clearAll() / clearPools() — 清空池缓存(不触碰存活数据)
getAllMetrics() — 获取各池统计信息(命中/未命中/缓存/创建数)
13. 实体引用 — ECSEntityRef.ts + ECSReferenceTracker.ts
@ecs.entityRef() 属性装饰器:标记组件属性为实体引用
目标实体销毁时自动置 null,避免悬空引用
组件回收时 clearComponentEntityRefs 清理所有引用
14. SoA 列存储 — StorageSoA.ts + StorageDecorators.ts
@ecs.storage.enableSoA 类装饰器:为组件启用 SoA 列存储(默认 AoS,opt-in)
字段装饰器:float64 / float32 / int32 / uint32 / int16 / uint16 / int8 / uint8
数值字段按列存入 TypedArray,按 eid 分配槽位
acquire 返回 Proxy 视图:SoA 字段读写直接落到 TypedArray,非 SoA 字段走后备实例
槽位超出容量时 2 倍扩容,释放时入空闲栈
自注册机制:模块加载时注册到核心,删除 storage/ 目录后基础 ECS 仍可运行
15. 网络同步 — NetworkSync.ts + SyncDecorators.ts + SyncCodec.ts + ByteBuffer.ts
@ecs.network.sync(类型) 字段装饰器:标记组件字段参与网络同步
ecs.network.net 门面:
encodeWorld(op?) — 编码当前世界为紧凑二进制(Full 全量 / Delta 增量)
applyToWorld(bytes, onMissing?) — 将二进制同步数据应用到世界
track(entity, markAll?) — 为实体初始化变更追踪器
clearDirty() — 清除所有脏标记
SyncCodec:实体/组件级编解码器
ByteWriter / ByteReader:二进制读写缓冲(变长整数等)
ChangeTracker:字段级脏标记追踪
16. 序列化 — Serialization.ts + Incremental.ts
@ecs.serialize() 字段装饰器:标记组件需要持久化的字段
全量序列化:
ecs.serialize.serializeWorld(pretty?) — 序列化当前世界为 JSON
ecs.serialize.deserializeWorld(json) — 从 JSON 反序列化到当前世界
增量序列化:
ecs.serialize.snapshot() — 对当前世界拍快照(基线)
ecs.serialize.computeDelta(base) — 计算相对基线的增量(added / removed / changed)
ecs.serialize.applyDelta(delta) — 将增量应用到当前世界
保留实体层级(parentEid),两阶段重建(先建实体+组件,再重建父子)
17. 监控日志 — ECSMonitorLogger.ts
零入侵监控模块,通过控制台命令触发
注册全局命令:
ecsLog() — 打印所有监控表格
ecsWorldSummary() — 各世界实体/系统/组件缓存统计
ecsSummary() — 总体统计(所有世界合计)
ecsEntityPools() — 实体池明细(命中/未命中/缓存)
ecsCompPools() — 组件池明细(按 M/B/V/VC 分类排序)
ecsEntityCaches() — 实体软移除组件缓存明细
ecsHelp() — 显示帮助信息
150 lines
5.9 KiB
TypeScript
150 lines
5.9 KiB
TypeScript
import { ByteWriter, ByteReader } from './ByteBuffer';
|
||
import { SyncType, SyncOp, SyncField } from './SyncTypes';
|
||
import { getSyncFields, getTracker, ensureTracker } from './SyncDecorators';
|
||
import { registry } from '../registry/ECSTypeRegistry';
|
||
import { ecsWorldManager } from '../world/ECSWorldManager';
|
||
import type { ecs } from '../ECS';
|
||
import type { ECSEntity } from '../entity/ECSEntity';
|
||
import type { CompCtor } from '../registry/ECSTypes';
|
||
|
||
/** 按 SyncType 将值写入字节流 */
|
||
function writeValue(w: ByteWriter, type: SyncType, value: unknown): void {
|
||
switch (type) {
|
||
case SyncType.Bool: w.writeUint8(value ? 1 : 0); break;
|
||
case SyncType.Int8: w.writeInt8((value as number) | 0); break;
|
||
case SyncType.Uint8: w.writeUint8((value as number) & 0xff); break;
|
||
case SyncType.Int16: w.writeInt16((value as number) | 0); break;
|
||
case SyncType.Uint16: w.writeUint16((value as number) & 0xffff); break;
|
||
case SyncType.Int32: w.writeInt32((value as number) | 0); break;
|
||
case SyncType.Uint32: w.writeUint32((value as number) >>> 0); break;
|
||
case SyncType.Float32: w.writeFloat32(value as number); break;
|
||
case SyncType.Float64: w.writeFloat64(value as number); break;
|
||
case SyncType.String: w.writeString((value as string) ?? ''); break;
|
||
}
|
||
}
|
||
|
||
/** 按 SyncType 从字节流读取值 */
|
||
function readValue(r: ByteReader, type: SyncType): unknown {
|
||
switch (type) {
|
||
case SyncType.Bool: return r.readUint8() !== 0;
|
||
case SyncType.Int8: return r.readInt8();
|
||
case SyncType.Uint8: return r.readUint8();
|
||
case SyncType.Int16: return r.readInt16();
|
||
case SyncType.Uint16: return r.readUint16();
|
||
case SyncType.Int32: return r.readInt32();
|
||
case SyncType.Uint32: return r.readUint32();
|
||
case SyncType.Float32: return r.readFloat32();
|
||
case SyncType.Float64: return r.readFloat64();
|
||
case SyncType.String: return r.readString();
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 同步编解码:组件 / 实体 层级的二进制(反)序列化。
|
||
*
|
||
* 编码格式(小端):
|
||
* 组件: [字段数 varint] { [字段索引 varint][值] }*
|
||
* 实体: [eid varint][组件数 varint] { [tid varint][组件数据] }*
|
||
*/
|
||
export class SyncCodec {
|
||
/** 编码单个组件(Full=全部字段,Delta=脏字段) */
|
||
static encodeComponent(w: ByteWriter, comp: ecs.IComp, op: SyncOp): void {
|
||
const ctor = comp.constructor as CompCtor<ecs.IComp>;
|
||
const fields = getSyncFields(ctor)!;
|
||
const anyComp = comp as unknown as Record<string, unknown>;
|
||
|
||
let indices: number[];
|
||
if (op === SyncOp.Delta) {
|
||
const tracker = getTracker(comp);
|
||
indices = tracker ? tracker.collect() : [];
|
||
}
|
||
else {
|
||
indices = fields.map((f) => f.index);
|
||
}
|
||
|
||
w.writeVarUint(indices.length);
|
||
for (const idx of indices) {
|
||
const field = fields[idx];
|
||
w.writeVarUint(idx);
|
||
writeValue(w, field.type, anyComp[field.name]);
|
||
}
|
||
}
|
||
|
||
/** 解码组件数据到实例(应用后清除脏标记,避免回声) */
|
||
static decodeComponentInto(r: ByteReader, comp: ecs.IComp): void {
|
||
const ctor = comp.constructor as CompCtor<ecs.IComp>;
|
||
const fields = getSyncFields(ctor)!;
|
||
const anyComp = comp as unknown as Record<string, unknown>;
|
||
|
||
const count = r.readVarUint();
|
||
for (let i = 0; i < count; i++) {
|
||
const idx = r.readVarUint();
|
||
const field: SyncField = fields[idx];
|
||
anyComp[field.name] = readValue(r, field.type);
|
||
}
|
||
const tracker = getTracker(comp);
|
||
if (tracker) tracker.clear();
|
||
}
|
||
|
||
/** 增量模式下判断组件是否有脏字段需要发送 */
|
||
private static shouldSend(comp: ecs.IComp, op: SyncOp): boolean {
|
||
if (op !== SyncOp.Delta) return true;
|
||
const tracker = getTracker(comp);
|
||
return !!tracker && tracker.hasChanges;
|
||
}
|
||
|
||
/** 编码实体的可同步组件;无可发送组件时返回 false */
|
||
static encodeEntity(w: ByteWriter, entity: ECSEntity, op: SyncOp): boolean {
|
||
const toSend: ecs.IComp[] = [];
|
||
entity.forEachComponent((comp) => {
|
||
const ctor = comp.constructor as CompCtor<ecs.IComp>;
|
||
const fields = getSyncFields(ctor);
|
||
if (fields && fields.length > 0 && SyncCodec.shouldSend(comp, op)) {
|
||
toSend.push(comp);
|
||
}
|
||
});
|
||
if (toSend.length === 0) return false;
|
||
|
||
w.writeVarUint(entity.eid);
|
||
w.writeVarUint(toSend.length);
|
||
for (const comp of toSend) {
|
||
w.writeVarUint((comp.constructor as CompCtor<ecs.IComp>).tid);
|
||
SyncCodec.encodeComponent(w, comp, op);
|
||
}
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* 解码实体数据并应用到相同 eid 的实体。
|
||
* 若该 eid 不存在,回调 onMissing 让调用方决定是否 spawn。
|
||
*/
|
||
static decodeEntityInto(
|
||
r: ByteReader,
|
||
onMissing?: (eid: number) => ECSEntity | undefined
|
||
): void {
|
||
const eid = r.readVarUint();
|
||
const compCount = r.readVarUint();
|
||
let entity = ecsWorldManager.current.entities.get(eid);
|
||
if (!entity && onMissing) entity = onMissing(eid);
|
||
|
||
for (let i = 0; i < compCount; i++) {
|
||
const tid = r.readVarUint();
|
||
const ctor = registry.compCtors[tid];
|
||
if (!ctor) {
|
||
console.warn(`[ECS] 同步解码遇到未注册 tid=${tid},终止本实体解析`);
|
||
return;
|
||
}
|
||
if (entity) {
|
||
let comp = entity.get(ctor) as ecs.IComp | undefined;
|
||
if (!comp) comp = entity.add(ctor) as ecs.IComp;
|
||
ensureTracker(comp);
|
||
SyncCodec.decodeComponentInto(r, comp);
|
||
}
|
||
else {
|
||
const dummy = new (ctor as unknown as { new (): ecs.IComp })();
|
||
SyncCodec.decodeComponentInto(r, dummy);
|
||
}
|
||
}
|
||
}
|
||
}
|