Activation de l’exportation JSON pour un composant enabling-json-export-for-a-component

Les composants peuvent être adaptés pour générer l’exportation JSON de leur contenu en fonction d’un framework de modeleur.

Vue d’ensemble overview

L’exportation JSON est basée sur les modèles Sling et sur le framework exporteur de modèles Sling (qui repose lui-même sur les annotations Jackson).

Cette approche signifie que le composant doit disposer d’un modèle Sling s’il doit exporter des fichiers JSON. Par conséquent, vous devrez suivre ces deux étapes pour activer l’exportation du code JSON sur n’importe quel composant.

Définition d’un modèle Sling pour le composant define-a-sling-model-for-the-component

Tout d’abord, un modèle Sling doit être défini pour le composant.

La classe de mise en œuvre des modèles Sling doit être annotée comme suit :

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

Cela permet de s’assurer que votre composant peut être exporté seul, à l’aide du sélecteur de .model et de l’extension .json.

En outre, il indique que la classe de modèle Sling peut être adaptée dans l’interface ComponentExporter.

Utilisation de plusieurs sélecteurs multiple-selectors

Bien qu’il ne s’agisse pas d’un cas d’utilisation standard, il est possible de configurer plusieurs sélecteurs en plus du sélecteur model.

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

Cependant, dans ce cas, le sélecteur model doit être le premier et l’extension doit être .json.

Annotation de l’interface du modèle Sling annotate-the-sling-model-interface

Pour que le framework de l’exportateur JSON le traite, l’interface Modèle doit mettre en œuvre l’interface ComponentExporter (ou ContainerExporter pour un composant de conteneur).

L’interface de modèle Sling correspondante (MyComponent) est alors marquée avec les annotations Jackson pour définir la manière dont les méthodes doivent être exportées (sérialisées).

L’interface Modèle doit être correctement annotée pour définir les méthodes sérialisées. Par défaut, toutes les méthodes qui respectent la convention de nommage habituelle pour les getters sont sérialisées et dérivent naturellement leurs noms de propriété JSON des noms des getters. Il est possible d’empêcher ou de remplacer cette approche en utilisant @JsonIgnore ou @JsonProperty pour renommer la propriété JSON.

Exemple example

Les composants principaux prennent en charge l’exportation JSON depuis la version 1.1.0 des composants principaux et peuvent être utilisés comme référence.

Pour obtenir un exemple, consultez la mise en œuvre du modèle Sling sur le composant principal de l’image et son interface annotée.

CODE SUR GITHUB

Vous pouvez trouver le code de cette page sur GitHub.

Documentation connexe related-documentation