コンポーネントの JSON 書き出しの有効化

モデラーフレームワークに基づいてコンテンツの JSON 書き出しを生成するように、コンポーネントを適応させることができます。

概要

JSON 書き出しは、Sling Model と Sling Model Exporter フレームワーク（それ自体が Jackson 注釈に依存）に基づいています。

つまり、JSON を書き出す必要がある場合、コンポーネントには Sling Model が必要です。そのため、次の 2 つの手順に従って、コンポーネントで JSON 書き出しを有効にする必要があります。

コンポーネントに Sling Model を定義する

まず、コンポーネントに Sling Model を定義する必要があります。

メモ

Sling Model の使用例については、AEM での Sling Model Exporter の開発の記事を参照してください。

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 インターフェイスに適応できるように指定されます。

メモ

Jackson 注釈は通常 Sling Model クラスレベルではなく、Model インターフェイスレベルで指定されます。これは、JSON 書き出しがコンポーネント API の一部とみなされるようにするためです。

メモ

ExporterConstants クラスと ComponentExporter クラスは com.adobe.cq.export.json バンドルから取得されます。

複数のセレクターの使用

標準的なユースケースではありませんが、model セレクターに加えて複数のセレクターを設定することができます。

https://<server>:<port>/content/page.model.selector1.selector2.json

ただし、その場合は、model セレクターを最初のセレクターにし、拡張子を .json にする必要があります。

Sling Model インターフェイスに注釈を付ける

JSON エクスポーターフレームワークで認識されるようにするには、モデルインターフェイスに ComponentExporter インターフェイス（またはコンテナコンポーネントの場合は ContainerExporter）を実装する必要があります。

対応する Sling Model インターフェイス（MyComponent）には、Jackson 注釈を使用して注釈が付けられ、どのように書き出し（シリアル化）が行われるかが定義されます。

Model インターフェイスには、シリアル化されるメソッドを定義するために適切に注釈を付ける必要があります。デフォルトでは、getter の通常の命名規則に準拠するすべてのメソッドがシリアル化され、JSON プロパティ名が getter 名からそのまま派生されます。これを回避または上書きするには、@JsonIgnore または @JsonProperty を使用して JSON プロパティの名前を変更します。

例

コアコンポーネントでは、JSON 書き出しがコアコンポーネントのリリース 1.1.0 からサポートされており、参照として使用できます。

例えば、画像コアコンポーネントの Sling Model 実装とその注釈されたインターフェイスを参照してください。

GitHub のコード

このページのコードは GitHub にあります

詳しくは、以下を参照してください。

このページ