为组件启用JSON导出

组件可以基于建模器框架生成其内容的JSON导出。

概述

JSON导出基于Sling Models和Sling Model Exporter框架（它本身依赖Jackson批注）。

这意味着，如果组件需要导出JSON，则必须具有Sling模型。 因此，您需要按照以下两个步骤在任何组件上启用JSON导出。

• 为组件定义Sling模型
• 注释Sling Model界面

为组件定义Sling模型

首先，必须为组件定义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接口。

使用多个选择器

尽管不是标准用例，但除了model选择器外，还可以配置多个选择器。

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

但是，在这种情况下，model选择器必须是第一个选择器，扩展名必须为.json。

注释Sling Model接口

要由JSON Exporter框架考虑，模型接口应实现ComponentExporter接口(对于容器组件，为ContainerExporter)。

然后，将使用Jackson批注对相应的Sling Model接口(MyComponent)进行注释，以定义如何导出（序列化）它。

需要对“模型”界面进行正确注释，以定义哪些方法应进行序列化。 默认情况下，所有符合getter通常命名惯例的方法都将序列化，并将从getter名称自然地派生其JSON属性名称。 可以使用@JsonIgnore或@JsonProperty重命名JSON属性来阻止或覆盖此属性。

示例

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

有关示例，请参阅图像核心组件及其注释界面的Sling Model实现。

相关文档

有关更多详细信息，请参阅：

• 资产用户指南中的内容片段
• 内容片段模型
• 使用内容片段进行创作
• 核心 组件和内 容片段组件