ヘッドレスアプリケーションの運用開始方法

AEM ヘッドレスデベロッパージャーニーのこの部分では、ヘッドレスアプリケーションを実稼働環境にデプロイする方法を説明します。

これまでの説明内容

AEM ヘッドレスジャーニーの前のドキュメント AEM Assets API を使用してコンテンツを更新する方法では、API を使用して AEM の既存のヘッドレスコンテンツを更新する方法を説明し、以下を達成できました。

AEM Assets HTTP API を理解する

この記事は、これらの基本事項に基づいているので、独自の AEM ヘッドレスプロジェクトの運用開始準備をする方法を理解できます。

目的

このドキュメントは、AEM ヘッドレス公開パイプラインと、アプリケーションの運用を開始する前に認識しておく必要があるパフォーマンスに関する考慮事項を理解するうえで役に立ちます。

AEM SDK と必要な開発ツールの把握
運用開始前にコンテンツをシミュレートするためのローカル開発ランタイムのセットアップ
AEM のコンテンツのレプリケーションとキャッシュに関する基本事項の理解
ローンチ前のアプリケーションのセキュリティ確保とスケーリング
パフォーマンスとデバッグの問題の監視

AEM SDK

AEM SDK は、カスタムコードのビルドとデプロイに使用されます。運用を開始する前にヘッドレスアプリケーションを開発し、テストする必要があるのは、主なツールです。次のアーティファクトで構成されます。

クイックスタート JAR - オーサーインスタンスとパブリッシュインスタンスの両方をセットアップするために使用できる実行可能な JAR ファイル
Dispatcher ツール — Windows および UNIX ベースのシステム用の Dispatcher モジュールとその依存関係
Java™ API JAR - AEM に対応した開発に使用できる、許可されたすべての Java™ API を公開する Java™ JAR／Maven 依存関係
Javadoc JAR - Java™ API JAR の Javadoc

その他の開発ツール

AEM SDK に加えて、コードとコンテンツをローカルで開発およびテストするための追加のツールが必要です。

Java™
Git
Apache Maven
Node.js ライブラリ
任意の IDE

AEMは Java™アプリケーションなので、AEM as a Cloud Serviceの開発をサポートするために、Java™と Java™ SDK をインストールする必要があります。

Git は、ソースコントロールの管理、Cloud Manager への変更内容のチェックイン、さらにそれらを実稼動インスタンスにデプロイするために使用します。

AEM Maven プロジェクトアーキタイプから生成されたプロジェクトをビルドするために、AEM では Apache Maven を使用します。主要な IDE はすべて Maven との統合をサポートしています。

Node.js は、AEMプロジェクトの ui.frontend サブプロジェクト。 Node.js は、JavaScript の依存関係の管理に使用される事実上の Node.js Package Manager である npm と共に配布されます。

AEM システムのコンポーネントの概要

次に、AEM 環境の構成要素を見てみましょう。

完全な AEM 環境は、オーサー、パブリッシュ、Dispatcher で構成されます。ローカル開発ランタイムでも、同じコンポーネントを使用できるようになり、運用を開始する前にコードとコンテンツを簡単にプレビューできます。

オーサーサービスでは、内部ユーザーがコンテンツの作成、管理、プレビューを行います。
パブリッシュサービス は「ライブ」環境と見なされ、通常はエンドユーザーがやり取りする環境です。コンテンツは、オーサーサービスで編集および承認された後、パブリッシュサービスに配信（レプリケート）されます。AEM ヘッドレスアプリケーションで最も一般的なデプロイメントパターンは、実稼動版のアプリケーションを AEM パブリッシュサービスに接続させることです。
Dispatcher は、AEM Dispatcher モジュールで拡張された静的 web サーバーです。パブリッシュインスタンスで生成された Web ページをキャッシュしてパフォーマンスを向上します。

ローカル開発ワークフロー

ローカル開発プロジェクトは Apache Maven をベースに構築され、ソース管理に Git を使用します。プロジェクトを更新するために、開発者は、Eclipse、Visual Studio Code、IntelliJ など、望ましい統合開発環境を使用できます。

ヘッドレスアプリケーションで取り込まれるコードやコンテンツの更新をテストするには、更新をローカルのAEMランタイムにデプロイします。これには、AEMオーサーサービスとパブリッシュサービスのローカルインスタンスが含まれます。

アップデートが最も重要な場所でアップデートをテストすることが大切なので、ローカル AEM ランタイムの各コンポーネントの違いに注意してください。例えば、オーサーインスタンスでコンテンツのアップデートをテストしたり、パブリッシュインスタンスで新しいコードをテストしたりします。

実稼動システムでは、Dispatcher と HTTP Apache サーバーは常に AEM パブリッシュインスタンスの前に配置されます。これらは AEM システムのキャッシュサービスとセキュリティサービスを提供するので、Dispatcher に対してもコードとコンテンツのアップデートをテストすることが最も重要です。

ローカル開発環境でのコードとコンテンツのローカルプレビュー

AEMヘッドレスプロジェクトを起動用に準備するには、プロジェクトのすべての構成要素が正常に機能していることを確認します。

それには、すべてをまとめる必要があります。コード、コンテンツ、設定を実行し、運用開始準備のローカル開発環境でテストします。

ローカル開発環境は、次の 3 つの主な領域で構成されます。

AEMプロジェクト — AEM開発者が作業するすべてのカスタムコード、設定およびコンテンツが含まれます
ローカル AEM ランタイム - AEM プロジェクトからコードをデプロイする際に使用される、AEM オーサーサービスおよびパブリッシュサービスのローカルバージョン
ローカル Dispatcher ランタイム - Dispatcher モジュールを含んだ Apache httpd Web サーバーのローカルバージョン。

ローカル開発環境を設定した後、静的な Node サーバーをローカルにデプロイすることで、React アプリに対するコンテンツ提供をシミュレートできます。

コンテンツのプレビューに必要なローカル開発環境とすべての依存関係の設定について詳しくは、実稼動デプロイメントドキュメント.

AEM ヘッドレスアプリケーションの運用開始準備

それではいよいよ、以下に示すベストプラクティスに従って、AEM ヘッドレスアプリケーションのローンチの準備を行います。

ローンチ前にヘッドレスアプリケーションのセキュリティを確保

GraphQL リクエストの認証を準備

モデル構造と GraphQL 出力

15 KB を超える JSON（gzip 圧縮）を出力するクエリは作成しないでください。長い JSON ファイルの場合、クライアントアプリケーションで解析する際に大量のリソースを消費します。
フラグメント階層のネストレベルは 5 以内にします。レベルを増やすと、コンテンツ作成者は変更の影響を考慮しにくくなります。
モデル内の依存関係階層を使用したクエリをモデル化するのではなく、複数オブジェクトクエリを使用します。これにより、多くのコンテンツ変更をおこなうことなく、JSON 出力を再構築する柔軟性が長期的に高まります。

CDN キャッシュヒット率の最大化

サーフェスからライブコンテンツをリクエストする場合を除き、直接の GraphQL クエリは使用しません。
- 可能な限り、永続的クエリを使用します。
- CDN がキャッシュできるよう、CDN の TTL 値を 600 秒を超えて指定します。
- AEM は既存のクエリに対するモデル変更の影響を計算できます。
JSON ファイル/GraphQLクエリをコンテンツの変更率の低いものと高いものに分割して、CDN へのクライアントトラフィックを減らし、より高い TTL を割り当てます。これにより、元のサーバーで JSON を再検証する CDN を最小限に抑えることができます。
CDN からコンテンツをアクティブに無効にするには、ソフトパージを使用します。これにより、CDN は、キャッシュミスを引き起こすことなく、コンテンツを再ダウンロードできます。

メモ

CDN とキャッシングについて詳しくは、その他のリソースを参照してください。

ヘッドレスコンテンツのダウンロード時間の短縮

HTTP クライアントで必ず HTTP/2 を使用します。
HTTP クライアントで gzip に対するリクエストには必ず Accept ヘッダーを付けます。
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 ヘッドレスアプリケーションの使用時に最高のユーザーエクスペリエンスを得るには、以下に説明するように、主要パフォーマンス指標を監視することが重要です。

アプリのプレビューバージョンと実稼動バージョンの動作を検証する
AEM ステータスページで現在のサービス稼働状況を確認する
パフォーマンスレポートにアクセスする
- 配信のパフォーマンス
  - オリジンサーバー - 呼び出し数、エラー率、CPU 負荷、ペイロードトラフィックを確認する
- オーサーのパフォーマンス
  - ユーザー数、リクエスト数および読み込み数の確認
アプリおよびスペース固有のパフォーマンスレポートにアクセスする
- サーバーが起動したら、一般的な指標が緑／オレンジ／赤のどれになっているかを確認し、アプリの具体的な問題を特定する
- 特定のアプリやスペース（例：Photoshop デスクトップ、ペイウォール）に限定した上記レポートを開く
- Splunk ログ API を使用してサービスやアプリケーションのパフォーマンスにアクセスする
- その他の問題が発生した場合は、カスタマーサポートに連絡する

トラブルシューティング

デバッグ

デバッグに対する一般的なアプローチとして、次のベストプラクティスに従います。

アプリケーションのプレビューバージョンで機能とパフォーマンスを検証する
アプリケーションの実稼動バージョンで機能とパフォーマンスを検証する
コンテンツフラグメントエディターの JSON プレビューを使用して検証する
クライアントアプリケーションまたは配信の問題があるかどうかを確認するには、クライアントアプリケーションで JSON を調べます。
キャッシュされたコンテンツまたはAEMに関する問題がないかを確認するには、GraphQLを使用して JSON を調べます。

サポートへのバグの登録

サポートが必要な場合に備えて、サポートにバグを効率的に記録するには、次の手順を実行します。

必要に応じて、問題のスクリーンショットを撮る
問題の再現方法を説明する
問題が再現するコンテンツを説明する
AEM サポートポータルを通じて問題を適切な優先度で登録する

ジャーニーの完了

おめでとうございます。AEM ヘッドレスデベロッパージャーニーが完了し、以下を理解できました。

ヘッドレスコンテンツ配信とヘッドフルコンテンツ配信の違い
AEM のヘッドレス機能
AEM ヘッドレスプロジェクトを編成する方法
AEM でヘッドレスコンテンツを作成する方法
AEM でヘッドレスコンテンツを取得および更新する方法
AEM ヘッドレスプロジェクトの運用を開始する方法
運用開始後の作業。

最初のAEMヘッドレスプロジェクトを既に開始しているか、既に開始している知識がある。お疲れ様でした。

単一ページアプリケーションの調査

ただし、AEMのヘッドレスストアを停止する必要はありません。内ジャーニーの開始の手引きでは、AEMがヘッドレス配信と従来のフルスタックモデルをサポートするだけでなく、両方の利点を組み合わせたハイブリッドモデルもサポートする方法について説明しました。

このような柔軟性がプロジェクトに必要なものである場合は、ジャーニーの追加のオプション部分に進みます。 AEMでのシングルページアプリケーション (SPA) の作成方法です。

その他のリソース

AEM 開発ガイド
WKND チュートリアル
AEM 用の Cloud Manager
CDN キャッシュ
- CDN キャッシュの制御
- CDN Rewriter の設定（CDN Rewriter の検索）