mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
8209d7a29f
- 修复公开 README 与 docs 页面中的反问式标题、维护者口吻和裸文件名链接标签 - 补充 AGENTS.md 与 gframework-doc-refresh 的 reader-facing 文档输出约束 - 更新 documentation-full-coverage-governance 的恢复点与验证记录
GFramework.Core
GFramework.Core 是框架的基础运行时，负责架构生命周期、组件注册、上下文访问，以及不依赖具体引擎的通用能力。
如果你只想先把框架跑起来，应先从这个模块开始。
模块定位
这一层提供：
Architecture与ArchitectureContextModel/System/Utility运行时- 旧版
Command/Query执行器，以及与新版CQRSruntime 的接线入口 - 事件、属性、状态机、状态管理、规则与上下文扩展
- 资源、对象池、日志、协程、并发、环境、配置与本地化
- 服务模块管理、时间提供器与默认的 IoC 容器适配
它不负责：
- 游戏内容配置、Scene / UI / Storage 等游戏层能力
- Godot 节点与场景集成
- 新版 CQRS 请求模型的消息契约定义
包关系
- 直接依赖：
GFramework.CqrsGFramework.Cqrs.AbstractionsGFramework.Core.Abstractions
- 常见上层模块：
GFramework.GameGFramework.Godot
如果你只需要契约，不需要实现层，改为依赖 Core 抽象层说明。
子系统地图
| 目录 | 作用 |
|---|---|
Architectures/ |
架构入口、上下文、生命周期、模块安装与组件注册 |
Services/ |
服务模块注册、生命周期协调与模块管理 |
Command/ |
旧版命令执行器与同步 / 异步命令基类 |
Query/ |
旧版查询执行器与同步 / 异步查询基类 |
Events/ |
事件总线、事件作用域、统计与过滤 |
Property/ |
BindableProperty<T> 与相关解绑对象 |
State/ |
状态机与状态切换事件 |
StateManagement/ |
Store、selector、middleware 与状态诊断 |
Coroutine/ |
协程调度、快照、统计与优先级 |
Time/ |
默认时间提供器与协程时间源 |
Resource/ |
资源缓存、句柄和释放策略 |
Pool/ |
对象池系统与常用池化辅助实现 |
Logging/ |
logger、factory、配置与组合日志器 |
Ioc/ |
基于 Microsoft.Extensions.DependencyInjection 的容器适配 |
Concurrency/ |
键控异步锁与统计 |
Configuration/ |
配置管理器与配置监听解绑对象 |
Environment/ |
运行环境对象与上下文环境扩展 |
Pause/ |
暂停栈和暂停范围 |
Localization/ |
本地化表与格式化入口 |
Rule/ |
ContextAwareBase 等上下文感知基类 |
Functional/ |
Option、Result 等轻量函数式工具 |
Extensions/ |
上下文与集合等扩展方法 |
XML 覆盖基线
截至 2026-04-22，已按顶层目录对 GFramework.Core 的公开 / 内部类型声明做过一轮轻量盘点；当前主目录族的类型声明都已带
XML 注释。这里先保留阅读基线，成员级 <param> / <returns> / 生命周期语义审计仍属于后续治理项。
| 类型族 | 基线状态 | 代表类型 |
|---|---|---|
Architectures/ Services/ |
22/22 个类型声明已带 XML 注释 |
Architecture、ArchitectureContext、ArchitectureLifecycle、ServiceModuleManager |
Command/ Query/ |
15/15 个类型声明已带 XML 注释 |
CommandExecutor、AsyncQueryExecutor、AbstractCommand<TInput>、AbstractQuery<TResult> |
Events/ Property/ State/ StateManagement/ |
29/29 个类型声明已带 XML 注释 |
EventBus、BindableProperty<T>、StateMachine、Store<TState> |
Coroutine/ Time/ Pause/ Concurrency/ |
43/43 个类型声明已带 XML 注释 |
CoroutineScheduler、CoroutineHandle、PauseStackManager、AsyncKeyLockManager |
Resource/ Pool/ |
8/8 个类型声明已带 XML 注释 |
ResourceManager、AutoReleaseStrategy、AbstractObjectPoolSystem<TKey, TObject> |
Logging/ Localization/ Configuration/ Environment/ Ioc/ |
31/31 个类型声明已带 XML 注释 |
ConsoleLogger、LocalizationManager、ConfigurationManager、DefaultEnvironment、MicrosoftDiContainer |
Model/ Systems/ Utility/ Rule/ Extensions/ Functional/ |
34/34 个类型声明已带 XML 注释 |
AbstractModel、AbstractSystem、NumericDisplayFormatter、ContextAwareBase、Result<T> |
完整的模块化接入说明和阅读顺序见 Core 栏目。
最小接入路径
dotnet add package GeWuYou.GFramework.Core
dotnet add package GeWuYou.GFramework.Core.Abstractions
最小入口：
- 继承
Architecture - 在
OnInitialize()中注册模型、系统、工具或模块 - 通过
architecture.Context或ContextAwareBase的扩展方法访问上下文
最小示例见：
什么时候继续接别的包
- 需要推荐的新请求模型：加
GFramework.Cqrs - 需要游戏层路由、设置、配置和存储：加
GFramework.Game - 需要 Godot 节点与场景适配：加
GFramework.Godot - 需要编译期生成日志、上下文注入或模块注册：加
GFramework.Core.SourceGenerators