为组件启用 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模型。

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模型类级别指定的,而是在Model接口级别指定的。 这是为了确保将JSON导出视为组件API的一部分。
NOTE
ExporterConstantsComponentExporter 课程来自 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(对于容器组件)。

相应的Sling模型界面(MyComponent)随后将使用进行注释 Jackson注释 以定义应如何导出(序列化)。

必须正确注释模型接口以定义应序列化的方法。 默认情况下,所有遵守getter的常规命名约定的方法都将进行序列化,并且将从getter名称自然派生其JSON属性名称。 可以使用阻止或覆盖此操作 @JsonIgnore@JsonProperty 重命名JSON属性。

示例 example

核心组件 支持JSON导出,可用作参考。

有关示例,请参阅图像核心组件的Sling模型实施及其注释的界面。

相关文档 related-documentation

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab