如何使用 Headless 应用程序上线

在这部分中 AEM Headless开发人员历程，了解如何实时部署Headless应用程序。

迄今为止的故事

在 AEM Headless 历程的上一个文档如何通过 AEM Assets API 更新您的内容中，您已了解如何通过 API 在 AEM 中更新现有 Headless 内容，您现在应该：

  • 了解 AEM Assets HTTP API。

本文基于这些基础知识编写，以便您了解如何准备您自己的 AEM Headless 项目以上线。

目标

本文档可帮助您了解 AEM Headless 发布管道，以及在通过您的应用程序上线之前必须了解的性能注意事项。

  • 了解AEM SDK和所需的开发工具
  • 设置本地开发运行时以在内容上线之前模拟内容
  • 了解AEM内容复制和缓存基础知识
  • 在启动前保护和扩展您的应用程序
  • 监控性能和调试问题

AEM SDK

AEM SDK 用于构建和部署自定义代码。它是您在启用Headless应用程序之前必须开发和测试的主要工具。 它包含以下构件：

  • 快速入门 jar – 可用于设置创作和发布实例的可执行的 jar 文件
  • Dispatcher工具 — 适用于Windows和基于UNIX的系统的Dispatcher模块及其依赖项
  • Java™ API Jar – Java™ Jar/Maven 依赖项，公开了所有允许的 Java™ API，它们可用于针对 AEM 进行开发
  • Javadoc jar – Java™ API jar 的 javadoc

其他开发工具

除了AEM SDK之外，您还需要其他工具来帮助您在本地开发和测试代码和内容：

  • Java™
  • Git
  • Apache Maven
  • Node.js 库
  • 您选择的 IDE

由于AEM是一种Java™应用程序，因此您必须安装Java™和Java™ SDK才能支持AEMas a Cloud Service的开发。

Git 可用于管理源代码管理和签入对 Cloud Manager 的更改，然后将它们部署到生产实例。

AEM 使用 Apache Maven 构建从 AEM Maven 项目原型生成的项目。所有主要 IDE 都提供对 Maven 的集成支持。

Node.js是用于处理AEM项目的前端资源的JavaScript运行时环境 ui.frontend 子项目。 Node.js随npm分发，后者是实际的Node.js包管理器，用于管理JavaScript依赖项。

AEM 系统组件概览

接下来，让我们看看 AEM 环境的组成部分。

完整的 AEM 环境由创作、发布和 Dispatcher 构成。这些相同的组件在本地开发运行时中可用，使您能够更轻松地在上线之前预览代码和内容。

  • Author 服务​是内部用户创建、管理和预览内容的地方。

  • Publish服务 被认为是“实时”环境，通常是最终用户与之交互的对象。 在Author服务上编辑和批准后的内容将分发（复制）到Publish服务。 AEM Headless 应用程序最常见的部署模式是将应用程序的生产版本连接到 AEM Publish 服务。

  • Dispatcher 是一个通过 AEM Dispatcher 模块增强的静态 Web 服务器。它缓存由发布实例生成的网页以提高性能。

本地开发工作流

本地开发项目基于 Apache Maven 构建，并使用 Git 进行源代码管理。要更新项目，开发人员可以使用他们首选的集成开发环境，如Eclipse、Visual Studio Code或IntelliJ等。

要测试Headless应用程序摄取的代码或内容更新，请将更新部署到本地AEM运行时。 其中包括AEM创作和发布服务的本地实例。

请务必记下本地 AEM 运行时中每个组件之间的区别，因为在更新最起作用的位置测试更新是非常重要的。例如，在创作实例上测试内容更新或在发布实例上测试新代码。

在生产系统中，Dispatcher 和 http Apache 服务器将始终位于 AEM 发布实例的前面。它们为 AEM 系统提供缓存和安全服务，因此，针对 Dispatcher 测试代码和内容更新也至为重要。

使用本地开发环境在本地预览您的代码和内容

要准备AEM Headless项目以进行启动，请确保项目的所有组成部分都正常运行。

为此，您必须将所有内容（代码、内容和配置）放在一起，并在本地开发环境中测试它是否为上线做好准备。

本地开发环境由三个主要领域组成：

  1. AEM项目 — 包含AEM开发人员将处理的所有自定义代码、配置和内容
  2. 本地 AEM 运行时 – 本地版本的 AEM 创作和发布服务，用于从 AEM 项目部署代码
  3. 本地 Dispatcher 运行时 – 包含 Dispatcher 模块的 Apache httpd Web 服务器的本地版本

设置本地开发环境后，您可以通过本地部署静态Node服务器来模拟为React应用程序提供内容服务。

要更深入地了解设置本地开发环境和内容预览所需的所有依赖项，请参阅 生产部署文档.

准备AEM Headless应用程序上线

现在，您可以按照下面概述的最佳实践，让AEM Headless应用程序做好启动准备。

在启动之前保护Headless应用程序的安全

  1. 准备 身份验证 (对于您的GraphQL请求)

模型结构与 GraphQL 输出

  • 避免创建输出超过15 KB JSON（gzip压缩）的查询。 长 JSON 文件是客户端应用程序要分析的资源密集型文件。
  • 避免超过五个嵌套级别的片段层级。其他级别会使内容作者难以考虑其更改产生的影响。
  • 使用多对象查询而不是在模型中使用依赖项层级对查询进行建模。这样做可以提供更大的长期灵活性，以便在不进行任何内容更改的情况下重新构建JSON输出。

最大程度地提高 CDN 缓存命中率

  • 不要使用直接 GraphQL 查询，除非您从表面请求实时内容。
    • 尽可能使用持久查询。
    • 提供600秒以上的CDN TTL，以便CDN可以缓存它们。
    • AEM 可以计算模型更改对现有查询的影响。
  • 在低内容更改率和高内容更改率之间拆分JSON文件/GraphQL查询，以减少到CDN的客户端流量并分配更高的TTL。 这样做可最大限度地减少CDN使用原始服务器重新验证JSON的次数。
  • 要使CDN中的内容失效，请使用软清除。 这样做可让CDN重新下载内容而不会导致缓存丢失。
注意

参见 其他资源 有关CDN和缓存的更多信息。

缩短下载 Headless 内容的时间

  • 确保 HTTP 客户端使用 HTTP/2。
  • 确保 HTTP 客户端接受 gzip 的标头请求。
  • 最大程度地减少用于托管 JSON 的域和引用的构件的数量。
  • 使用 Last-modified-since 以刷新资源。
  • 使用 JSON 文件中的 _reference 输出开始下载资产，而无需分析完整的 JSON 文件。

部署到生产

部署到生产环境取决于您是否拥有 传统 使用Maven部署的AEM实例，或者位于Adobe Managed Services (AMS)上并因此使用Cloud Manager的实例。

使用Maven部署到生产环境

对于 传统 使用Maven部署（非AMS），请参阅 wknd教程 了解概述。

使用Cloud Manager部署到生产

如果您是使用Cloud Manager的AMS客户，在确保一切经过测试并正常工作后，您可以将代码更新推送到 Cloud Manager中的集中式Git存储库.

将更新上传到Cloud Manager后，使用将它们部署到AEM Cloud Manager的CI/CD管道.

性能监控

要让用户在使用 AEM Headless 应用程序时获得最佳体验，请务必监控关键性能指标，详情如下：

  • 验证应用程序的预览版和生产版
  • 验证当前服务可用性状态的 AEM 状态页面
  • 访问性能报告
    • 交付性能
      • 源服务器 – 调用次数、错误率、CPU 负载、负载流量
    • 创作性能
      • 检查用户、请求和加载的数量
  • 访问特定于应用程序和空间的性能报表
    • 在服务器启动后，检查一般指标是否为绿色/橙色/红色，然后识别具体的应用程序问题
    • 打开上面过滤到应用程序或空间的相同报告（例如，Photoshop 桌面、付费专区）
    • 使用 Splunk 日志 API 访问服务和应用程序性能
    • 如果还有其他问题，请联系客户支持。

疑难解答

调试

将这些最佳实践用作常规调试方法：

  • 使用应用程序的预览版本验证功能和性能
  • 使用应用程序的生产版本验证功能和性能
  • 使用内容片段编辑器的 JSON 预览版进行验证
  • 要检查是否存在客户端应用程序或投放问题，请在客户端应用程序中检查JSON
  • 要检查是否存在与缓存内容或AEM相关的问题，请使用GraphQL检查JSON

借助支持记录错误

要在支持团队中高效记录错误，并在您需要进一步帮助时完成以下步骤：

  • 如有必要，可拍摄问题屏幕快照
  • 记录重现问题的方法
  • 记录问题重现的内容
  • 通过 AEM 支持门户以适当的优先级记录问题

历程结束 - 是吗？

恭喜！您已完成 AEM Headless 开发人员历程！您现在应了解以下内容：

  • Headless 和 Headful 内容交付之间的区别。
  • AEM 的 Headless 功能。
  • 如何编排 AEM Headless 项目。
  • 如何在 AEM 中创建 Headless 内容。
  • 如何在 AEM 中检索和更新 Headless 内容。
  • 如何使用 AEM Headless 项目上线。
  • 上线完成后该做什么。

您已启动您的第一个AEM Headless项目，或者现在已具备执行此项目所需的全部知识。 做得好！

探究单页应用程序

不过，没有必要停止AEM中的Headless商店。 在 历程的“快速入门”部分同时，还讨论了AEM如何支持headless投放和传统的全栈模型，并支持将这两种模型的优点结合起来的混合模型。

如果这种灵活性是项目所需的功能，请继续历程的可选附加部分， 如何使用AEM创建单页应用程序(SPA)。

其他资源

在此页面上