為元件啟用 JSON 匯出 enabling-json-export-for-a-component

元件可調整為根據模組化架構產生其內容的JSON匯出。

概觀 overview

JSON匯出是以Sling模型和Sling模型匯出工具架構（本身依賴Jackson註解）為基礎。

這表示元件必須具有Sling模型（若元件必須匯出JSON）。 因此，請依照這兩個步驟，在任何元件上啟用JSON匯出。

為元件定義Sling模型 define-a-sling-model-for-the-component

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

Sling模型實作類別必須使用以下專案註釋：

@Model(... adapters = {..., ComponentExporter.class})
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION)
@JsonSerialize(as = MyComponent.class)

這可確保您的元件可以使用.model選取器和.json副檔名自行匯出。

此外，這會指定Sling模型類別可以調整到ComponentExporter介面中。

使用多個選擇器 multiple-selectors

雖然這不是標準使用案例，但除了model選擇器之外，還可以設定多個選擇器。

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

不過，在這種情況下，model選取器必須是第一個選取器，副檔名必須是.json。

為Sling模型介面加上註釋 annotate-the-sling-model-interface

若要讓JSON匯出工具架構考慮在內，模型介面應該實作ComponentExporter介面（如果存在容器元件，則為ContainerExporter）。

接著會使用Jackson註解標註相對應的Sling模型介面(MyComponent)，以定義應如何匯出（序列化）。

模型介面必須正確加上註解，以定義應該序列化哪些方法。 依預設，所有遵守getter一般命名慣例的方法都會序列化，並從getter名稱自然衍生其JSON屬性名稱。 使用@JsonIgnore或@JsonProperty重新命名JSON屬性可防止或覆寫此專案。

範例 example

核心元件自核心元件🔗發行版本1.1.0起便已支援JSON匯出，並可作為參考使用。

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

GITHUB上的程式碼

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

相關檔案 related-documentation

如需詳細資訊，請參閱下列內容：