구성 요소에 대해 JSON 내보내기 활성화 enabling-json-export-for-a-component

구성 요소는 모델러 프레임워크를 기반으로 콘텐츠의 JSON 내보내기를 생성하도록 조정할 수 있습니다.

개요 overview

JSON 내보내기는 다음을 기반으로 합니다. Sling 모델, 및 Sling 모델 내보내기 프레임워크(자체 의존도) Jackson 주석).

즉, 구성 요소에 JSON을 내보내야 하는 경우 Sling 모델이 있어야 합니다. 따라서 구성 요소에서 JSON 내보내기를 활성화하려면 다음 두 단계를 따르십시오.

구성 요소에 대한 슬링 모델 정의 define-a-sling-model-for-the-component

먼저 구성 요소에 대해 슬링 모델 을 정의해야 합니다.

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 인터페이스.

여러 선택기 사용 multiple-selectors

표준 사용 사례는 아니지만, model 선택기.

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

그러나 이러한 경우에는 model 선택기는 첫 번째 선택기여야 하며 확장은 이어야 합니다. .json.

Sling 모델 인터페이스에 주석 달기 annotate-the-sling-model-interface

JSON Exporter 프레임워크에서 고려하려면 모델 인터페이스가 다음을 구현해야 합니다. ComponentExporter 인터페이스(또는 ContainerExporter: 컨테이너 구성 요소가 있는 경우)입니다.

해당 Sling 모델 인터페이스( MyComponent)에 주석을 달 수 있습니다 Jackson 주석 내보내는 방법(일련화)을 정의할 수 있습니다.

serialize할 메서드를 정의하려면 모델 인터페이스에 적절한 주석을 추가해야 합니다. 기본적으로 getter에 대한 일반적인 명명 규칙을 준수하는 모든 메서드는 serialize되며 getter 이름에서 자연스럽게 JSON 속성 이름을 파생합니다. 다음을 사용하여 방지하거나 재정의할 수 있습니다. @JsonIgnore 또는 @JsonProperty 를 클릭하여 JSON 속성의 이름을 변경합니다.

예 example

릴리스 이후 핵심 구성 요소는 JSON 내보내기를 지원합니다. 1.1.0 핵심 구성 요소 및 를 참조로 사용할 수 있습니다.

예를 들어 이미지 핵심 구성 요소의 슬링 모델 구현 및 주석이 달린 인터페이스를 참조하십시오.

GITHUB의 코드

GitHub에서 이 페이지의 코드를 확인할 수 있습니다

관련 설명서 related-documentation

자세한 내용은 다음을 참조하십시오.