Activación de la exportación de JSON para un componente

Los componentes se pueden adaptar para generar la exportación JSON de su contenido en base a un modelo de modelo.

Información general

La exportación JSON se basa en modelos Slingy en el marco del exportador del modelo Sling (que se basa en anotaciones Jackson).

Esto significa que el componente debe tener un modelo Sling si necesita exportar JSON. Por lo tanto, deberá seguir estos dos pasos para habilitar la exportación de JSON en cualquier componente.

Definición de un modelo Sling para el componente

Primero se debe definir un modelo de Sling para el componente.

Nota

Para ver un ejemplo del uso de modelos Sling, consulte el artículo Desarrollo de exportadores de modelos Sling en AEM.

La clase de implementación del modelo Sling debe anotarse con lo siguiente:

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

Esto garantiza que el componente se pueda exportar por sí solo, mediante el .model selector y la .json extensión.

Además, esto especifica que la clase Sling Model se puede adaptar a la ComponentExporter interfaz.

Nota

Las anotaciones Jackson no suelen especificarse en el nivel de clase del Modelo Sling, sino en el nivel de interfaz del Modelo. Esto sirve para garantizar que la exportación JSON se considere como parte de la API de componente.

Nota

Las clases ExporterConstants y ComponentExporter vienen del com.adobe.cq.export.json paquete.

Uso de varios selectores

Aunque no es un caso de uso estándar, es posible configurar varios selectores además del model selector.

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

Sin embargo, en este caso el model selector debe ser el primer selector y la extensión debe ser .json.

Anotar la interfaz del modelo Sling

Para que el marco de exportación JSON lo tenga en cuenta, la interfaz del modelo debe implantar la ComponentExporter interfaz (o ContainerExporter, en el caso de un componente de contenedor).

La interfaz (MyComponent) del Modelo Sling correspondiente se anotaría usando anotaciones Jackson para definir cómo se debe exportar (serializar).

La interfaz del modelo debe anotarse correctamente para definir qué métodos deben serializarse. De forma predeterminada, todos los métodos que respetan la convención de nombre habitual para captadores se serializarán y derivarán los nombres de propiedades JSON de forma natural de los nombres de captador. Esto puede evitarse o anularse con @JsonIgnore o @JsonProperty para cambiar el nombre de la propiedad JSON.

Ejemplo

Los componentes principales admiten la exportación JSON y pueden utilizarse como referencia.

Para ver un ejemplo, consulte la implementación del modelo Sling del componente principal de imagen y su interfaz anotada.

Para obtener más información, consulte:

En esta página