為元件啟用JSON匯出

元件可適合根據建模器架構產生其內容的JSON匯出。

概觀

JSON匯出以 Sling模型,和 Sling模型導出器 框架(本身依賴 傑克森注釋)。

這表示如果元件需要匯出JSON,則必須有Sling模型。 因此,您需要依照這兩個步驟,對任何元件啟用JSON匯出。

為元件定義Sling模型

首先,必須為元件定義Sling模型。

注意

如需使用Sling模型的範例,請參閱文章 在AEM中開發Sling模型匯出工具.

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的一部分。

注意

ExporterConstantsComponentExporter 課程來自 com.adobe.cq.export.json 捆綁。

使用多個選取器

雖然不是標準使用案例,但除了 model 選取器。

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

然而,在這種情況下, model 選取器必須是第一個選取器,擴充功能必須是 .json.

註解Sling模型介面

若要納入JSON匯出工具架構,模型介面應實作 ComponentExporter 介面(或 ContainerExporter,若為容器元件)。

對應的Sling模型介面( MyComponent),則會使用 傑克森注釋 以定義匯出(序列化)的方式。

需要正確注釋「模型」介面,以定義應序列化哪些方法。 預設情況下,所有遵循getter通常命名慣例的方法都將序列化,並且會從getter名稱自然導出其JSON屬性名稱。 可以使用 @JsonIgnore@JsonProperty 重新命名JSON屬性。

範例

核心元件自發行以來就支援JSON匯出 核心元件1.1.0 和可作為參考。

如需範例,請參閱影像核心元件及其註解介面的Sling模型實作。

GITHUB上的程式碼

您可以在GitHub上找到此頁面的程式碼

如需詳細資訊,請參閱:

本頁內容