文件AEM 6.5 LTS使用手冊

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

Last update: Thu Feb 05 2026 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 適用對象：
  • Experience Manager 6.5 LTS

建立對象：

  • 開發人員

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

概觀 overview

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

此方法表示元件必須匯出JSON時才會有Sling模型。 因此，請依照這兩個步驟，在任何元件上啟用JSON匯出。

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

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

NOTE
如需使用Sling模型的範例，請參閱在AEM中開發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介面中。

NOTE
Jackson註解不是在Sling模型類別層級指定的，而是在「模型」介面層級指定的。 此方法的目的是確保JSON匯出可視為元件API的一部分。
NOTE
ExporterConstants和ComponentExporter類別來自com.adobe.cq.export.json組合。

使用多個選擇器 multiple-selectors

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

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

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

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

若要讓JSON匯出程式架構進行處理，模型介面必須實作ComponentExporter介面（或容器元件的ContainerExporter）。

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

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

範例 example

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

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

GITHUB上的程式碼

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

recommendation-more-help
51c6a92d-a39d-46d7-8e3e-2db9a31c06a2