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() — 显示帮助信息
159 lines
5.1 KiB
TypeScript
159 lines
5.1 KiB
TypeScript
/**
|
||
* 池管理器
|
||
*/
|
||
|
||
import { ECSMask } from '../component/ECSMask';
|
||
import { ECSDynamicPool } from './ECSDynamicPool';
|
||
import type { IECSPoolMetrics } from './IECSPoolMetrics';
|
||
import type { ECSEntity } from '../entity/ECSEntity';
|
||
import type { ecs } from '../ECS';
|
||
import { type CompCtor, type EntityCtor } from '../registry/ECSTypes';
|
||
import { registry } from '../registry/ECSTypeRegistry';
|
||
|
||
/** 池对象类型 - 实体或组件 */
|
||
type ECSPoolObject = ECSEntity | ecs.IComp;
|
||
|
||
/** 池类型名称 - 实体名或组件名 */
|
||
type ECSPoolTypeName = string;
|
||
|
||
/**
|
||
* 池管理器 —— 统一管理实体 / 组件动态对象池,并作为 `ecs.pool` 对外暴露。
|
||
*/
|
||
export class ECSPoolManager {
|
||
/** 所有对象池的映射 */
|
||
private pools: Map<ECSPoolTypeName, ECSDynamicPool<ECSPoolObject>> = new Map();
|
||
|
||
/**
|
||
* 从构造函数获取池类型名称
|
||
* @param ctor 实体或组件的构造函数
|
||
* @returns 池类型名称
|
||
*/
|
||
private getTypeNameFromCtor<T extends ECSEntity>(ctor: EntityCtor<T>): string {
|
||
// 检查是否是组件构造函数(有 compName 属性)
|
||
const ctorAny = ctor as unknown as { compName?: string };
|
||
if (typeof ctorAny.compName === 'string') {
|
||
return ctorAny.compName;
|
||
}
|
||
|
||
// 检查是否是实体构造函数(从 registry.entityCtors 查找)
|
||
const entityName = registry.entityCtors.get(ctor as EntityCtor<ECSEntity>);
|
||
if (entityName) {
|
||
return entityName;
|
||
}
|
||
|
||
// 如果都找不到,使用构造函数名
|
||
return ctor.name;
|
||
}
|
||
|
||
/**
|
||
* 获取或创建池
|
||
* @param typeName 池类型名称(实体名如 "Account"、"RedDot",或组件名如 "M_Equip_Model")
|
||
* @param factory 对象工厂函数
|
||
* @returns 动态对象池实例
|
||
*/
|
||
getPool<T extends ECSPoolObject>(typeName: ECSPoolTypeName, factory: () => T): ECSDynamicPool<T> {
|
||
if (!this.pools.has(typeName)) {
|
||
const pool = new ECSDynamicPool<ECSPoolObject>(factory);
|
||
this.pools.set(typeName, pool);
|
||
}
|
||
|
||
return this.pools.get(typeName)! as ECSDynamicPool<T>;
|
||
}
|
||
|
||
/**
|
||
* 删除指定池(清空对象并从管理中移除)
|
||
* @param typeNameOrCtor 池类型名称(实体名或组件名)或构造函数
|
||
* @returns 是否成功删除
|
||
*/
|
||
removePool(typeNameOrCtor: ECSPoolTypeName | EntityCtor<ECSEntity> | CompCtor<ecs.IComp>): boolean {
|
||
let typeName: string;
|
||
|
||
if (typeof typeNameOrCtor === 'string') {
|
||
typeName = typeNameOrCtor;
|
||
}
|
||
else {
|
||
typeName = this.getTypeNameFromCtor(typeNameOrCtor as EntityCtor<ECSEntity>);
|
||
}
|
||
|
||
const pool = this.pools.get(typeName);
|
||
if (pool) {
|
||
pool.clear();
|
||
this.pools.delete(typeName);
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* 清空所有池
|
||
*/
|
||
clearAll(): void {
|
||
this.pools.forEach(pool => pool.clear());
|
||
this.pools.clear();
|
||
}
|
||
|
||
/**
|
||
* 清理所有对象池缓存 —— 仅释放「已回收待复用」的空闲对象,不触碰存活数据。
|
||
*
|
||
* 清理范围:Mask 位掩码池 + 实体 / 组件动态对象池。
|
||
* 不清理 SoA 列存储;整体重置请用 `ecs.world.clear()`。
|
||
*/
|
||
clearPools(): void {
|
||
ECSMask.clearPool();
|
||
this.clearAll();
|
||
}
|
||
|
||
/**
|
||
* 获取所有池的统计信息
|
||
* @returns 类型名称到统计指标的映射
|
||
*/
|
||
getAllMetrics(): Map<ECSPoolTypeName, IECSPoolMetrics> {
|
||
const result = new Map<ECSPoolTypeName, IECSPoolMetrics>();
|
||
this.pools.forEach((pool, typeName) => {
|
||
result.set(typeName, pool.getMetrics());
|
||
});
|
||
return result;
|
||
}
|
||
|
||
/**
|
||
* 获取指定类型的池
|
||
* @param typeName 池类型名称(实体名或组件名)
|
||
* @returns 池实例,如果不存在则返回undefined
|
||
*/
|
||
getPoolByName<T extends ECSPoolObject>(typeName: ECSPoolTypeName): ECSDynamicPool<T> | undefined {
|
||
return this.pools.get(typeName) as ECSDynamicPool<T> | undefined;
|
||
}
|
||
|
||
/**
|
||
* 获取所有池的名称
|
||
* @returns 池名称数组(实体名或组件名数组)
|
||
*/
|
||
getPoolNames(): ECSPoolTypeName[] {
|
||
return Array.from(this.pools.keys());
|
||
}
|
||
|
||
/**
|
||
* 清空指定池中的对象
|
||
* @param typeName 池类型名称(实体名或组件名)
|
||
*/
|
||
clearPool(typeName: ECSPoolTypeName): void {
|
||
const pool = this.pools.get(typeName);
|
||
if (pool) {
|
||
pool.clear();
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 获取指定池的统计信息
|
||
* @param typeName 池类型名称(实体名或组件名)
|
||
* @returns 统计指标对象,如果池不存在则返回undefined
|
||
*/
|
||
getPoolMetrics(typeName: ECSPoolTypeName): IECSPoolMetrics | undefined {
|
||
const pool = this.pools.get(typeName);
|
||
return pool ? pool.getMetrics() : undefined;
|
||
}
|
||
}
|
||
|
||
/** 全局池管理器实例(`ecs.pool` 即此对象) */
|
||
export const ecsPoolCoordinator = new ECSPoolManager();
|