コンポーネントの JSON エクスポートを有効化 enabling-json-export-for-a-component
モデラーフレームワークに基づいてコンテンツの JSON 書き出しを生成するように、コンポーネントを適応させることができます。
概要 overview
JSON 書き出しは、Sling Model と Sling Model Exporter フレームワーク(それ自体が Jackson 注釈に依存)に基づいています。
つまり、JSON を書き出す必要がある場合、コンポーネントに Sling モデルが必要です。 したがって、任意のコンポーネントで JSON 書き出しを有効にするには、次の 2 つの手順に従う必要があります。
コンポーネントに Sling Model を定義する define-a-sling-model-for-the-component
まず、コンポーネントに Sling Model を定義する必要があります。
Sling Model の実装クラスに次のような注釈を付ける必要があります。
@Model(... adapters = {..., ComponentExporter.class})
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION)
@JsonSerialize(as = MyComponent.class)
これにより、.model
セレクターと .json
拡張子を使用して、コンポーネントをそれ自体に書き出すことができます。
さらに、Sling Model クラスが ComponentExporter
インターフェイスに適応できるように指定されます。
ExporterConstants
クラスと ComponentExporter
クラスは com.adobe.cq.export.json
バンドルから取得されます。複数のセレクターの使用 multiple-selectors
標準的なユースケースではありませんが、model
セレクターに加えて複数のセレクターを設定することができます。
https://<server>:<port>/content/page.model.selector1.selector2.json
ただし、その場合は、model
セレクターを最初のセレクターにし、拡張子を .json
にする必要があります。
Sling Model インターフェイスに注釈を付ける annotate-the-sling-model-interface
JSON エクスポーターフレームワークで認識されるようにするには、モデルインターフェイスに ComponentExporter
インターフェイス(またはコンテナコンポーネントの場合は ContainerExporter
)を実装する必要があります。
対応する Sling Model インターフェイス(MyComponent
)には、Jackson 注釈を使用して注釈が付けられ、どのように書き出し(シリアル化)が行われるかが定義されます。
モデルインターフェイスに適切な注釈を付けて、シリアル化するメソッドを定義する必要があります。 デフォルトでは、getter の通常の命名規則に従うすべてのメソッドがシリアル化され、JSON プロパティ名はゲッター名から自然に派生します。 これを回避または上書きするには、@JsonIgnore
または @JsonProperty
を使用して JSON プロパティの名前を変更します。
例 example
コアコンポーネントは、リリース以降、JSON 書き出しをサポートしています コアコンポーネントの 1.1.0 とは、参照として使用できます。
例えば、画像コアコンポーネントの Sling Model 実装とその注釈されたインターフェイスを参照してください。
GitHub のコード
このページのコードは GitHub にあります
- GitHub の aem-core-wcm-components プロジェクトを開きます
- プロジェクトを ZIP ファイルとしてダウンロードします
関連ドキュメント related-documentation
詳しくは、以下を参照してください。