如何在Spring Data REST中构建RESTful查询语言

如果你正在开发基于Spring Data REST的Web应用，需要对实体字段做筛选查询，那QueryDslPredicateExecutor和QuerydslBinderCustomizer这两个组件绝对能帮你解决精确匹配过于严格的问题，实现更灵活的查询逻辑。

完整的仓库接口实现示例 #

下面是一个针对Person实体的仓库接口示例，整合了这两个核心组件：

@Repository
public interface PersonRepository extends JpaRepository<Person, Long>, 
                                        QueryDslPredicateExecutor<Person>, 
                                        QuerydslBinderCustomizer<QPerson> {

    @Override
    default void customize(QuerydslBindings bindings, QPerson personRoot) {
        // 给name字段设置忽略大小写的模糊匹配规则
        bindings.bind(personRoot.name).first((path, value) -> path.containsIgnoreCase(value));
        
        // 禁止前端通过id字段进行筛选
        bindings.excluding(personRoot.id);
        
        // 给age字段设置范围匹配逻辑，支持传入两个值作为区间上下限
        bindings.bind(personRoot.age).all((path, values) -> {
            Iterator<? extends Integer> iterator = values.iterator();
            return Optional.of(path.between(iterator.next(), iterator.next()));
        });
    }
}

关键组件作用解析 #

• QueryDslPredicateExecutor: 继承这个接口后，你的仓库会自动获得基于QueryDSL谓词的查询能力。Spring Data REST会自动把前端传入的查询参数转换成对应的Predicate，无需你手动编写复杂的JPQL或SQL语句。
• QuerydslBinderCustomizer: 这个接口专门用来解决默认精确匹配过于死板的问题。通过customize方法，你可以完全自定义参数与实体字段的绑定规则：
  • 给字符串字段添加模糊匹配、忽略大小写的逻辑
  • 排除某些敏感或不需要对外暴露的筛选字段
  • 实现范围查询、多值匹配等复杂的筛选规则

前端调用示例 #

配置完成后，前端可以通过简单的URL参数实现灵活查询：

• 查找名字包含"john"的用户：GET /persons?name=john
• 查找年龄在20到30之间的用户：GET /persons?age=20&age=30
• 组合筛选名字包含"john"且年龄为25的用户：GET /persons?name=john&age=25

内容的提问来源于stack exchange，提问作者Patrik Mihalčin