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

最終更新日: 2024-01-08

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

概要

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

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

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

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

メモ

Sling モデルの使用例については、 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 注釈を使用して注釈が付けられ、どのように書き出し(シリアル化)が行われるかが定義されます。

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

コアコンポーネントは、リリース以降、JSON 書き出しをサポートしています コアコンポーネントの 1.1.0 とは、参照として使用できます。

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

GitHub のコード

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

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

このページ