优化 GraphQL 查询 optimizing-graphql-queries

这些准则旨在帮助防止 GraphQL 查询出现性能问题。

GraphQL 清单 graphql-checklist

以下清单旨在帮助您优化 Adobe Experience Manager (AEM) as a Cloud Service 中的 GraphQL 的配置和使用。

第一准则 first-principles

使用持久 GraphQL 查询 use-persisted-graphql-queries

推荐

强烈建议使用持久 GraphQL 查询。

持久 GraphQL 查询借助内容分发网络 (CDN) 帮助降低查询执行性能。客户端应用程序通过 GET 请求来请求持久查询，以实现支持边缘的快速执行。

进一步的参考

请参阅：

缓存策略 cache-strategy

还可使用各种缓存方法来进行优化。

启用 AEM Dispatcher 缓存 enable-aem-dispatcher-caching

推荐

AEM Dispatcher 是 AEM 服务中的第一级缓存，位于 CDN 缓存之前。

进一步的参考

请参阅：

使用内容分发网络 (CDN) use-cdn

推荐

在使用 CDN 时，如果目标为 GET 请求，则可以缓存 GraphQL 查询及其 JSON 响应。相比之下，未缓存的请求可能耗费大量资源且处理速度慢，同时可能对来源的资源产生更多不利影响。

进一步的参考

请参阅：

设置 HTTP 缓存控制标头 set-http-cache-control-headers

推荐

在将持久 GraphQL 查询与 CDN 结合使用时，建议设置适当的 HTTP 缓存控制标头。

每个持久查询均能具有一组特定的缓存控制标头。可以通过 GraphQL API 或 AEM GraphiQL IDE 设置标头。

进一步的参考

请参阅：

使用 AEM GraphQL 预缓存 use-aem-graphql-pre-caching

推荐

此功能允许 AEM 进一步缓存 GraphQL 查询范围内的内容，然后将这些内容组合为 JSON 输出中的块，而不是逐行组合。

进一步的参考

联系 Adobe 为您的 AEM Cloud Service 程序和环境启用此功能。

GraphQL 查询优化 graphql-query-optimization

在具有大量共享同一模型的内容片段的 AEM 实例上，GraphQL 列表查询的成本可能会较高（就资源而言）。

这是因为​ 所有 ​共享将在 GraphQL 查询中使用的模型的片段都必须加载到内存中。这将消耗较多的时间和内存。只能在将整个结果集加载到内存中​ 后，再应用筛选（它可能会减少最终结果集中的项目数）。

这可能会给人留下一种印象，那就是，即使较小的结果集也会导致性能不佳。然而，实际上这种缓慢是由初始结果集的大小引起的，因为必须先内部处理此情况，之后才能应用筛选。

要减少性能和内存问题，必须使该初始结果集尽可能的小。

AEM 提供了两种方法来优化 GraphQL 查询：

每种方法都有自己的用例和限制。此部分提供有关混合筛选和分页的信息，以及一些用于优化 GraphQL 查询的最佳实践。

使用 AEM GraphQL 混合筛选 use-aem-graphql-hybrid-filtering

推荐

混合筛选结合了 JCR 筛选和 AEM 筛选。

它在将结果集加载到内存中以进行 AEM 筛选之前应用 JCR 筛选（采用查询约束的形式）。这是为了减少加载到内存中的结果集，因为 JCR 筛选会在此之前删除多余的结果。

此技术保留了 GraphQL 筛选提供的灵活性，同时将尽可能多的筛选工作委派给 JCR。

进一步的参考

请参阅：

使用 GraphQL 分页 use-aem-graphql-pagination

推荐

通过使用分页（一种 GraphQL 标准）将响应分段为多个块，可以缩短具有大型结果集的复杂查询的响应时间。

AEM 中的 GraphQL 支持两种类型的分页：

进一步的参考

请参阅：

使用 GraphQL 排序 use-graphql-sorting

推荐

排序也是一种 GraphQL 标准，可让客户端按排序顺序接收 JSON 内容。这可以减少客户端上进一步处理的需求。

仅在所有排序条件都与顶级片段相关时，排序才有效。

如果排序顺序包括某个嵌套片段上的一个或多个字段，则必须将所有共享顶级模型的片段加载到内存中。这会对性能产生负面影响。

进一步的参考

请参阅：

最佳实践 best-practices

所有优化推荐的主要目标是减小初始结果集。此处列出的最佳实践提供了多种方法来实现此目的。可以（也应该）将它们结合使用。

仅筛选顶级属性 filter-top-level-properties-only

目前，JCR 级别的筛选仅适用于顶级片段。

如果筛选处理嵌套片段的字段，则 AEM 必须回退以将所有共享基础模型的片段加载到内存中。

您仍可以使用 AND 运算符将顶级片段字段上的筛选表达式和嵌套片段字段上的筛选表达式组合起来，从而优化此类 GraphQL 查询。

使用内容结构 use-content-structure

在 AEM 中，通常考虑的最佳实践是，使用存储库结构来缩小要处理的内容范围。

此方法也将应用于 GraphQL 查询。

这可以通过在顶级片段的 _path 字段上应用筛选来完成：

{
  someList(filter: {
    _path: {
      _expressions: [
        {
          value: "/content/dam/some/sub/path/",
          _operator: STARTS_WITH
        }
      ]
    }
  }) {
    items {
      # ...
    }
  }
}

使用分页 use-paging

您还可以使用分页来减小初始结果集；特别是在您的请求不使用任何筛选和排序的情况下。

如果您对嵌套片段进行筛选或排序，分页查询可能仍然很慢，因为 AEM 可能仍需要将大量片段加载到内存中。因此，如果将筛选和分页结合使用，请考虑筛选规则（如上所述）。

对于分页，排序同样重要，因为分页的结果始终是已排序的 - 无论是通过显式还是隐式方式。

如果您主要只对检索前几页感兴趣，则使用 ...List 或 ...Paginated 查询之间没有显著区别。不过，如果您的应用程序不只是想阅读一两页，则应考虑 ...Paginated 查询，因为此查询在阅读后续页面时的性能更佳。

筛选表达式中的逻辑运算 logical-operations-in-filter-expressions

如果在嵌套片段上进行筛选，则仍可以通过提供使用 AND 运算符的顶级字段的附加筛选来利用 JCR 筛选。

一个典型用例是，对顶级片段的 _path 字段使用筛选器来限制查询的范围，然后筛选可能位于顶级或嵌套片段上的其他字段。

在此示例中，将使用 AND 组合不同的筛选表达式。因此，对 _path 进行筛选可以有效地限制初始结果集的大小。对顶级字段进行的所有其他筛选也可以帮助减小初始结果集 - 前提是使用 AND 将它们组合使用。

如果涉及嵌套的片段，则无法优化使用 OR 组合使用的筛选表达式。仅在​ 不 ​涉及嵌套片段的情况下，可以优化 OR 表达式。

避免筛选多行文本字段 avoid-filtering-multiline-textfields

无法通过 JCR 查询筛选多行文本字段的字段（html、markdown、plaintext、json），因为必须即时计算这些字段的内容。

如果您仍需要筛选多行文本字段，请考虑通过添加额外的筛选表达式来限制初始结果集的大小，并使用 AND 将它们组合使用。通过筛选 _path 字段来限制范围也是一个好方法。

避免筛选虚拟字段 avoid-filtering-virtual-fields

虚拟字段（大多数字段以 _ 开始）是在执行 GraphQL 查询时计算的，因此不在基于 JCR 的筛选的范围内。

一个重要的例外是 _path 字段，可使用该字段有效地减小初始结果集 - 如果相应地构建了内容（请参阅使用内容结构）。

筛选：排除 filtering-exclusions

还存在几种无法在 JCR 级别计算筛选表达式的情况（因此，应避免这些情况以实现最佳性能）：

最小化内容片段嵌套 minimize-content-fragment-nesting

嵌套内容片段是对自定义内容结构进行建模的绝佳方法。您甚至可以有一个带嵌套片段的片段，该片段也有一个嵌套片段，有…以此类推。

不过，创建具有过多级别的结构可能会增加 GraphQL 查询的处理时间，因为 GraphQL 必须遍历所有嵌套内容片段的整个层次结构。

深度嵌套也会对内容监管产生不利影响。通常，建议将内容片段嵌套限制在五个层次或六个层次以下。

请勿输出所有格式（多行文本元素） do-not-output-all-formats

AEM GraphQL 可以返回采用多种格式创作的​ 多行文本 ​数据类型的文本：富文本、简单文本和 Markdown。

输出所有三种格式将使 JSON 中的文本输出大小增加三倍。加之一系列非常广泛的查询所产生的通常较大的结果集，这可能会产生非常大的 JSON 响应，因而需花费大量时间来计算。最好是将输出限制为仅呈现内容所需的文本格式。

修改内容片段 modifying-content-fragments

仅使用 AEM UI 或 API 修改内容片段及其资源。请勿直接在 JCR 中进行修改。

测试您的查询 test-your-queries

处理 GraphQL 查询与处理搜索查询类似，并且比简单 GET-all-content API 请求要复杂得多。

在受控的非生产环境中仔细规划、测试和优化查询对于以后在生产中使用时取得成功非常重要。