mirror of https://github.com/GeWuYou/GFramework.git synced 2026-03-23 03:04:29 +08:00

GeWuYou 7a18d9459b docs(core): 更新核心架构文档完善命令事件系统说明

- 重构架构文档增加模块管理和生命周期管理说明
- 更新命令系统文档移除输入参数结构简化命令定义
- 完善事件系统文档添加事件总线和注销功能说明
- 补充IoC容器文档增加多实例注册和单例管理说明
- 优化示例代码展示架构初始化和组件获取方式
- 添加配置选项说明和最佳实践建议

2026-02-11 20:13:40 +08:00

12 KiB

Raw Blame History

Query 包使用说明

概述

Query 包实现了 CQRS（命令查询职责分离）模式中的查询部分。Query 用于封装数据查询逻辑，与 Command 不同的是，Query 有返回值且不应该修改系统状态。

查询系统是 GFramework CQRS 架构的重要组成部分，专门负责数据读取操作，与命令系统和事件系统协同工作。

核心接口

IQuery`<TResult>`

查询接口，定义了查询的基本契约。

核心成员：

TResult Do();  // 执行查询并返回结果

核心类

AbstractQuery`<TResult>`

抽象查询基类，提供了查询的基础实现。

核心方法：

TResult IQuery<TResult>.Do();           // 实现 IQuery 接口
protected abstract TResult OnDo();      // 抽象查询方法，由子类实现

使用方式：

public abstract class AbstractQuery<TResult> : ContextAwareBase, IQuery<TResult>
{
    public TResult Do() => OnDo();          // 执行查询
    protected abstract TResult OnDo();      // 子类实现查询逻辑
}

EmptyQueryInput

空查询输入类，用于表示不需要任何输入参数的查询操作。

使用方式：

public sealed class EmptyQueryInput : IQueryInput
{
    // 作为占位符使用，适用于那些不需要额外输入参数的查询场景
}

QueryBus

查询总线实现，负责执行查询并返回结果。

核心方法：

TResult Send<TResult>(IQuery<TResult> query);  // 发送并执行查询

使用方式：

public sealed class QueryBus : IQueryBus
{
    public TResult Send<TResult>(IQuery<TResult> query)
    {
        ArgumentNullException.ThrowIfNull(query);
        return query.Do();
    }
}

基本使用

1. 定义查询

// 查询玩家金币数量
public class GetPlayerGoldQuery : AbstractQuery<int>
{
    protected override int OnDo()
    {
        return this.GetModel<PlayerModel>().Gold.Value;
    }
}

// 查询玩家是否死亡
public class IsPlayerDeadQuery : AbstractQuery<bool>
{
    protected override bool OnDo()
    {
        return this.GetModel<PlayerModel>().Health.Value <= 0;
    }
}

// 查询背包中指定物品的数量
public class GetItemCountQuery : AbstractQuery<int>
{
    private readonly string _itemId;
    
    public GetItemCountQuery(string itemId)
    {
        _itemId = itemId;
    }

    protected override int OnDo()
    {
        var inventory = this.GetModel<InventoryModel>();
        return inventory.GetItemCount(_itemId);
    }
}


### 2. 发送查询

```csharp
public partial class ShopUI : Control, IController
{
    [Export] private Button _buyButton;
    [Export] private int _itemPrice = 100;
    
    public IArchitecture GetArchitecture() => GameArchitecture.Interface;
    
    public override void _Ready()
    {
        _buyButton.Pressed += OnBuyButtonPressed;
    }
    
    private void OnBuyButtonPressed()
    {
        // 查询玩家金币
        int playerGold = this.SendQuery(new GetPlayerGoldQuery());
        
        if (playerGold >= _itemPrice)
        {
            // 发送购买命令
            this.SendCommand(new BuyItemCommand("sword_01"));
        }
        else
        {
            Console.WriteLine("金币不足！");
        }
    }
}

3. 在 System 中使用

public class CombatSystem : AbstractSystem
{
    protected override void OnInit()
    {
        // 注册事件监听
        this.RegisterEvent<EnemyAttackEvent>(OnEnemyAttack);
    }

    private void OnEnemyAttack(EnemyAttackEvent e)
    {
        // 查询玩家是否已经死亡
        bool isDead = this.SendQuery(new IsPlayerDeadQuery());
        
        if (!isDead)
        {
            // 执行伤害逻辑
            this.SendCommand(new TakeDamageCommand(e.Damage));
        }
    }
}


## 高级用法

### 1. 带参数的复杂查询

```csharp
// 查询指定范围内的敌人列表
public class GetEnemiesInRangeQuery : AbstractQuery<List<Enemy>>
{
    private readonly Vector3 _center;
    private readonly float _radius;
    
    public GetEnemiesInRangeQuery(Vector3 center, float radius)
    {
        _center = center;
        _radius = radius;
    }
    
    protected override List<Enemy> OnDo()
    {
        var enemySystem = this.GetSystem<EnemySpawnSystem>();
        return enemySystem.GetEnemiesInRange(_center, _radius);
    }
}

// 使用
var enemies = this.SendQuery(new GetEnemiesInRangeQuery(playerPosition, 10.0f));

2. 组合查询

// 查询玩家是否可以使用技能
public class CanUseSkillQuery : AbstractQuery<bool>
{
    private readonly string _skillId;

    public CanUseSkillQuery(string skillId)
    {
        _skillId = skillId;
    }

    protected override bool OnDo()
    {
        var playerModel = this.GetModel<PlayerModel>();
        var skillModel = this.GetModel<SkillModel>();
        
        // 查询技能消耗
        var skillCost = this.SendQuery(new GetSkillCostQuery(_skillId));
        
        // 检查是否满足条件
        return playerModel.Mana.Value >= skillCost.ManaCost
            && !this.SendQuery(new IsSkillOnCooldownQuery(_skillId));
    }
}

public class GetSkillCostQuery : AbstractQuery<SkillCost>
{
    private readonly string _skillId;

    public GetSkillCostQuery(string skillId)
    {
        _skillId = skillId;
    }

    protected override SkillCost OnDo()
    {
        return this.GetModel<SkillModel>().GetSkillCost(_skillId);
    }
}

public class IsSkillOnCooldownQuery : AbstractQuery<bool>
{
    private readonly string _skillId;

    public IsSkillOnCooldownQuery(string skillId)
    {
        _skillId = skillId;
    }

    protected override bool OnDo()
    {
        return this.GetModel<SkillModel>().IsOnCooldown(_skillId);
    }
}


### 3. 聚合数据查询

```csharp
// 查询玩家战斗力
public class GetPlayerPowerQuery : AbstractQuery<int>
{
    protected override int OnDo()
    {
        var playerModel = this.GetModel<PlayerModel>();
        var equipmentModel = this.GetModel<EquipmentModel>();
        
        int basePower = playerModel.Level.Value * 10;
        int equipmentPower = equipmentModel.GetTotalPower();
        int buffPower = this.SendQuery(new GetBuffPowerQuery());
        
        return basePower + equipmentPower + buffPower;
    }
}

// 查询玩家详细信息（用于UI显示）
public class GetPlayerInfoQuery : AbstractQuery<PlayerInfo>
{
    protected override PlayerInfo OnDo()
    {
        var playerModel = this.GetModel<PlayerModel>();
        
        return new PlayerInfo
        {
            Name = playerModel.Name.Value,
            Level = playerModel.Level.Value,
            Health = playerModel.Health.Value,
            MaxHealth = playerModel.MaxHealth.Value,
            Gold = this.SendQuery(new GetPlayerGoldQuery()),
            Power = this.SendQuery(new GetPlayerPowerQuery())
        };
    }
}

4. 跨 System 查询

// 在 AI System 中查询玩家状态
public class EnemyAISystem : AbstractSystem
{
protected override void OnInit() { }

    public void UpdateEnemyBehavior(Enemy enemy)
    {
        // 查询玩家位置
        var playerPos = this.SendQuery(new GetPlayerPositionQuery());
        
        // 查询玩家是否在攻击范围内
        bool inRange = this.SendQuery(new IsPlayerInRangeQuery
        {
            Position = enemy.Position,
            Range = enemy.AttackRange
        });
        
        if (inRange)
        {
            // 查询是否可以攻击
            bool canAttack = this.SendQuery(new CanEnemyAttackQuery
            {
                EnemyId = enemy.Id
            });
            
            if (canAttack)
            {
                this.SendCommand(new EnemyAttackCommand { EnemyId = enemy.Id });
            }
        }
    }

}

Query 的执行机制

所有发送给查询总线的查询最终都会通过 QueryExecutor 来执行：

public class QueryExecutor
{
    public static TResult Execute<TResult>(IQuery<TResult> query)
    {
        return query.Do();
    }
}

特点：

提供统一的查询执行机制
支持同步查询执行
与架构上下文集成

Command vs Query

Command（命令）

用途：修改系统状态
返回值：无返回值（void）或有返回值
示例：购买物品、造成伤害、升级角色

Query（查询）

用途：读取数据，不修改状态
返回值：必须有返回值
示例：获取金币数量、检查技能冷却、查询玩家位置

// ❌ 错误：在 Query 中修改状态
public class BadQuery : AbstractQuery<int>
{
    protected override int OnDo()
    {
        var model = this.GetModel<PlayerModel>();
        model.Gold.Value += 100;  // 不应该在 Query 中修改数据！
        return model.Gold.Value;
    }
}

// ✅ 正确：Query 只读取数据
public class GoodQuery : AbstractQuery<int>
{
    protected override int OnDo()
    {
        return this.GetModel<PlayerModel>().Gold.Value;
    }
}

// ✅ 修改数据应该使用 Command
public class AddGoldCommand : AbstractCommand
{
    private readonly int _amount;
    
    public AddGoldCommand(int amount)
    {
        _amount = amount;
    }
    
    protected override void OnExecute()
    {
        var model = this.GetModel<PlayerModel>();
        model.Gold.Value += _amount;
    }
}

最佳实践

查询只读取，不修改 - 保持 Query 的纯粹性
小而专注 - 每个 Query 只负责一个具体的查询任务
可组合 - 复杂查询可以通过组合简单查询实现
避免过度查询 - 如果需要频繁查询，考虑使用 BindableProperty
命名清晰 - Query 名称应该清楚表达查询意图（Get、Is、Can、Has等前缀）
参数通过构造函数传递 - 查询需要的参数应在创建时传入
查询无状态 - 查询不应该保存长期状态，执行完即可丢弃
合理使用缓存 - 对于复杂计算，可以在 Model 中缓存结果

性能优化

1. 缓存查询结果

// 在 Model 中缓存复杂计算
public class PlayerModel : AbstractModel
{
    private int? _cachedPower;

    public int GetPower()
    {
        if (_cachedPower == null)
        {
            _cachedPower = CalculatePower();
        }
        return _cachedPower.Value;
    }
    
    private int CalculatePower()
    {
        // 复杂计算...
        return 100;
    }
    
    public void InvalidatePowerCache()
    {
        _cachedPower = null;
    }
}


### 2. 批量查询

```csharp
// 一次查询多个数据，而不是多次单独查询
public class GetMultipleItemCountsQuery : AbstractQuery<Dictionary<string, int>>
{
    private readonly List<string> _itemIds;
    
    public GetMultipleItemCountsQuery(List<string> itemIds)
    {
        _itemIds = itemIds;
    }
    
    protected override Dictionary<string, int> OnDo()
    {
        var inventory = this.GetModel<InventoryModel>();
        return _itemIds.ToDictionary(id => id, id => inventory.GetItemCount(id));
    }
}

查询模式优势

1. 职责分离

读写操作明确分离
便于优化读写性能
降低系统复杂度

2. 可扩展性

读写可以独立扩展
支持不同的数据存储策略
便于实现读写分离

3. 可维护性

查询逻辑集中管理
便于重构和优化
降低组件间耦合

12 KiB Raw Blame History Unescape Escape

Query 包使用说明

概述

核心接口

IQuery<TResult>

核心类

AbstractQuery<TResult>

EmptyQueryInput

QueryBus

基本使用

1. 定义查询

3. 在 System 中使用

2. 组合查询

4. 跨 System 查询

Query 的执行机制

Command vs Query

Command（命令）

Query（查询）

最佳实践

性能优化

1. 缓存查询结果

查询模式优势

1. 职责分离

2. 可扩展性

3. 可维护性

相关包

12 KiB

Raw Blame History

IQuery`<TResult>`

AbstractQuery`<TResult>`