구성 요소에 대해 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 Model 클래스를 ComponentExporter 인터페이스에 적용할 수 있도록 지정합니다.

여러 선택기 사용 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 주석을 사용하여 주석을 달아 내보내는(직렬화하는) 방법을 정의합니다.

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

예 example

핵심 구성 요소는 JSON 내보내기를 지원하며 참조로 사용할 수 있습니다.

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

관련 설명서 related-documentation