GFramework/GFramework.Core/query

Query 包使用说明

概述

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

核心接口

ICanSendQuery

标记接口，表示该类型可以发送查询。

继承关系：

public interface ICanSendQuery : IBelongToArchitecture

IQuery<TResult>

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

核心成员：

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

继承的能力：

• ICanSetArchitecture - 可设置架构
• ICanGetModel - 可获取 Model
• ICanGetSystem - 可获取 System
• ICanSendQuery - 可发送其他 Query

核心类

AbstractQuery<T>

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

使用方式：

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

基本使用

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>
{
    public string ItemId { get; set; }
    
    protected override int OnDo()
    {
        var inventory = this.GetModel<InventoryModel>();
        return inventory.GetItemCount(ItemId);
    }
}

2. 发送查询（在 Controller 中）

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 { ItemId = "sword_01" });
        }
        else
        {
            GD.Print("金币不足！");
        }
    }
}

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 { Damage = e.Damage });
        }
    }
}

高级用法

1. 带参数的复杂查询

// 查询指定范围内的敌人列表
public class GetEnemiesInRangeQuery : AbstractQuery<List<Enemy>>
{
    public Vector3 Center { get; set; }
    public float Radius { get; set; }
    
    protected override List<Enemy> OnDo()
    {
        var enemySystem = this.GetSystem<EnemySpawnSystem>();
        return enemySystem.GetEnemiesInRange(Center, Radius);
    }
}

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

2. 组合查询

// 查询玩家是否可以使用技能
public class CanUseSkillQuery : AbstractQuery<bool>
{
    public string SkillId { get; set; }
    
    protected override bool OnDo()
    {
        var playerModel = this.GetModel<PlayerModel>();
        var skillModel = this.GetModel<SkillModel>();
        
        // 查询技能消耗
        var skillCost = this.SendQuery(new GetSkillCostQuery { SkillId = SkillId });
        
        // 检查是否满足条件
        return playerModel.Mana.Value >= skillCost.ManaCost
            && !this.SendQuery(new IsSkillOnCooldownQuery { SkillId = SkillId });
    }
}

public class GetSkillCostQuery : AbstractQuery<SkillCost>
{
    public string SkillId { get; set; }
    
    protected override SkillCost OnDo()
    {
        return this.GetModel<SkillModel>().GetSkillCost(SkillId);
    }
}

public class IsSkillOnCooldownQuery : AbstractQuery<bool>
{
    public string SkillId { get; set; }
    
    protected override bool OnDo()
    {
        return this.GetModel<SkillModel>().IsOnCooldown(SkillId);
    }
}

3. 聚合数据查询

// 查询玩家战斗力
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 });
            }
        }
    }
}

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
{
    public int Amount { get; set; }
    
    protected override void OnExecute()
    {
        var model = this.GetModel<PlayerModel>();
        model.Gold.Value += Amount;
    }
}

最佳实践

1. 查询只读取，不修改 - 保持 Query 的纯粹性
2. 小而专注 - 每个 Query 只负责一个具体的查询任务
3. 可组合 - 复杂查询可以通过组合简单查询实现
4. 避免过度查询 - 如果需要频繁查询，考虑使用 BindableProperty
5. 命名清晰 - Query 名称应该清楚表达查询意图（Get、Is、Can、Has等前缀）

性能优化

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. 批量查询

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

相关包

• command - CQRS 的命令部分
• model - Query 主要从 Model 获取数据
• system - System 中可以发送 Query
• controller - Controller 中可以发送 Query
• extensions - 提供 SendQuery 扩展方法