AxonFramework 查询处理器(Query Handlers)深度解析

AxonFramework 查询处理器(Query Handlers)深度解析

AxonFramework Framework for Evolutionary Message-Driven Microservices on the JVM 项目地址: https://gitcode.com/gh_mirrors/ax/AxonFramework

什么是查询处理器

在AxonFramework中，查询处理器(Query Handlers)是CQRS架构中负责处理查询(Query)的组件。与命令处理器不同，查询处理器不改变应用状态，而是专注于从系统中检索数据。通过@QueryHandler注解标记的方法能够响应特定的查询请求，并返回所需的数据。

编写查询处理器

基本结构

一个典型的查询处理器由以下几部分组成：

1. 查询模型：定义查询的数据结构，通常是一个简单的POJO
2. 处理器类：包含实际处理逻辑的类
3. 处理方法：使用@QueryHandler注解标记的方法

// 查询模型定义
public class FetchCardSummaryQuery {
    private final String cardSummaryId;
    
    public FetchCardSummaryQuery(String cardSummaryId) {
        this.cardSummaryId = cardSummaryId;
    }
    // getter方法省略
}

// 查询处理器类
public class CardSummaryProjection {
    private Map<String, CardSummary> cardSummaryStorage;

    @QueryHandler
    public CardSummary handle(FetchCardSummaryQuery query) {
        return cardSummaryStorage.get(query.getCardSummaryId());
    }
}

关键特性

1. 注解标识：@QueryHandler注解明确标识了查询处理方法
2. 参数匹配：方法的第一个参数决定了它能处理哪种查询
3. 返回类型：方法返回类型应与查询期望的响应类型匹配

在实际应用中，通常会使用数据库或专门的存储库替代示例中的简单Map结构。

查询处理器的调用顺序

AxonFramework采用特定的规则来确定调用哪个查询处理方法：

1. 在当前类层次结构中查找所有带@QueryHandler注解的方法
2. 选择参数类型最匹配的方法
3. 如果当前层次没有找到合适方法，则向父类查找
4. 直到顶层仍未找到则忽略该处理器

重要区别：与事件处理不同，查询处理不考虑查询消息的类层次结构，只关注精确匹配。

查询处理器链式调用

在某些场景下，可能需要在一个查询处理器中调用另一个查询来获取必要信息。

本地查询调用

当被调用的查询处理器位于同一应用中时：

• 可以使用QueryGateway或QueryBus进行调用
• 这种方式保持了组件间的松耦合
• 未来可以方便地将被调用处理器迁移到其他应用

潜在问题：

• 不同投影处理事件的进度可能不同步
• 可能导致数据不一致
• 在高并发场景下可能引发死锁

解决方案：

1. 避免链式调用，改为基于事件本地复制数据
2. 使用CompletableFuture实现异步链式调用
3. 配置localSegmentShortcut选项避免网络调用
4. 增加分布式查询总线的线程数

远程查询调用

在AxonFramework 4.11之前版本中，远程查询调用可能导致线程死锁。新版本通过使用独立线程池处理查询响应解决了这个问题。

查询处理器的返回类型

AxonFramework支持多种查询处理器返回类型，主要分为单实例和多实例两种情况。

单实例返回类型

当使用ResponseTypes.instanceOf(Class)指定响应类型时，支持以下返回类型：

• 与Class完全匹配的类型
• Class的子类型
• 绑定到Class的泛型
• Class的Future
• Class的基本类型
• Class的Optional

注意：对于基本类型返回值，查询方将收到装箱后的结果。

多实例返回类型

当使用ResponseTypes.multipleInstancesOf(Class)指定响应类型时，支持以下返回类型：

• 包含以下元素的数组：
  • Class
  • Class的子类型
  • 绑定到Class的泛型
• 包含以下元素的Iterable或其实现：
  • Class
  • Class的子类型
  • 绑定到Class的泛型
  • 绑定到Class的通配符
• Class的Stream
• Iterable<Class>的Future

不支持的返回类型

以下返回类型不受支持：

• 基本类型数组
• 特定键值类型的Map

最佳实践建议

1. 保持查询独立：尽量避免查询处理器间的依赖，确保每个投影包含处理查询所需的全部数据
2. 合理选择返回类型：根据查询需求选择最合适的返回类型结构
3. 注意线程安全：在链式调用场景下特别注意线程管理和死锁预防
4. 版本兼容性：在分布式环境中注意不同Axon版本对远程查询调用的处理差异

通过合理设计和实现查询处理器，可以构建出高效、可靠的查询系统，为CQRS架构提供强大的数据检索能力。

AxonFramework Framework for Evolutionary Message-Driven Microservices on the JVM 项目地址: https://gitcode.com/gh_mirrors/ax/AxonFramework