SPA 구성 요소를 AEM 구성 요소에 매핑

마지막 업데이트: 2024-01-25
  • 주제:
  • SPA Editor
    이 항목에 대한 자세한 내용 보기
  • 작성 대상:
  • Beginner
    Developer

AEM SPA Editor JS SDK를 사용하여 React 구성 요소를 AEM(Adobe Experience Manager) 구성 요소에 매핑하는 방법에 대해 알아봅니다. 구성 요소 매핑을 통해 사용자는 AEM SPA 편집기 내에서 기존의 AEM 작성과 유사하게 SPA 구성 요소를 동적으로 업데이트할 수 있습니다.

이 장에서는 AEM JSON 모델 API에 대해 자세히 알아보고 AEM 구성 요소에 의해 노출된 JSON 콘텐츠를 React 구성 요소에 Prop으로 자동으로 주입하는 방법에 대해 살펴봅니다.

목표

  1. AEM 구성 요소를 SPA 구성 요소에 매핑하는 방법을 알아봅니다.
  2. Inspect React 구성 요소가 AEM에서 전달된 동적 속성을 사용하는 방법입니다.
  3. 즉시 사용할 수 있는 사용 방법 알아보기 React AEM 핵심 구성 요소.

빌드할 내용

이 류에서는 제공된 방법을 검사합니다 Text SPA 구성 요소는 AEM에 매핑됩니다. Text구성 요소. 다음과 같은 React 핵심 구성 요소 Image SPA 구성 요소는 SPA에서 사용되고 AEM에서 작성됩니다. 의 기본 기능 레이아웃 컨테이너템플릿 편집기 정책은 또한 외형이 약간 더 다양한 보기를 만드는 데 사용됩니다.

챕터 샘플 최종 작성

사전 요구 사항

설정에 필요한 도구 및 지침 검토 로컬 개발 환경. 이 장은 의 연속입니다. SPA 통합 챕터 그러나 SPA이 활성화된 AEM 프로젝트만 있으면 됩니다.

매핑 접근 방식

기본 개념은 SPA 구성 요소를 AEM 구성 요소에 매핑하는 것입니다. AEM 구성 요소, 서버측 실행, JSON 모델 API의 일부로 콘텐츠 내보내기. JSON 콘텐츠는 브라우저에서 클라이언트측을 실행하는 SPA에서 사용됩니다. SPA 구성 요소와 AEM 구성 요소 간의 1:1 매핑이 생성됩니다.

AEM 구성 요소를 React 구성 요소에 매핑하는 방법에 대한 높은 수준 개요

AEM 구성 요소를 React 구성 요소에 매핑하는 방법에 대한 높은 수준 개요

텍스트 구성 요소 Inspect

다음 AEM Project Archetype 는 을(를) 제공합니다 Text AEM에 매핑된 구성 요소 텍스트 구성 요소. 다음은 의 예입니다 콘텐츠 구성 요소, 렌더링됩니다. 콘텐츠 AEM에서.

구성 요소가 어떻게 작동하는지 살펴보겠습니다.

Inspect JSON 모델

  1. SPA 코드로 이동하기 전에 AEM에서 제공하는 JSON 모델을 이해하는 것이 중요합니다. 다음 위치로 이동 핵심 구성 요소 라이브러리 텍스트 구성 요소에 대한 페이지를 봅니다. 핵심 구성 요소 라이브러리는 모든 AEM 핵심 구성 요소의 예를 제공합니다.

  2. 다음 항목 선택 JSON 예제 중 하나에 대한 탭:

    텍스트 JSON 모델

    다음 세 가지 속성이 표시됩니다. text, richText, 및 :type.

    :type 는 다음을 나열하는 예약된 속성입니다. sling:resourceType AEM 구성 요소 (또는 경로). 값: :type 는 AEM 구성 요소를 SPA 구성 요소에 매핑하는 데 사용되는 것입니다.

    textrichText 는 SPA 구성 요소에 노출되는 추가 속성입니다.

  3. 다음 위치에서 JSON 출력 보기 http://localhost:4502/content/wknd-spa-react/us/en.model.json. 다음과 유사한 항목을 찾을 수 있어야 합니다.

    "text": {
        "id": "text-a647cec03a",
        "text": "<p>Hello World! Updated content!</p>\r\n",
        "richText": true,
        ":type": "wknd-spa-react/components/text",
        "dataLayer": {}
       }
    

텍스트 SPA 구성 요소 Inspect

  1. 선택한 IDE에서 SPA용 AEM 프로젝트를 엽니다. 확장 ui.frontend 모듈을 클릭하고 파일을 엽니다. Text.js 아래에 ui.frontend/src/components/Text/Text.js.

  2. 우리가 검사할 첫 번째 영역은 class Text ~line 40:

    class Text extends Component {
    
        get richTextContent() {
            return (<div
                    id={extractModelId(this.props.cqPath)}
                    data-rte-editelement
                    dangerouslySetInnerHTML={{__html: DOMPurify.sanitize(this.props.text)}} />
                    );
        }
    
        get textContent() {
            return <div>{this.props.text}</div>;
        }
    
        render() {
            return this.props.richText ? this.richTextContent : this.textContent;
        }
    }
    

    Text 는 표준 React 구성 요소입니다. 구성 요소는 this.props.richText 렌더링할 컨텐츠가 서식 있는 텍스트인지 일반 텍스트인지를 결정합니다. 사용되는 실제 "콘텐츠"는 this.props.text.

    잠재적 XSS 공격을 방지하기 위해 서식 있는 텍스트는 DOMPurify 사용하기 전에 위험하게 설정내부 HTML 콘텐츠를 렌더링합니다. 다음 회수 richTexttext 연습 앞부분의 JSON 모델 속성입니다.

  3. 다음, 열기 ui.frontend/src/components/import-components.js 다음을 살펴보십시오. TextEditConfig ~line 86:

    const TextEditConfig = {
    emptyLabel: 'Text',
    
        isEmpty: function(props) {
            return !props || !props.text || props.text.trim().length < 1;
        }
    };
    

    위의 코드는 AEM 작성 환경에서 자리 표시자를 렌더링할 시기를 결정합니다. 다음과 같은 경우 isEmpty 메서드 반환 true 그러면 자리 표시자가 렌더링됩니다.

  4. 마지막으로 다음을 살펴보십시오 MapTo 94행 ~에서 호출:

    export default MapTo('wknd-spa-react/components/text')(LazyTextComponent, TextEditConfig);
    

    MapTo AEM SPA Editor JS SDK에서 제공됩니다(@adobe/aem-react-editable-components). 경로 wknd-spa-react/components/text 다음 표현: sling:resourceType AEM 구성 요소 이 경로는 :type 이전에 관찰된 JSON 모델에 의해 노출됩니다. MapTo json 모델 응답을 구문 분석하고 올바른 값을 다음과 같이 전달합니다. props SPA 구성 요소에 연결합니다.

    AEM을 찾을 수 있습니다. Text 구성 요소 정의 위치 ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/components/text.

React 핵심 구성 요소 사용

AEM WCM 구성 요소 - React 코어 구현AEM WCM 구성 요소 - Spa 편집기 - React 코어 구현. 즉시 사용 가능한 AEM 구성 요소에 매핑되는 재사용 가능한 UI 구성 요소 세트입니다. 대부분의 프로젝트는 이러한 구성 요소를 자체 구현을 위한 시작점으로 다시 사용할 수 있습니다.

  1. 프로젝트 코드에서 파일을 엽니다. import-components.js 위치: ui.frontend/src/components.
    이 파일은 AEM 구성 요소에 매핑되는 모든 SPA 구성 요소를 가져옵니다. SPA Editor 구현의 동적 특성이 주어지면 AEM 작성자 가능 구성 요소에 연결된 SPA 구성 요소를 명시적으로 참조해야 합니다. 이를 통해 AEM 작성자는 애플리케이션에서 원하는 위치에 구성 요소를 사용할 수 있습니다.

  2. 다음 가져오기 구문에는 프로젝트에 작성된 SPA 구성 요소가 포함됩니다.

    import './Page/Page';
    import './Text/Text';
    import './Container/Container';
    import './ExperienceFragment/ExperienceFragment';
    
  3. 몇 가지 다른 항목이 있습니다 imports 출처: @adobe/aem-core-components-react-spa@adobe/aem-core-components-react-base. React 코어 구성 요소를 가져와 현재 프로젝트에서 사용할 수 있도록 설정하는 것입니다. 그런 다음 를 사용하여 프로젝트별 AEM 구성 요소에 매핑됩니다. MapTo과 마찬가지로 Text 구성 요소 예제 이전.

AEM 정책 업데이트

정책은 개발자와 고급 사용자가 사용할 수 있는 구성 요소를 세부적으로 제어할 수 있는 AEM 템플릿의 기능입니다. React 코어 구성 요소는 SPA 코드에 포함되어 있지만 애플리케이션에서 사용하려면 정책을 통해 활성화해야 합니다.

  1. AEM 시작 화면에서 다음으로 이동합니다. 도구 > 템플릿 > WKND SPA React.

  2. 을(를) 선택하고 SPA 페이지 편집할 템플릿입니다.

  3. 다음 항목 선택 레이아웃 컨테이너 다음을 클릭합니다. 정책 아이콘을 클릭하여 정책을 편집합니다.

    레이아웃 컨테이너 정책

  4. 아래 허용된 구성 요소 > WKND SPA React - 콘텐츠 > 확인 이미지, 티저, 및 제목.

    업데이트된 구성 요소 사용 가능

    아래 기본 구성 요소 > 매핑 추가 및 선택 이미지 - WKND SPA React - 콘텐츠 구성 요소:

    기본 구성 요소 설정

    입력 mime 유형 / image/*.

    클릭 완료 정책 업데이트를 저장합니다.

  5. 다음에서 레이아웃 컨테이너 클릭: 정책 아이콘 텍스트 구성 요소.

    이름이 인 새 정책 만들기 WKND SPA 텍스트. 아래 플러그인 > 서식 > 모든 상자를 선택하여 추가 서식 옵션을 활성화합니다.

    RTE 서식 활성화

    아래 플러그인 > 단락 스타일 > 다음 확인란을 선택합니다. 단락 스타일 사용:

    단락 스타일 사용

    클릭 완료 정책 업데이트를 저장합니다.

콘텐츠 작성

  1. 다음 위치로 이동 홈페이지 http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html.

  2. 이제 추가 구성 요소를 사용할 수 있습니다 이미지, 티저, 및 제목 페이지에서 참조할 수 있습니다.

    추가 구성 요소

  3. 또한 을(를) 편집할 수 있어야 합니다. Text 구성 요소 및 의 추가 단락 스타일 추가 전체 화면 모드.

    전체 화면 서식 있는 텍스트 편집

  4. 에서 이미지를 드래그 앤 드롭할 수도 있습니다. 자산 파인더:

    이미지 드래그 앤 드롭

  5. 을 사용한 경험 제목티저 구성 요소.

  6. 을 통해 나만의 이미지 추가 AEM Assets 또는 standard의 완성된 코드 베이스를 설치합니다. WKND 참조 사이트. 다음 WKND 참조 사이트 에는 WKND SPA에서 다시 사용할 수 있는 많은 이미지가 포함되어 있습니다. 패키지를 설치하려면 AEM 패키지 관리자.

    패키지 관리자 설치 wknd.all

레이아웃 컨테이너 Inspect

지원 레이아웃 컨테이너 는 AEM SPA Editor SDK에서 자동으로 제공합니다. 다음 레이아웃 컨테이너​로 표시된 대로 는 입니다 컨테이너 구성 요소. 컨테이너 구성 요소는 다음을 나타내는 JSON 구조를 허용하는 구성 요소입니다. 기타 구성 요소를 만들고 동적으로 인스턴스화합니다.

레이아웃 컨테이너를 더 검사해 보겠습니다.

  1. 브라우저에서 다음 위치로 이동합니다 http://localhost:4502/content/wknd-spa-react/us/en.model.json

    JSON 모델 API - 응답형 그리드

    다음 레이아웃 컨테이너 구성 요소에 다음이 있음: sling:resourceType / wcm/foundation/components/responsivegrid 는 를 사용하여 SPA 편집기에서 인식됩니다. :type 속성입니다. TextImage 구성 요소.

    를 사용하여 구성 요소 크기를 재조정하는 것과 동일한 기능 레이아웃 모드 SPA 편집기에서 사용할 수 있습니다.

  2. 다음으로 돌아가기: http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html. 추가 항목 추가 이미지 구성 요소를 사용한 크기 조정 시도 레이아웃 옵션:

    레이아웃 모드를 사용하여 이미지 크기 조정

  3. JSON 모델 다시 열기 http://localhost:4502/content/wknd-spa-react/us/en.model.jsoncolumnClassNames JSON의 일부로:

    열 클래스 이름

    클래스 이름 aem-GridColumn--default--4 12열 그리드를 기준으로 구성 요소 너비가 4열이어야 함을 나타냅니다. 에 대한 자세한 내용 응답형 격자는 여기에서 찾을 수 있습니다..

  4. IDE로 돌아가서 ui.apps 모듈에는에 정의된 클라이언트측 라이브러리가 있습니다. ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/clientlibs/clientlib-grid. 파일 열기 less/grid.less.

    이 파일은 중단점(default, tablet, 및 phone)에서 사용함 레이아웃 컨테이너. 이 파일은 프로젝트 사양에 따라 사용자 지정하기 위한 것입니다. 현재 중단점이 다음으로 설정되어 있습니다. 1200px768px.

  5. 의 응답형 기능과 업데이트된 리치 텍스트 정책을 사용할 수 있어야 합니다. Text 다음과 같은 보기를 작성할 구성 요소:

    챕터 샘플 최종 작성

축하합니다!

축하합니다. SPA 구성 요소를 AEM 구성 요소에 매핑하는 방법을 배웠고 React 핵심 구성 요소를 사용했습니다. 또한 의 반응형 기능을 살펴볼 수 있습니다. 레이아웃 컨테이너.

다음 단계

탐색 및 라우팅 - SPA Editor SDK를 사용하여 SPA 페이지에 매핑하여 AEM의 여러 보기를 지원하는 방법에 대해 알아봅니다. 동적 탐색은 React Router 및 React 핵심 구성 요소를 사용하여 구현됩니다.

(보너스) 소스 제어에 구성을 유지합니다.

대부분의 경우, 특히 AEM 프로젝트 시작 시 소스 제어에 템플릿 및 관련 콘텐츠 정책과 같은 구성을 유지하는 것이 중요합니다. 이렇게 하면 모든 개발자가 동일한 콘텐츠 및 구성 세트에 대해 작업하고 환경 간에 추가적인 일관성을 보장할 수 있습니다. 일단 프로젝트가 일정 수준의 완성도에 도달하면 템플릿을 관리하는 관행을 특별한 고급 사용자 그룹에게 이관할 수 있습니다.

다음 몇 단계는 Visual Studio Code IDE 및 VSCode AEM 동기화 그러나 구성된 도구와 IDE를 사용하여 수행할 수 있습니다. 가져오기 또는 가져오기 AEM 로컬 인스턴스의 콘텐츠입니다.

  1. Visual Studio Code IDE에서 다음을 수행해야 합니다. VSCode AEM 동기화 marketplace 확장을 통해 설치:

    VSCode AEM 동기화

  2. 확장 ui.content 프로젝트 탐색기에서 모듈로 이동하여 /conf/wknd-spa-react/settings/wcm/templates.

  3. 마우스 오른쪽 단추 클릭 다음 templates 폴더 및 선택 AEM 서버에서 가져오기:

    VSCode 가져오기 템플릿

  4. 콘텐츠를 가져오려면 단계를 반복하되 정책 폴더 위치: /conf/wknd-spa-react/settings/wcm/templates/policies.

  5. Inspect filter.xml 파일 위치: ui.content/src/main/content/META-INF/vault/filter.xml.

    <!--ui.content filter.xml-->
    <?xml version="1.0" encoding="UTF-8"?>
     <workspaceFilter version="1.0">
         <filter root="/conf/wknd-spa-react" mode="merge"/>
         <filter root="/content/wknd-spa-react" mode="merge"/>
         <filter root="/content/dam/wknd-spa-react" mode="merge"/>
         <filter root="/content/experience-fragments/wknd-spa-react" mode="merge"/>
     </workspaceFilter>
    

    다음 filter.xml 파일은 패키지와 함께 설치된 노드의 경로를 식별합니다. 다음 사항에 주목합니다. mode="merge" 기존 콘텐츠가 수정되지 않음을 나타내는 각 필터에는 새 콘텐츠만 추가됩니다. 콘텐츠 작성자는 이러한 경로를 업데이트할 수 있으므로 코드 배포는 다음 작업을 수행하는 것이 중요합니다 아님 컨텐츠를 덮어씁니다. 다음을 참조하십시오. FileVault 설명서 필터 요소 작업에 대한 자세한 내용을 알아봅니다.

    비교 ui.content/src/main/content/META-INF/vault/filter.xmlui.apps/src/main/content/META-INF/vault/filter.xml 각 모듈에서 관리하는 서로 다른 노드를 이해합니다.

(보너스) 사용자 지정 이미지 구성 요소 만들기

SPA 이미지 구성 요소는 React 코어 구성 요소에서 이미 제공했습니다. 그러나 추가 연습을 원하는 경우 AEM에 매핑되는 자체 React 구현을 만드십시오 이미지 구성 요소. 다음 Image 구성 요소는 의 다른 예입니다. 콘텐츠 구성 요소.

JSON INSPECT

SPA 코드로 이동하기 전에 AEM에서 제공하는 JSON 모델을 검사합니다.

  1. 다음 위치로 이동 핵심 구성 요소 라이브러리의 이미지 예.

    이미지 핵심 구성 요소 JSON

    속성 src, alt, 및 title SPA을 채우는 데 사용됩니다. Image 구성 요소.

    노트

    다른 이미지 속성이 노출되었습니다(lazyEnabled, widths)를 입력하여 개발자가 적응형 및 소극적 로드 구성 요소를 만들 수 있습니다. 이 자습서에 빌드된 구성 요소는 간단하며 아님 다음 고급 속성을 사용합니다.

이미지 구성 요소 구현

  1. 그런 다음 (이)라는 이름의 새 폴더를 만듭니다. Image 아래에 ui.frontend/src/components.

  2. 아래 Image 폴더 (이)라는 이름의 새 파일을 만듭니다. Image.js.

    Image.js 파일

  3. 다음 추가 import 다음에 대한 문 Image.js:

    import React, {Component} from 'react';
    import {MapTo} from '@adobe/aem-react-editable-components';
    
  4. 그런 다음 를 추가합니다. ImageEditConfig AEM에 자리 표시자를 표시할 시기를 결정하려면 다음을 수행합니다.

    export const ImageEditConfig = {
    
        emptyLabel: 'Image',
    
        isEmpty: function(props) {
            return !props || !props.src || props.src.trim().length < 1;
        }
    };
    

    자리 표시자는 src 속성이 설정되지 않았습니다.

  5. 다음 구현 Image 클래스:

     export default class Image extends Component {
    
        get content() {
            return <img     className="Image-src"
                            src={this.props.src}
                            alt={this.props.alt}
                            title={this.props.title ? this.props.title : this.props.alt} />;
        }
    
        render() {
            if(ImageEditConfig.isEmpty(this.props)) {
                return null;
            }
    
            return (
                    <div className="Image">
                        {this.content}
                    </div>
            );
        }
    }
    

    위의 코드는 <img> prop을 기반으로 src, alt, 및 title json 모델에서 전달되었습니다.

  6. 추가 MapTo React 구성 요소를 AEM 구성 요소에 매핑하는 코드:

    MapTo('wknd-spa-react/components/image')(Image, ImageEditConfig);
    

    문자열을 확인합니다. wknd-spa-react/components/image 는 의 AEM 구성 요소 위치에 해당합니다. ui.apps 위치: ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/components/image.

  7. 이름이 인 새 파일 만들기 Image.css 를 동일한 디렉터리에 추가하고 다음을 추가합니다.

    .Image-src {
        margin: 1rem 0;
        width: 100%;
        border: 0;
    }
    
  8. 위치 Image.js 아래 맨 위에 있는 파일에 대한 참조 추가 import 문:

    import React, {Component} from 'react';
    import {MapTo} from '@adobe/aem-react-editable-components';
    
    require('./Image.css');
    
  9. 파일 열기 ui.frontend/src/components/import-components.js 및 새 항목에 대한 참조 추가 Image 구성 요소:

    import './Page/Page';
    import './Text/Text';
    import './Container/Container';
    import './ExperienceFragment/ExperienceFragment';
    import './Image/Image'; //add reference to Image component
    
  10. 위치 import-components.js react 핵심 구성 요소 이미지를 주석 처리합니다.

    //MapTo('wknd-spa-react/components/image')(ImageV2, {isEmpty: ImageV2IsEmptyFn});
    

    이렇게 하면 사용자 지정 이미지 구성 요소가 대신 사용됩니다.

  11. 프로젝트의 루트에서 Maven을 사용하여 SPA 코드를 AEM에 배포합니다.

    $ cd aem-guides-wknd-spa.react
    $ mvn clean install -PautoInstallSinglePackage
    
  12. AEM의 SPA Inspect. 페이지의 모든 이미지 구성 요소는 계속 작동해야 합니다. Inspect에 렌더링된 출력이 표시되면 React 코어 구성 요소 대신 사용자 지정 이미지 구성 요소에 대한 마크업이 표시됩니다.

    사용자 지정 이미지 구성 요소 마크업

    <div class="Image">
        <img class="Image-src" src="/content/image-src.jpg">
    </div>
    

    React 핵심 구성 요소 이미지 마크업

    <div class="cmp-image cq-dd-image">
        <img src="/content/image-src.jpg" class="cmp-image__image">
    </div>
    

    자체 구성 요소를 확장하고 구현하는 방법을 소개합니다.

이 페이지에서는