gewuyou/GFramework
1
0
Fork 0
mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-07 00:27:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
GFramework/GFramework.Core.Abstractions/README.md
gewuyou 7209fdc32d docs(cqrs): 收口旧版运行时别名说明 
- 更新 LegacyICqrsRuntime 兼容层说明，明确旧命名空间别名与正式 CQRS runtime seam 的边界

- 补充容器基础设施回填 legacy alias 的回归测试，并收敛相关 helper 注释

- 更新 cqrs-rewrite 跟踪与 trace，记录 RP-066 的批处理结果和验证
2026-04-30 11:38:52 +08:00

5.2 KiB
Raw Blame History

GFramework.Core.Abstractions

GFramework.Core.Abstractions 承载 Core 运行时对应的接口、枚举和值对象，用来定义跨模块协作边界。

它只描述契约，不提供默认的架构、事件、状态、资源或 IoC 实现；这些实现都在 GFramework.Core 中。

什么时候单独依赖它

  • 你在做插件、适配层或扩展包，只想依赖契约，不想把完整运行时拉进来
  • 你需要为测试、编辑器工具或生成器提供替身实现
  • 你在做多模块拆分，希望上层只面向接口编程

如果你只是直接使用框架功能，优先安装 GFramework.Core。

包关系

  • 契约层：GFramework.Core.Abstractions
  • 实现层：GFramework.Core
  • 相关扩展：
    • GFramework.Cqrs.Abstractions
    • GFramework.Game.Abstractions

契约地图

目录族 作用
Architectures/ Lifecycle/ Registries/ IArchitecture、上下文、模块、服务模块、阶段监听、注册表基类与生命周期契约
Bases/ Controller/ Model/ Systems/ Utility/ Rule/ 组件角色接口、优先级 / key 值对象、上下文感知约束与扩展边界
Command/ Query/ Cqrs/ 旧版命令 / 查询执行器接口，以及面向 CQRS runtime 的兼容别名入口
Events/ Property/ State/ StateManagement/ 事件总线、解绑对象、可绑定属性、状态机、Store / reducer / middleware 契约
Coroutine/ Time/ Pause/ Concurrency/ 协程状态、时间源、暂停栈、键控异步锁和统计对象
Resource/ Pool/ Logging/ Localization/ 资源句柄、对象池、日志、日志工厂、本地化表与格式化契约
Configuration/ Environment/ 配置管理器、环境对象与运行时环境访问契约
Data/ Serializer/ Storage/ Versioning/ 数据装载、序列化、存储与版本化契约
Enums/ Properties/ 架构阶段枚举，以及架构 / logger 相关属性键

XML 阅读入口

下面这份目录视图可以帮助你快速定位 GFramework.Core.Abstractions 的代表类型。更细的契约约束与交互语义，适合在阅读具体接口和成员时继续结合源码确认。

类型族 代表类型 阅读重点
Architectures/ Lifecycle/ Registries/ IArchitecture、IArchitectureContext、IServiceModule、KeyValueRegistryBase<TKey, TValue> 看架构、上下文、模块装配与注册表基类边界
Command/ Query/ Cqrs/ ICommandExecutor、IAsyncQueryExecutor、ICqrsRuntime 看旧命令 / 查询契约，以及 CQRS runtime 的兼容别名入口
Events/ Property/ State/ StateManagement/ IEventBus、IBindableProperty<T>、IStateMachine、IStore<TState> 看事件分发、可绑定状态与 store 契约
Coroutine/ Time/ Pause/ Concurrency/ IYieldInstruction、ITimeProvider、IPauseStackManager、IAsyncKeyLockManager 看协程、时间源、暂停栈与并发协调能力
Resource/ Pool/ Logging/ Localization/ IResourceManager、IObjectPoolSystem、ILogger、ILocalizationManager 看资源、对象池、日志与本地化服务角色
Configuration/ Environment/ Data/ Serializer/ Storage/ Versioning/ IConfigurationManager、IEnvironment、ILoadableFrom<T>、ISerializer、IStorage 看配置、环境、数据装载、序列化与存储边界
Bases/ Controller/ Model/ Systems/ Utility/ Rule/ Enums/ Properties/ IPrioritized、IController、IModel、ISystem、IContextUtility、ArchitecturePhase 看组件角色、优先级和值对象约定

完整接入说明与阅读顺序见 Core 抽象层说明。

采用建议

  • 框架消费者通常同时安装 GFramework.Core 与 GFramework.Core.Abstractions
  • 若你只需要对接口编程，可以仅引用本包，再在应用层自行提供实现
  • 若你在写上层模块，优先把公共契约放在 *.Abstractions，实现放在对应 runtime 包

推荐优先阅读的 XML 类型族

如果你在做模块拆分、测试替身或接口适配，优先看这些类型族的 XML 文档：

  • 架构与模块入口：IArchitecture、IArchitectureContext、IServiceModule
  • 运行时基础设施：IIocContainer、ILogger、IResourceManager、IConfigurationManager
  • 状态与并发能力：IStateMachine、IStore、IAsyncKeyLockManager、ITimeProvider
  • 迁移与组合边界：ICommandExecutor、IQueryExecutor，以及旧命名空间下作为 compatibility alias 暴露的 ICqrsRuntime

GFramework.Core.Abstractions.Cqrs.ICqrsRuntime 当前主要用于兼容旧命名空间引用。新代码应直接依赖 GFramework.Cqrs.Abstractions.Cqrs.ICqrsRuntime，这样可以把请求模型、handler 和 runtime seam 保持在同一套 CQRS 契约下。

对应文档