25

问题。如何避免使用 Spring Data REST 进行 n+1 查询?

背景。在查询 Spring Data REST 以获取资源列表时,每个生成的顶级资源都具有指向关联资源的链接,而不是将关联资源直接嵌入顶级资源中。例如,如果我查询数据中心列表,相关区域会显示为链接,如下所示:

{
  "links" : [ {
    "rel" : "self",
    "href" : "http://localhost:2112/api/datacenters/1"
  }, {
    "rel" : "datacenters.DataCenter.region",
    "href" : "http://localhost:2112/api/datacenters/1/region"
  } ],
  "name" : "US East 1a",
  "key" : "amazon-us-east-1a"
}

然而,想要获得相关信息而不需要进行 n+1 次查询是非常典型的。为了坚持上面的例子,我可能想在 UI 中显示数据中心及其相关区域的列表。

我试过的。我在 my 上创建了一个自定义查询,RegionRepository以获取给定数据中心键集的所有区域:

@RestResource(path = "find-by-data-center-key-in")
Page<Region> findByDataCentersKeyIn(
    @Param("key") Collection<String> keys,
    Pageable pageable);

不幸的是,此查询生成的链接不会与上述数据中心查询生成的链接重叠。以下是我为自定义查询获得的链接:

http://localhost:2112/api/regions/search/find-by-data-center-key-in?key=amazon-us-east-1a&key=amazon-us-east-1b

{
  "links" : [ ],
  "content" : [ {
    "links" : [ {
      "rel" : "self",
      "href" : "http://localhost:2112/api/regions/1"
    }, {
      "rel" : "regions.Region.datacenters",
      "href" : "http://localhost:2112/api/regions/1/datacenters"
    }, {
      "rel" : "regions.Region.infrastructureprovider",
      "href" : "http://localhost:2112/api/regions/1/infrastructureprovider"
    } ],
    "name" : "US East (N. Virginia)",
    "key" : "amazon-us-east-1"
  }, {
    "links" : [ {
      "rel" : "self",
      "href" : "http://localhost:2112/api/regions/1"
    }, {
      "rel" : "regions.Region.datacenters",
      "href" : "http://localhost:2112/api/regions/1/datacenters"
    }, {
      "rel" : "regions.Region.infrastructureprovider",
      "href" : "http://localhost:2112/api/regions/1/infrastructureprovider"
    } ],
    "name" : "US East (N. Virginia)",
    "key" : "amazon-us-east-1"
  } ],
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 1
  }
}

挑战似乎在于,一旦您已经了解了数据的形状,数据中心查询返回的链接并不是特别有用。例如,我已经知道数据中心 1 的区域位于/datacenters/1/region,所以如果我想了解涉及哪个特定区域的实际信息,我必须点击链接获取。特别是,我必须按照链接获取显示在批量查询中的规范 URI,这将允许我避免 n+1 查询。

4

2 回答 2

23

Spring Data REST 像这样工作的原因如下:默认情况下,我们假设每个应用程序存储库都是 REST 服务的主要资源。因此,如果您公开实体相关对象的存储库,您将获得呈现给它的链接,并且我们通过嵌套资源(例如foo/{id}/bar)公开一个实体对另一个实体的分配。

为了防止这种情况,请注释相关的存储库接口,@RestResource(exported = false)以防止该存储库管理的实体成为顶级资源。

更通用的方法是从 Spring Data REST 开始,让您公开要管理的资源和应用的默认规则。然后,您可以通过实现ResourceProcessor<T>并将您的实现注册为 Spring bean 来自定义呈现和链接。然后ResourceProcessor将允许您自定义呈现的数据、添加到表示的链接等。

对于其他一切,手动实现控制器(可能混合到默认控制器的 URI 空间中)并通过ResourceProcessor实现添加指向这些控制器的链接。在Spring RESTBucks示例中可以看到一个示例。示例项目使用 Spring Data REST 来管理 Order 实例并实现自定义控制器来实现更复杂的支付流程。除此之外,它还添加了一个指向 Order 资源的链接,以指向手动实现的代码。

于 2013-04-09T12:42:13.510 回答
8

如果在 Jackson ObjectMapper 中配置的序列化程序是通过看到 a 触发的,Spring Data REST 只会创建您描述的表示,这是Spring Data REST 中使用PersistentEntityResource的一种特殊类型。Resource

如果您创建 aResourceProcessor<Resource<MyPojo>>并返回 a new Resource<MyPojo>(origResource.getContent(), origResource.getLinks()),则不会触发默认的 Spring Data REST 序列化机制,并且将应用 Jackson 的正常序列化规则。

但是请注意,Spring Data REST 以它的方式进行关联的原因是因为在序列化为 JSON 时很难随意停止遍历对象图。通过以它的方式处理关联,它保证了序列化器不会开始遍历 N 级深度的对象图,并且在性能和表示的性能上变得更慢。

确保 Jackson 不尝试序列化 a PersistentEntityResource,这是它在默认配置中所做的,将确保不会触发任何 Spring Data REST 关联处理。当然,不利的一面是 Spring Data REST 的任何助手都不会被触发。如果您仍然想要相关资源的链接,则必须确保自己创建这些链接并将它们添加到传出的 plain Resource

于 2013-04-10T13:22:31.093 回答