mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
704fdaa2c8
- 更新 Core 与 Core.Abstractions README 的目录映射和 XML 阅读入口 - 重写 Core Abstractions 页面，改为契约边界与最小接入路径说明 - 补充 Core landing page、API 参考入口和 ai-plan 跟踪记录
3.2 KiB
3.2 KiB
GFramework.Core.Abstractions
GFramework.Core.Abstractions 承载 Core 运行时对应的接口、枚举和值对象，用来定义跨模块协作边界。
它只描述契约，不提供默认的架构、事件、状态、资源或 IoC 实现；这些实现都在 GFramework.Core 中。
什么时候单独依赖它
- 你在做插件、适配层或扩展包，只想依赖契约，不想把完整运行时拉进来
- 你需要为测试、编辑器工具或生成器提供替身实现
- 你在做多模块拆分，希望上层只面向接口编程
如果你只是直接使用框架功能，优先安装 GFramework.Core。
包关系
- 契约层：
GFramework.Core.Abstractions - 实现层：
GFramework.Core - 相关扩展：
GFramework.Cqrs.AbstractionsGFramework.Game.Abstractions
契约地图
| 目录族 | 作用 |
|---|---|
Architectures/ Lifecycle/ Registries/ |
IArchitecture、上下文、模块、服务模块、阶段监听、注册表基类与生命周期契约 |
Bases/ Controller/ Model/ Systems/ Utility/ Rule/ |
组件角色接口、优先级 / key 值对象、上下文感知约束与扩展边界 |
Command/ Query/ Cqrs/ |
旧版命令 / 查询执行器接口，以及 ICqrsRuntime 这类新请求模型接线契约 |
Events/ Property/ State/ StateManagement/ |
事件总线、解绑对象、可绑定属性、状态机、Store / reducer / middleware 契约 |
Coroutine/ Time/ Pause/ Concurrency/ |
协程状态、时间源、暂停栈、键控异步锁和统计对象 |
Resource/ Pool/ Logging/ Localization/ |
资源句柄、对象池、日志、日志工厂、本地化表与格式化契约 |
Configuration/ Environment/ |
配置管理器、环境对象与运行时环境访问契约 |
Data/ Serializer/ Storage/ Versioning/ |
数据装载、序列化、存储与版本化契约 |
Enums/ Properties/ |
架构阶段枚举，以及架构 / logger 相关属性键 |
采用建议
- 框架消费者通常同时安装
GFramework.Core与GFramework.Core.Abstractions - 若你只需要对接口编程，可以仅引用本包，再在应用层自行提供实现
- 若你在写上层模块，优先把公共契约放在
*.Abstractions，实现放在对应 runtime 包
重点 XML 关注点
如果你在做契约审计、模块拆分或测试替身，优先看这些类型族的 XML 文档：
- 架构与模块入口：
IArchitecture、IArchitectureContext、IServiceModule - 运行时基础设施：
IIocContainer、ILogger、IResourceManager、IConfigurationManager - 状态与并发能力：
IStateMachine、IStore、IAsyncKeyLockManager、ITimeProvider - 迁移与组合边界：
ICommandExecutor、IQueryExecutor、ICqrsRuntime
对应文档
- 抽象接口栏目：
../docs/zh-CN/abstractions/index.md - Core 抽象页：
../docs/zh-CN/abstractions/core-abstractions.md - Core 运行时入口：
../GFramework.Core/README.md - API 参考入口：
../docs/zh-CN/api-reference/index.md