구성 요소에 대해 JSON 내보내기 활성화

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

개요

JSON 내보내기는 Sling ModelsSling Model Exporter 프레임워크를 기반으로 합니다(Jackson 주석에 의존함).

즉, JSON을 내보내려면 구성 요소에 Sling 모델이 있어야 합니다. 따라서 구성 요소에서 JSON 내보내기를 활성화하려면 이 두 단계를 수행해야 합니다.

구성 요소에 대한 Sling 모델 정의

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

노트

Sling 모델을 사용하는 예는 문서 AEM에서 Sling 모델 내보내기 개발 을 참조하십시오.

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 인터페이스에 적용할 수 있도록 지정합니다.

노트

Jackson 주석은 일반적으로 Sling 모델 클래스 수준에서 지정되지 않고 모델 인터페이스 수준에서 지정됩니다. JSON 내보내기 가 구성 요소 API의 일부로 간주되도록 하기 위한 것입니다.

노트

ExporterConstantsComponentExporter 클래스는 com.adobe.cq.export.json 번들에서 가져옵니다.

여러 선택기 사용

표준 사용 사례는 아니지만 model 선택기 외에 여러 선택기를 구성할 수 있습니다.

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

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

Sling 모델 인터페이스에 주석 달기

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

그런 다음 해당 Sling 모델 인터페이스(MyComponent)에 Jackson annotations를 사용하여 주석을 달아서 내보내기(직렬화)하는 방법을 정의합니다.

모델 인터페이스에 serialize해야 하는 메서드를 정의하려면 올바르게 주석을 지정해야 합니다. 기본적으로 getter에 대한 일반적인 이름 지정 규칙을 준수하는 모든 메서드는 직렬화되고 getter 이름에서 JSON 속성 이름을 자연적으로 파생합니다. 이 작업은 @JsonIgnore 또는 @JsonProperty 를 사용하여 JSON 속성의 이름을 바꾸거나 취소할 수 있습니다.

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

예를 들어 이미지 코어 구성 요소의 Sling 모델 구현과 주석으로 구성된 인터페이스를 참조하십시오.

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

이 페이지에서는