GFramework/GFramework.SourceGenerators
GeWuYou 0320404514 docs(config): 添加游戏内容配置系统完整文档与验证工具实现
- 新增游戏内容配置系统详细文档,涵盖 YAML 配置、JSON Schema 结构、目录组织等核心概念
- 实现配置验证工具,支持运行时校验、类型检查、引用验证等功能
- 提供完整的接入模板,包括项目结构、CSProj 配置、启动帮助器等推荐实践
- 集成 VS Code 插件支持,提供配置浏览、表单编辑、递归校验等开发期工具能力
- 实现热重载机制,支持开发期配置文件变更自动刷新运行时表
- 添加详细的 Schema 示例和 YAML 示例,展示怪物、物品等游戏内容配置的实际应用
- 提供 Architecture 接入模板,支持与现有架构的无缝集成
- 实现跨表引用校验,确保配置数据的一致性和完整性
2026-04-10 12:22:20 +08:00
..

GFramework.SourceGenerators

Core 侧通用源码生成器模块。

Context Get 注入

当类本身是上下文感知类型时,可以通过字段特性生成一个手动调用的注入方法:

  • [GetService]
  • [GetServices]
  • [GetSystem]
  • [GetSystems]
  • [GetModel]
  • [GetModels]
  • [GetUtility]
  • [GetUtilities]
  • [GetAll]

上下文感知类满足以下任一条件即可:

  • 类上带有 [ContextAware]
  • 继承 ContextAwareBase
  • 实现 IContextAware

生成器会生成 __InjectContextBindings_Generated(),需要在合适的生命周期中手动调用。在 Godot 中通常放在 _Ready()

using GFramework.SourceGenerators.Abstractions.Rule;

[ContextAware]
public partial class InventoryPanel
{
    [GetModel]
    private IInventoryModel _inventory = null!;

    [GetServices]
    private IReadOnlyList<IInventoryStrategy> _strategies = null!;

    public override void _Ready()
    {
        __InjectContextBindings_Generated();
    }
}

[GetAll] 作用于类本身,会自动扫描字段并推断 ModelSystemUtility 相关的 GetX 调用;已显式标记字段的优先级更高。

ServiceServices 绑定不会在 [GetAll] 下自动推断。对于普通引用类型字段,请显式使用 [GetService][GetServices],避免将非上下文服务字段误判为服务依赖。

[GetAll] 会跳过 conststaticreadonly 字段。若某个字段本来会被 [GetAll] 推断为 ModelSystemUtility 绑定,但因为是不可赋值的 staticreadonly 字段而被跳过,生成器会发出警告提示该字段不会参与生成。

注册分析器

包现在同时包含一个注册可见性分析器,用于检查 ModelSystemUtility 的使用点是否能在所属架构中找到静态可见注册。

  • 覆盖字段特性注入:[GetModel][GetModels][GetSystem][GetSystems][GetUtility][GetUtilities]
  • 覆盖手写调用:GetModel<T>()GetModels<T>()GetSystem<T>()GetSystems<T>()GetUtility<T>()GetUtilities<T>()
  • 默认报告 Warning
  • 当前只分析静态可见的注册路径,例如 OnInitialize()InstallModules()InstallModule(new Module())

对于反射、运行时条件分支、外部程序集动态注册等路径,分析器不会强行推断;当无法唯一确定组件所属架构时,也会选择不报,优先降低误报。