mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 08:44:29 +08:00
ebdc231c07
- 调整文档真实性原则，以源码和测试为首要证据源 - 新增模块README要求，规定所有用户包必须有说明文档 - 更新仓库文档规范，要求根README与文档站点分类一致 - 添加VitePress配置文件，支持中文搜索和泛型转义 - 创建入门指南文档，说明GFramework模块组成和接入路径 - 添加快速开始教程，演示Core模块最小使用示例 - 为Core模块添加详细README文档 - 为Core.Abstractions添加契约层说明文档 - 为Core.SourceGenerators添加源码生成器文档 - 为Game模块添加运行时层详细说明文档
GFramework.Core
GFramework.Core 是框架的基础运行时，负责架构生命周期、组件注册、上下文访问，以及不依赖具体引擎的通用能力。
如果你只想先把框架跑起来，应先从这个模块开始。
模块定位
这一层提供：
Architecture与ArchitectureContextModel/System/Utility运行时- 旧版
Command/Query执行器 - 事件、属性、状态机、状态管理
- 资源、日志、协程、并发、环境与本地化
它不负责：
- 游戏内容配置、Scene / UI / Storage 等游戏层能力
- Godot 节点与场景集成
- 新版 CQRS 请求模型的消息契约定义
包关系
- 直接依赖：
GFramework.CqrsGFramework.Cqrs.AbstractionsGFramework.Core.Abstractions
- 常见上层模块：
GFramework.GameGFramework.Godot
如果你只需要契约，不需要实现层，改为依赖 ../GFramework.Core.Abstractions/README.md。
子系统地图
| 目录 | 作用 |
|---|---|
Architectures/ |
架构入口、上下文、生命周期、模块安装与组件注册 |
Command/ |
旧版命令执行器与同步 / 异步命令基类 |
Query/ |
旧版查询执行器与同步 / 异步查询基类 |
Events/ |
事件总线、事件作用域、统计与过滤 |
Property/ |
BindableProperty<T> 与相关解绑对象 |
State/ |
状态机与状态切换事件 |
StateManagement/ |
Store、selector、middleware 与状态诊断 |
Coroutine/ |
协程调度、快照、统计与优先级 |
Resource/ |
资源缓存、句柄和释放策略 |
Logging/ |
logger、factory、配置与组合日志器 |
Ioc/ |
基于 Microsoft.Extensions.DependencyInjection 的容器适配 |
Concurrency/ |
键控异步锁与统计 |
Pause/ |
暂停栈和暂停范围 |
Localization/ |
本地化表与格式化入口 |
Functional/ |
Option、Result 等轻量函数式工具 |
Extensions/ |
上下文与集合等扩展方法 |
最小接入路径
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