Spring Data Elasticsearch 中 Criteria 查询的正确使用方式

在使用 Spring Data Elasticsearch 进行文档查询时，Criteria API 是一个非常强大且灵活的工具。然而，如果不正确使用 Criteria 构建查询，可能会导致意外的 NullPointerException 或其他错误。本文将深入探讨 Criteria API 的正确使用方式，特别是处理否定查询和组合查询时的注意事项。

常见错误模式分析

许多开发者在使用 Criteria API 时容易犯以下两个典型错误：

1. 创建无意义的空 Criteria 对象：直接使用 new Criteria() 而不指定任何字段和条件，这样的 Criteria 对象在实际查询中没有任何作用。

2. 忽略方法返回值：and() 和 or() 方法会返回新的 Criteria 实例或修改后的 Criteria 实例，但开发者有时会忽略这一点，导致查询构建不完整。

正确的 Criteria 构建方式

基本查询构建

正确的 Criteria 查询应该从指定字段开始：

// 正确的方式：直接指定字段和条件
Criteria criteria = Criteria.where("subject.documentId").is(search.getDocumentId())
    .and("audit.deletedBy.id").not().exists();

这种方式清晰明了，直接链式调用构建完整的查询条件。

条件动态构建

在实际应用中，我们经常需要根据业务逻辑动态构建查询条件。正确的做法是：

Criteria criteria = new Criteria(); // 初始化为空条件

if (search.getDocumentId() != null) {
    criteria = criteria.and("subject.documentId").is(search.getDocumentId());
}

if (search.getDeleted() != null) {
    criteria = search.getDeleted() 
        ? criteria.and("audit.deletedBy.id").exists()
        : criteria.and("audit.deletedBy.id").not().exists();
}

虽然这里也使用了空 Criteria 初始化，但在动态构建场景下，这是可以接受的模式。

否定查询的注意事项

使用 .not() 进行否定查询时需要特别注意：

1. .not() 必须紧跟在字段指定之后，条件指定之前
2. 否定查询会创建特殊的查询结构，确保 Elasticsearch 能正确解析

// 正确否定查询
Criteria.where("audit.deletedBy.id").not().exists();

// 错误方式（会导致NPE）
Criteria criteria = new Criteria();
criteria.and(new Criteria("audit.deletedBy.id").not().exists());

组合查询的最佳实践

对于复杂的组合查询，建议：

1. 优先使用链式调用保持代码清晰
2. 对于特别复杂的查询，可以考虑拆分并最后组合
3. 使用适当的缩进和格式化提高可读性

// 复杂查询示例
Criteria criteria = Criteria.where("status").is("ACTIVE")
    .and(
        Criteria.where("createDate").gte(startDate)
            .or("updateDate").gte(startDate)
    )
    .and("department").in(departments);

总结

Spring Data Elasticsearch 的 Criteria API 提供了强大的查询构建能力，但需要遵循正确的使用模式。记住始终从具体字段开始构建查询，正确处理否定查询，并注意方法返回值。通过遵循这些最佳实践，可以避免常见的 NPE 错误，构建出高效可靠的 Elasticsearch 查询。