AEM 구성 요소 개발 developing-aem-components

AEM 구성 요소는 웹 페이지에서 사용할 수 있는 콘텐츠를 유지하고, 형식을 지정하며, 렌더링하는 데 사용됩니다.

코드 샘플 code-samples

이 페이지에서는 AEM용 새 구성 요소를 개발하는 데 필요한 참조 설명서(또는 참조 설명서 링크)를 제공합니다. 실제 예제는 AEM 구성 요소 개발 - 코드 샘플을 참조하십시오.

구조 structure

구성 요소의 기본 구조는 AEM 구성 요소 - 기본 사항 페이지에서 다룹니다. 이 문서에서는 터치 지원 UI와 클래식 UI를 모두 다룹니다. 새 구성 요소에서 클래식 설정을 사용할 필요가 없는 경우에도 기존 구성 요소에서 상속할 때 클래식 설정을 인식하는 데 도움이 될 수 있습니다.

기존 구성 요소 및 대화 상자 확장 extending-existing-components-and-dialogs

구현하려는 구성 요소에 따라 전체 구조를 처음부터 정의하고 개발하는 대신 기존 인스턴스를 확장하거나 사용자 지정하는 것이 가능할 수 있습니다.

기존 구성 요소나 대화 상자를 확장하거나 사용자 정의할 때, 변경하기 전에 대화 상자에 필요한 구조 또는 전체 구조를 복사하거나 복제할 수 있습니다.

기존 구성 요소 확장 extending-an-existing-component

리소스 유형 계층 구조 및 관련 상속 메커니즘을 통해 기존 구성 요소를 확장할 수 있습니다.

기존 구성 요소 맞춤화 대화 상자 customizing-a-existing-component-dialog

Sling 리소스 병합을 사용하고 sling:resourceSuperType 속성을 정의하는 구성 요소 대화 상자 ​을(를) 재정의할 수도 있습니다.

즉, sling:resourceSuperType을(를) 사용하여 전체 대화 상자를 다시 정의하는 대신 필요한 차이점만 다시 정의하면 됩니다. 이제 구성 요소 대화 상자를 확장하는 데 권장되는 방법입니다

자세한 내용은 Sling 리소스 병합을 참조하십시오.

마크업 정의 defining-the-markup

구성 요소가 HTML(으)로 렌더링됩니다. 구성 요소는 작성자와 게시 환경 모두에서 필요한 콘텐츠를 가져온 다음 필요에 따라 렌더링하는 데 필요한 HTML을 정의해야 합니다.

HTML 템플릿 언어 사용 using-the-html-template-language

AEM 6.0과 함께 도입된 HTML 템플릿 언어(HTL)는 HTML을 위한 기본 및 권장 서버측 템플릿 시스템으로 JSP(JavaServer Pages)를 대신합니다. 강력한 엔터프라이즈 웹 사이트를 구축해야 하는 웹 개발자에게 HTL은 향상된 보안 및 개발 효율성을 제공하는 데 도움이 됩니다.

콘텐츠 논리 개발 developing-the-content-logic

이 선택적 로직은 렌더링할 콘텐츠를 선택 및/또는 계산합니다. 적절한 Use-API 패턴을 사용하여 HTL 표현식에서 호출됩니다.

논리를 외형과 분리하는 메커니즘은 주어진 견해에 대해 호출되는 것을 명확히 하는 데 도움이 된다. 또한 동일한 리소스의 다른 보기에 대해 다른 논리를 사용할 수 있습니다.

Java 사용 using-java

HTL Java Use-API를 사용하면 HTL 파일이 사용자 지정 Java 클래스의 도우미 메서드에 액세스할 수 있습니다. 이렇게 하면 Java 코드를 사용하여 구성 요소 콘텐츠를 선택하고 구성하기 위한 논리를 구현할 수 있습니다.

JavaScript 사용 using-javascript

HTL JavaScript Use-API를 사용하면 HTL 파일이 JavaScript에서 작성된 도우미 코드에 액세스할 수 있습니다. 이렇게 하면 JavaScript 코드를 사용하여 구성 요소 콘텐츠를 선택하고 구성하는 논리를 구현할 수 있습니다.

클라이언트측 HTML 라이브러리 사용 using-client-side-html-libraries

최신 웹 사이트는 복잡한 JavaScript 및 CSS 코드로 구동되는 클라이언트측 처리에 크게 의존합니다. 이 코드의 제공을 구성하고 최적화하는 것은 복잡한 문제가 될 수 있습니다.

이 문제를 해결하기 위해 AEM에서는 클라이언트측 코드를 저장소에 저장하고, 범주로 구성하고, 각 코드 범주가 클라이언트에 제공되는 시기와 방법을 정의할 수 있는 클라이언트측 라이브러리 폴더 ​를 제공합니다. 그런 다음 클라이언트측 라이브러리 시스템은 올바른 코드를 로드하기 위해 최종 웹 페이지에서 올바른 링크를 생성합니다.

자세한 내용은 클라이언트측 HTML 라이브러리 사용을 참조하십시오.

비헤이비어 편집 구성 configuring-the-edit-behavior

구성 요소에 사용할 수 있는 작업, 즉석 편집기의 특성, 구성 요소의 이벤트와 관련된 리스너와 같은 속성을 포함하여 구성 요소의 편집 동작을 구성할 수 있습니다. 이 구성은 터치 지원 UI와 클래식 UI에 공통되지만, 특정 차이점이 있습니다.

cq:Component 형식의 구성 요소 노드 아래에 cq:EditConfig 형식의 cq:editConfig 노드를 추가하고 특정 속성 및 자식 노드를 추가하여 구성 요소의 편집 동작이 구성됩니다.

미리 보기 동작 구성 configuring-the-preview-behavior

WCM 모드 쿠키는 페이지를 새로 고치지 않은 경우에도 미리 보기 모드로 전환할 때 설정됩니다.

렌더링이 WCM 모드에 민감한 구성 요소의 경우, 특별히 자신을 새로 고치도록 정의한 다음 쿠키 값을 사용해야 합니다.

대화 상자 만들기 및 구성 creating-and-configuring-a-dialog

대화 상자는 작성자가 구성 요소와 상호 작용할 수 있도록 하는 데 사용됩니다. 대화 상자를 사용하면 작성자 및/또는 관리자가 콘텐츠를 편집하거나 구성 요소를 구성하거나 디자인 매개 변수를 정의할 수 있습니다(디자인 대화 상자 사용).

Coral UI 및 Granite UI coral-ui-and-granite-ui

Coral UI 및 Granite UI은(는) AEM의 현대적인 모양과 느낌을 정의합니다.

Granite UI는 작성 환경에서 대화 상자를 만드는 데 필요한 다양한 기본 구성 요소(위젯)를 제공합니다. 필요한 경우 이 선택 항목을 확장하고 고유한 위젯을 만들 수 있습니다.

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

새 대화 상자 만들기 creating-a-new-dialog

터치 지원 UI에 대한 대화 상자:

노드 구조의 예는 다음과 같습니다.

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

대화 상자를 사용자 정의하는 것은 대화 상자 자체가 구성 요소이므로 구성 요소를 개발하는 것과 비슷합니다(즉, 클라이언트 라이브러리에서 제공하는 동작/스타일과 함께 구성 요소 스크립트에 의해 렌더링된 마크업).

예를 보려면 다음을 참조하십시오.

대화 상자 필드 사용자 지정 customizing-dialog-fields

새 필드 만들기 creating-a-new-field

터치 지원 UI에 대한 위젯은 Granite UI 구성 요소로 구현됩니다.

터치 사용 UI의 구성 요소 대화 상자에서 사용할 위젯을 만들려면 Granite UI 필드 구성 요소를 만들어야 합니다.

대화 상자를 양식 요소의 간단한 컨테이너로 간주하면 대화 상자 콘텐츠의 기본 콘텐츠도 양식 필드로 볼 수 있습니다. 양식 필드를 만들려면 리소스 유형을 만들어야 합니다. 이는 구성 요소를 만드는 것과 같습니다. Granite UI는 해당 작업에서 상속할 일반 필드 구성 요소를 제공합니다(sling:resourceSuperType 사용).

/libs/granite/ui/components/coral/foundation/form/field

특히 Granite UI는 대화 상자(또는 일반적으로 forms)에서 사용하기에 적합한 다양한 필드 구성 요소를 제공합니다.

리소스 유형을 만든 후에는 대화 상자에서 새 노드를 추가하여 필드를 인스턴스화할 수 있습니다. 속성 sling:resourceType은(는) 방금 도입한 리소스 유형을 참조합니다.

스타일 및 비헤이비어를 위한 클라이언트 라이브러리 만들기 creating-a-client-library-for-style-and-behavior

구성 요소의 스타일 및 동작을 정의하려는 경우 사용자 지정 CSS/LESS 및 JS를 정의하는 전용 클라이언트 라이브러리를 만들 수 있습니다.

구성 요소 대화 상자용으로만 클라이언트 라이브러리를 로드하려면(즉, 다른 구성 요소용으로는 로드되지 않음) 대화 상자의 속성 extraClientlibs을(를) 만든 클라이언트 라이브러리의 범주 이름으로 설정해야 합니다. 클라이언트 라이브러리가 상당히 크고/또는 필드가 해당 대화 상자와 관련이 있으며 다른 대화 상자에는 필요하지 않은 경우 이 방법을 사용하는 것이 좋습니다.

모든 대화 상자에 대해 클라이언트 라이브러리를 로드하려면 클라이언트 라이브러리의 category 속성을 cq.authoring.dialog(으)로 설정하십시오. 모든 대화 상자를 렌더링할 때 기본적으로 포함되는 클라이언트 라이브러리의 범주 이름입니다. 클라이언트 라이브러리가 작거나 필드가 일반적이고 다른 대화 상자에서 다시 사용할 수 있는 경우 이 작업을 하려고 합니다.

예를 보려면 다음을 참조하십시오.

필드 확장(상속) extending-inheriting-from-a-field

요구 사항에 따라 다음 중 하나를 수행할 수 있습니다.

대화 상자 필드 액세스 access-to-dialog-fields

또한 렌더링 조건(rendercondition)을 사용하여 대화 상자의 특정 탭/필드에 액세스할 수 있는 사용자를 제어할 수 있습니다. 예:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

필드 이벤트 처리 handling-field-events

이제 대화 상자 필드의 이벤트 처리 방법이 사용자 지정 클라이언트 라이브러리의 리스너를 통해 완료되었습니다. 이는 콘텐츠 구조에 청취자가 있는 이전 메서드의 변경 사항입니다.

사용자 지정 클라이언트 라이브러리의 리스너 listeners-in-a-custom-client-library

필드에 논리를 삽입하려면 다음을 수행해야 합니다.

이를 위해서는 상호 작용하려는 기본 위젯 라이브러리에 대해 알아야 합니다. 반응할 이벤트를 식별하려면 Coral UI 설명서를 참조하십시오. 이는 이전에 ExtJS로 수행해야 했던 프로세스와 매우 유사합니다. 특정 위젯의 문서 페이지를 찾은 다음 이벤트 API의 세부 사항을 확인합니다.

예를 보려면 다음을 참조하십시오.

콘텐츠 구조의 리스너 listeners-in-the-content-structure

ExtJS가 있는 클래식 UI에서는 일반적으로 콘텐츠 구조에 지정된 위젯에 대한 리스너를 보유했습니다. 터치 사용 UI에서 를 구현하는 것은 JS 수신기 코드(또는 모든 코드)가 더 이상 콘텐츠에 정의되지 않음으로써 다릅니다.

콘텐츠 구조는 의미 체계 구조를 설명합니다. 기본 위젯의 특성을 암시해서는 안 됩니다. 콘텐츠 구조에 JS 코드가 없으므로 콘텐츠 구조를 변경하지 않고도 구현 세부 사항을 변경할 수 있습니다. 즉, 콘텐츠 구조를 터치하지 않고도 위젯 라이브러리를 변경할 수 있습니다.

대화 상자의 사용 가능 여부 감지 dialog-ready

대화 상자를 사용할 수 있고 준비가 되었을 때만 실행해야 하는 사용자 지정 JavaScript이 있는 경우 dialog-ready 이벤트를 수신해야 합니다.

이 이벤트는 대화 상자가 로드(또는 다시 로드)되고 사용할 준비가 될 때마다 트리거됩니다. 즉, 대화 상자의 DOM에 변경(만들기/업데이트)이 있을 때마다 트리거됩니다.

dialog-ready을(를) 사용하여 대화 상자 또는 유사한 작업 내의 필드에 대한 사용자 지정을 수행하는 JavaScript 사용자 지정 코드를 연결할 수 있습니다.

필드 유효성 검사 field-validation

필수 필드 mandatory-field

지정된 필드를 필수 항목으로 표시하려면 필드의 콘텐츠 노드에서 다음 속성을 설정합니다.

예를 보려면 다음을 참조하십시오.

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

필드 유효성 검사(Granite UI) field-validation-granite-ui

Granite UI 및 Granite UI 구성 요소(위젯과 동일)의 필드 유효성 검사는 foundation-validation API를 사용하여 수행됩니다. 자세한 내용은 foundation-valdiation Granite 설명서를 참조하십시오.

예를 보려면 다음을 참조하십시오.

디자인 대화 상자 만들기 및 구성 creating-and-configuring-a-design-dialog

구성 요소에 디자인 모드에서 편집할 수 있는 디자인 세부 정보가 있으면 디자인 대화 상자가 제공됩니다.

정의는 콘텐츠 편집에 사용되는 대화 상자와(과) 매우 유사하지만, 다른 점은 노드로 정의된다는 것입니다.

즉석 편집기 만들기 및 구성 creating-and-configuring-an-inplace-editor

즉석 편집기를 사용하면 대화 상자를 열지 않고도 단락 흐름에서 직접 콘텐츠를 편집할 수 있습니다. 예를 들어 표준 텍스트 및 제목 구성 요소에는 모두 즉석 편집기가 있습니다.

즉석 편집기는 모든 구성 요소 유형에 필요/의미가 없습니다.

자세한 내용은 페이지 작성 확장 - 새 즉석 편집기 추가를 참조하십시오.

구성 요소 도구 모음 맞춤화 customizing-the-component-toolbar

구성 요소 도구 모음을(를) 통해 사용자는 구성 요소에 대한 편집, 구성, 복사, 삭제와 같은 다양한 작업에 액세스할 수 있습니다.

자세한 내용은 페이지 작성 확장 - 구성 요소 도구 모음에 새 작업 추가를 참조하십시오.

참조 레일에 대한 구성 요소 구성(빌린/빌려준) configuring-a-component-for-the-references-rail-borrowed-lent

새 구성 요소가 다른 페이지의 콘텐츠를 참조하는 경우 참조 레일의 빌려 콘텐츠 및 빌려준 콘텐츠 섹션에 영향을 미치는지 여부를 고려할 수 있습니다.

기본 AEM에서는 참조 구성 요소만 확인합니다. 구성 요소를 추가하려면 OSGi 번들 WCM 작성 콘텐츠 참조 구성 ​을 구성해야 합니다.

확인할 속성과 함께 구성 요소를 지정하여 정의에 항목을 만듭니다. 예:

/apps/<*your-Project*>/components/reference@parentPath

단락 시스템에 구성 요소 활성화 및 추가 enabling-and-adding-your-component-to-the-paragraph-system

구성 요소가 개발되면 적절한 단락 시스템에서 사용할 수 있도록 활성화해야 하므로 필요한 페이지에서 사용할 수 있습니다.

다음 중 하나를 통해 이 작업을 수행할 수 있습니다.

자산을 드래그하여 구성 요소 인스턴스를 만들도록 단락 시스템 구성 configuring-a-paragraph-system-so-that-dragging-an-asset-creates-a-component-instance

AEM에서는 사용자가 (적절한) 에셋을 🔗의 인스턴스로 드래그할 때(항상 빈 구성 요소를 페이지로 드래그할 필요 없이) 새 구성 요소의 인스턴스가 자동으로 만들어지도록 페이지에서 단락 시스템을 구성할 수 있습니다.

이 동작과 필요한 에셋-구성 요소 관계를 구성할 수 있습니다.

예를 보려면 다음을 참조하십시오.

GITHUB의 코드

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

AEM Brackets 확장 사용 using-the-aem-brackets-extension

AEM Brackets 확장은(는) AEM 구성 요소 및 클라이언트 라이브러리를 편집하는 원활한 워크플로를 제공합니다. Brackets 코드 편집기를 기반으로 합니다.

확장:

클래식 구성 요소에서 마이그레이션 migrating-from-a-classic-component

클래식 UI와 함께 사용하도록 설계된 구성 요소를 터치 사용 UI와 함께 사용할 수 있는 구성 요소로 마이그레이션할 때(단독으로 또는 공동으로) 다음 문제를 고려해야 합니다.

cq:listener 코드 마이그레이션 migrating-cq-listener-code

클래식 UI용으로 설계된 프로젝트를 마이그레이션하는 경우 cq:listener 코드(및 구성 요소 관련 clientlib)에서 클래식 UI에 고유한 함수(예: CQ.wcm.*)를 사용할 수 있습니다. 마이그레이션의 경우 터치 지원 UI에서 이와 동등한 오브젝트/함수를 사용하여 이러한 코드를 업데이트해야 합니다.

프로젝트가 터치 지원 UI로 완전히 마이그레이션되는 경우 터치 지원 UI와 관련된 오브젝트 및 기능을 사용하려면 해당 코드를 교체해야 합니다.

그러나 마이그레이션 기간 동안 프로젝트가 클래식 UI와 터치 지원 UI를 모두 충족해야 하는 경우(일반적인 시나리오) 적절한 개체를 참조하는 개별 코드를 차별화하도록 스위치를 구현해야 합니다.

이 스위치 메커니즘은 다음과 같이 구현될 수 있습니다.

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

구성 요소 문서화 documenting-your-component

개발자는 다음을 빠르게 이해할 수 있도록 구성 요소 설명서에 쉽게 액세스하려고 합니다.

따라서 구성 요소 자체 내에서 사용할 수 있는 기존 설명서 Markdown을 쉽게 만들 수 있습니다.

구성 요소 구조에 README.md 파일을 배치합니다. 이 Markdown은 구성 요소 콘솔에 표시됩니다.

지원되는 Markdown은 콘텐츠 조각의 Markdown과 동일합니다.