17370845950

Corda Vault 查询中的 PageSpecification

在 Corda 中使用 queryBy() 方法进行 Vault 查询时,PageSpecification 的作用在于控制返回结果的分页行为。正如摘要所述,理解何时需要显式指定 PageSpecification 至关重要,可以避免不必要的复杂性并优化查询效率。

PageSpecification 的作用

PageSpecification 允许你控制查询结果的分页。它定义了页面大小和页面编号,从而允许你逐步获取大量查询结果。如果查询结果集的大小超过默认页面大小(200),则需要使用 PageSpecification 来访问后续页面。

何时需要 PageSpecification?

简而言之,PageSpecification 仅在以下情况需要:

  • 查询结果集大于默认页面大小 (200)。 如果你的查询预计返回超过 200 条记录,则需要使用 PageSpecification 来分页获取所有结果。

示例说明

假设你有一个 CarState,并且你想根据 uniqueID 查询特定的 CarState。Vault 中可能存在 1000 个 CarState 实例,但只有一个 CarState 具有你指定的 uniqueID。在这种情况下,即使 Vault 中存在大量 CarState,你也不需要 PageSpecification,因为最终查询结果只包含一个 CarState。

// 假设 uniqueID 是 CarState 的一个属性
val criteria = QueryCriteria.VaultCustomQueryCriteria(
    expression = Builder.equal(CarState::uniqueID, "your_unique_id")
)

val results = serviceHub.vaultService.queryBy(criteria)

// results.states 将只包含一个 CarState,无需 PageSpecification
println("找到的 CarState 数量: ${results.states.size}")

另一方面,如果你想获取所有 CarState,并且 Vault 中存在超过 200 个 CarState,那么你需要使用 PageSpecification。

val pageSpec = PageSpecification(DEFAULT_PAGE_NUM = 1, PAGE_SIZE = 100) // 例如,每页 100 条记录

var currentPage = 1
var allCarStates = mutableListOf>()

do {
    val results = serviceHub.vaultService.queryBy(
        criteria = QueryCriteria.VaultQueryCriteria(), // 获取所有 CarState
        paging = PageSpecification(currentPage, 100)
    )

    allCarStates.addAll(results.states)
    currentPage++
} while (results.totalStatesAvailable > allCarStates.size)

println("总共找到的 CarState 数量: ${allCarStates.size}")

注意事项

  • 即使 Vault 中存在大量特定类型的状态,如果你的查询条件非常严格,并且预计只返回少量结果,则无需使用 PageSpecification。
  • PageSpecification 主要用于处理大量查询结果的分页,以避免一次性加载所有数据导致性能问题。
  • Corda Vault 查询最终会被转换为 SQL 查询并在数据库上执行。分页机制仅在 SQL 查询返回的结果集大于页面大小时才起作用。

总结

理解 PageSpecification 的作用及其使用场景对于编写高效的 Corda Vault 查询至关重要。只有在查询结果集可能超过默认页面大小时,才需要显式指定 PageSpecification。否则,可以避免不必要的复杂性,并简化查询逻辑。 通过合理利用 PageSpecification,你可以更有效地管理 Corda 应用程序中的数据查询,并优化性能。