GFramework/docs/zh-CN/getting-started/installation.md

title, description

title	description
安装配置	说明 GFramework 各运行时与 source generator 包的安装选择和配置方式。

安装配置

GFramework 提供多种安装方式，您可以根据项目需求选择合适的包进行安装。

包选择说明

GFramework 采用模块化设计，不同包提供不同的功能：

包名	说明	适用场景
GeWuYou.GFramework	聚合元包	快速试用、原型开发
GeWuYou.GFramework.Core	核心框架	生产项目推荐
GeWuYou.GFramework.Cqrs	CQRS runtime	命令/查询/通知分发与处理器注册
GeWuYou.GFramework.Cqrs.Abstractions	CQRS 抽象契约	CQRS 契约、handler 接口与共享抽象
GeWuYou.GFramework.Game	游戏模块	需要游戏特定功能
GeWuYou.GFramework.Godot	Godot集成	Godot项目必需
GeWuYou.GFramework.Core.SourceGenerators	Core 源码生成器	[Log]、[ContextAware]、架构注入等
GeWuYou.GFramework.Game.SourceGenerators	Game 源码生成器	配置 schema / 配表生成
GeWuYou.GFramework.Godot.SourceGenerators	Godot 源码生成器	Godot 节点、UI、项目元数据生成
GeWuYou.GFramework.Cqrs.SourceGenerators	CQRS 源码生成器	处理器注册表生成

当前 NuGet 发布按模块拆分 source generator 包，不存在 GeWuYou.GFramework.SourceGenerators 聚合包。

安装方式

1. 使用 .NET CLI（推荐）

# 核心能力（推荐最小起步）
dotnet add package GeWuYou.GFramework.Core
dotnet add package GeWuYou.GFramework.Core.Abstractions

# CQRS runtime
dotnet add package GeWuYou.GFramework.Cqrs
dotnet add package GeWuYou.GFramework.Cqrs.Abstractions

# 游戏扩展
dotnet add package GeWuYou.GFramework.Game
dotnet add package GeWuYou.GFramework.Game.Abstractions

# Godot 集成（仅 Godot 项目需要）
dotnet add package GeWuYou.GFramework.Godot

# Core 侧源码生成器（[Log] / [ContextAware] / [GetSystem] 等）
dotnet add package GeWuYou.GFramework.Core.SourceGenerators

# Game 配置 schema 生成器
dotnet add package GeWuYou.GFramework.Game.SourceGenerators

# Godot 生成器（仅 Godot 项目需要）
dotnet add package GeWuYou.GFramework.Godot.SourceGenerators

# CQRS 处理器注册生成器（仅使用 CQRS source generator 时需要）
dotnet add package GeWuYou.GFramework.Cqrs.SourceGenerators

2. 使用 PackageReference

在您的 .csproj 文件中添加：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
  </PropertyGroup>
  
  <ItemGroup>
    <!-- 核心框架 -->
    <PackageReference Include="GeWuYou.GFramework.Core" Version="1.0.0" />
    <PackageReference Include="GeWuYou.GFramework.Core.Abstractions" Version="1.0.0" />

    <!-- CQRS runtime -->
    <PackageReference Include="GeWuYou.GFramework.Cqrs" Version="1.0.0" />
    <PackageReference Include="GeWuYou.GFramework.Cqrs.Abstractions" Version="1.0.0" />
    
    <!-- 游戏模块 -->
    <PackageReference Include="GeWuYou.GFramework.Game" Version="1.0.0" />
    <PackageReference Include="GeWuYou.GFramework.Game.Abstractions" Version="1.0.0" />
    
    <!-- Godot 集成 -->
    <PackageReference Include="GeWuYou.GFramework.Godot" Version="1.0.0" />
    
    <!-- 按场景选择的源码生成器 -->
    <PackageReference Include="GeWuYou.GFramework.Core.SourceGenerators" Version="1.0.0"
                      PrivateAssets="all" ExcludeAssets="runtime" />
    <PackageReference Include="GeWuYou.GFramework.Game.SourceGenerators" Version="1.0.0"
                      PrivateAssets="all" ExcludeAssets="runtime" />
    <PackageReference Include="GeWuYou.GFramework.Godot.SourceGenerators" Version="1.0.0"
                      PrivateAssets="all" ExcludeAssets="runtime" />
    <PackageReference Include="GeWuYou.GFramework.Cqrs.SourceGenerators" Version="1.0.0"
                      PrivateAssets="all" ExcludeAssets="runtime" />
  </ItemGroup>
</Project>

3. 使用 NuGet Package Manager

在 Visual Studio 中：

1. 右键点击项目 → 管理 NuGet 程序包
2. 搜索 GeWuYou.GFramework
3. 选择需要的包进行安装

环境要求

运行时要求

• .NET 6.0 或更高版本
• Godot 4.5+（仅 Godot 项目）

开发工具

• Visual Studio 2022 或 VS Code
• .NET 6.0 SDK
• Godot 4.5+（可选，仅 Godot 项目需要）

项目配置

1. 基础配置

如果你通过 NuGet 包使用 GFramework，并且希望自动导入已安装模块的推荐命名空间，可以在项目文件中显式开启：

<PropertyGroup>
  <EnableGFrameworkGlobalUsings>true</EnableGFrameworkGlobalUsings>
</PropertyGroup>

启用后，当前项目已引用的 GFramework 运行时模块会通过 buildTransitive 自动注入对应命名空间。

如果你想排除局部导入，可以继续在项目文件中添加排除项：

<ItemGroup>
    <GFrameworkExcludedUsing Include="GFramework.Core.Environment"/>
    <GFrameworkExcludedUsing Include="GFramework.Godot.Extensions"/>
</ItemGroup>

如果你使用的是本地 ProjectReference，或者希望完全手动控制导入范围，仍然可以继续维护自己的 GlobalUsings.cs 文件。

2. Godot 项目配置

如果使用 Godot 集成，需要在项目设置中启用 C# 支持：

1. 在 Godot 编辑器中打开项目设置
2. 导航到 Mono → Editor Settings
3. 确保启用了 C# 支持

3. 源码生成器配置

源码生成器会自动工作，无需额外配置。如果需要自定义生成器行为，可以在项目文件中添加：

<PropertyGroup>
  <GFrameworkLogLevel>Debug</GFrameworkLogLevel>
  <GFrameworkGenerateEnums>true</GFrameworkGenerateEnums>
</PropertyGroup>

验证安装

创建一个简单的测试来验证安装是否成功：

using GFramework.Core.Architectures;
using GFramework.Core.Model;
using GFramework.Core.Property;

// 定义简单的架构
public class TestArchitecture : Architecture
{
    protected override void OnInitialize()
    {
        // 注册一个简单的模型
        RegisterModel(new TestModel());
    }
}

public class TestModel : AbstractModel
{
    public BindableProperty<string> Message { get; } = new("Hello GFramework!");

    protected override void OnInit()
    {
    }
}

// 测试代码
var architecture = new TestArchitecture();
architecture.Initialize();

var model = architecture.GetModel<TestModel>();
Console.WriteLine(model.Message.Value); // 输出: Hello GFramework!

常见问题

1. 包版本冲突

如果遇到版本冲突，建议：

dotnet restore --force
dotnet clean
dotnet build

2. Godot 集成问题

确保：

• Godot 版本 >= 4.5
• 已正确安装 Godot C# 模板
• 项目引用了正确的 Godot 包

3. 源码生成器不工作

检查：

• 确保安装了与你正在使用的特性对应的拆分生成器包，例如： GeWuYou.GFramework.Core.SourceGenerators、GeWuYou.GFramework.Game.SourceGenerators、 GeWuYou.GFramework.Godot.SourceGenerators 或 GeWuYou.GFramework.Cqrs.SourceGenerators
• 重启 IDE
• 清理并重新构建项目