mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
ebdc231c07
- 调整文档真实性原则，以源码和测试为首要证据源 - 新增模块README要求，规定所有用户包必须有说明文档 - 更新仓库文档规范，要求根README与文档站点分类一致 - 添加VitePress配置文件，支持中文搜索和泛型转义 - 创建入门指南文档，说明GFramework模块组成和接入路径 - 添加快速开始教程，演示Core模块最小使用示例 - 为Core模块添加详细README文档 - 为Core.Abstractions添加契约层说明文档 - 为Core.SourceGenerators添加源码生成器文档 - 为Game模块添加运行时层详细说明文档
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
# GFramework.Game.SourceGenerators
|
||
|
||
`GFramework.Game.SourceGenerators` 负责把 `schemas/**/*.schema.json` 转成游戏内容配置类型和表包装代码。
|
||
|
||
它服务的核心场景是：让 `YAML` 配置、`JSON Schema`、运行时加载器和工具链共享一套结构定义。
|
||
|
||
## 模块定位
|
||
|
||
这个包是编译期生成器，不是运行时库。
|
||
|
||
它会在编译期读取 schema，并生成：
|
||
|
||
- 配置数据类型
|
||
- 对应的表包装类型
|
||
- 与 `GFramework.Game.Config` 运行时协作的访问辅助代码
|
||
|
||
## 包关系
|
||
|
||
- 运行时：`GFramework.Game`
|
||
- 生成器：`GFramework.Game.SourceGenerators`
|
||
- 公共生成器支撑：`GFramework.SourceGenerators.Common`
|
||
|
||
如果你的项目还会使用 `[Log]`、`[ContextAware]` 或 Core 侧上下文注入特性，还需要同时安装
|
||
`GFramework.Core.SourceGenerators`。
|
||
|
||
## 目录与输入约定
|
||
|
||
当前项目结构显示该生成器主要围绕以下代码组织：
|
||
|
||
- `Config/SchemaConfigGenerator.cs`
|
||
- `Diagnostics/ConfigSchemaDiagnostics.cs`
|
||
- `GeWuYou.GFramework.Game.SourceGenerators.targets`
|
||
|
||
消费者项目的推荐目录约定：
|
||
|
||
```text
|
||
GameProject/
|
||
├─ config/
|
||
│ └─ monster/
|
||
│ └─ slime.yaml
|
||
└─ schemas/
|
||
└─ monster.schema.json
|
||
```
|
||
|
||
默认情况下，打包产物会通过 `targets` 把 `schemas/**/*.schema.json` 纳入 `AdditionalFiles`。
|
||
|
||
## 最小接入路径
|
||
|
||
```xml
|
||
<ItemGroup>
|
||
<PackageReference Include="GeWuYou.GFramework.Game" Version="x.y.z" />
|
||
<PackageReference Include="GeWuYou.GFramework.Game.SourceGenerators"
|
||
Version="x.y.z"
|
||
PrivateAssets="all"
|
||
ExcludeAssets="runtime" />
|
||
</ItemGroup>
|
||
```
|
||
|
||
如果你在仓库内用 `ProjectReference` 调试，仍需要把对应 `targets` 接进消费者项目。
|
||
|
||
## 什么时候使用它
|
||
|
||
- 你想把静态游戏内容维护成 `YAML`
|
||
- 你希望在编译期拿到强类型配置访问入口
|
||
- 你希望运行时加载、schema 校验和编辑工具链共用同一份结构定义
|
||
|
||
## 对应文档
|
||
|
||
- 配置系统：[`../docs/zh-CN/game/config-system.md`](../docs/zh-CN/game/config-system.md)
|
||
- 源码生成器总览：[`../docs/zh-CN/source-generators/index.md`](../docs/zh-CN/source-generators/index.md)
|