• 声明式查询服务,只需定义,无需实现


    1. 概览

    在日常开发中,数据查询是最为常见的需求,也是占比最大的一部分。为了降低成本提升开发效率,已经封装了两个组件:

    1. 将 QueryObject 与 Spring Data Jpa 进行集成,无需编写实现代码,只需通过注解定义查询对象,并能完成单表的普通查询、列表查询、分页查询等;
    2. 内存 Join 组件,通过注解对关联对象进行标记,框架自动完成数据的抓取,也无需编写实现代码;

    两个组件,基本都能做到只“声明能力”,不“编写代码”,提升开发效率的同时,降低了bug概率。但,在两者结合使用时,就需要编写实现代码,将能力粘合起来。

    1.1. 背景

    在日常开发中,一个查询请求主要由以下几部分组成:

    1. 验证入参的有效性;
    2. 查询数据库获得主实体数据;
    3. 查询关联数据并完成结果的组装;

    在lego框架中,三个步骤都提供了相应的组件进行支持,以一个订单分页查询为例:

    1. 主流程代码如下:
    1. public Page<OrderDetail> pageByUserId(@Valid @NotNull(message = "查询参数不能为 null") PageByUserId query) {
    2.     Page<OrderDetail> orderDetailPage = this.orderQueryRepository.pageOf(query, OrderDetail::new);
    3.     if (orderDetailPage.hasContent()){
    4.         this.joinService.joinInMemory(orderDetailPage.getContent());
    5.     }
    6.     return orderDetailPage;
    7. }
    1. 查询参数定义如下:
    1. @Data
    2. public class PageByUserId {
    3.     @NotNull(message = "user id 不能为 null")
    4.     @FieldEqualTo("userId")
    5.     private Long userId;
    6.     private Pageable pageable;
    7. }
    1. 返回结果如下:
    1. @Data
    2. public class OrderDetail {
    3.     private Order order;
    4.     @JoinItemByOrder(keyFromSourceData = "#{order.id}")
    5.     private List<OrderItem> orderItems;
    6.     public OrderDetail(Order order){
    7.         this.order = order;
    8.     }
    9. }

    查询三大步骤均基于“声明式注解”通过描述的方式进行实现,然后通过 编码 的方式完成主流程。

    仔细观察主流程,会发现这是一套标准的“模板代码”,重复枯燥、没有业务价值,像这样有规律的“重复”代码,就应交由框架实现。

    1.2. 目标

    构建声明式 QueryService,只需定义方法,无需编写实现代码,便能完成大多数场景的数据查询。

    组件应具有如下特性:

    1. 只定义接口,由框架负责具体实现;
    2. 保留参数校验、单表查询和内存join等全套能力;
    3. 对于个性化需求,提供扩展点,可通过 coding 方式实现;
    4. 启动时进行有效性校验,避免运行时异常;

    2. 快速入门

    设计目标与 Spring Data 的设计理念高度相似,QueryService 组件在实现上进行了借鉴,在使用上也与 Spring Data 保存一致,以降低使用门槛。

  • 相关阅读:
    分别判断数组A的每个元素是否在数组B中:isin()方法
    Redis实战之缓存:查询、添加缓存、更新缓存、缓存预热、缓存穿透、缓存雪崩、缓存击穿 解决方案及实例代码
    2024年06月IDE流行度最新排名
    如何截取视频中的一段视频?分享几种视频分割方法
    论文浅尝 | Temporal Knowledge Graph Completion Using Box Embeddings
    CSS3 2D转换-位移与旋转
    【视频教程】基于Fragstats的土地利用景观格局分析应用
    【Docker项目实战】使用Docker部署HFish蜜罐系统
    静态变量及静态方法讲解
    [A-04] ARMv8/ARMv9-Cache的相关策略
  • 原文地址:https://blog.csdn.net/m0_74931226/article/details/127934442