为AEM编辑器配置SPA

虽然SPA代码库是在AEM之外管理的,但需要AEM项目才能设置支持配置和内容要求。 本章将介绍如何创建包含必要配置的AEM项目:

  • AEM WCM核心组件代理
  • AEM远程SPA页面代理
  • AEM远程SPA页面模板
  • 基线远程SPA AEM页面
  • 用于定义SPA到AEM URL映射的子项目
  • OSGi配置文件夹

创建AEM项目

创建一个AEM项目,其中管理配置和基线内容。

始终使用最新版本的 AEM Archetype

$ mkdir -p ~/Code/wknd-app
$ cd ~/Code/wknd-app
$ mvn -B archetype:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=27 \
 -D aemVersion=cloud \
 -D appTitle="WKND App" \
 -D appId="wknd-app" \
 -D groupId="com.adobe.aem.guides.wkndapp" \
 -D frontendModule="react"
$ mv ~/Code/wknd-app/wknd-app ~/Code/wknd-app/com.adobe.aem.guides.wknd-app

最后一个命令只需重命名AEM项目文件夹,这样就可以清楚地知道它是AEM项目,并且不要与远程SPA混淆_

指定frontendModule="react"时,ui.frontend项目不用于远程SPA用例。 SPA是在AEM外部开发和管理的,仅将AEM用作内容API。 包含spa-project AEM Java™依赖项并设置远程SPA页面模板的项目需要frontendModule="react"标记。

AEM项目原型会生成以下元素,这些元素用于配置AEM以与SPA集成。

  • AEM WCM核心组件代理 程序 ui.content/src/.../apps/wknd-app/components
  • AEM SPA Remote Page代ui.content/src/.../apps/wknd-app/components/remotepage
  • AEM页面模ui.content/src/.../conf/wknd-app/settings/wcm/templates
  • 用于定义内容映射的子项ui.content/src/...
  • 基线远程SPA AEM页ui.content/src/.../content/wknd-app
  • OSGi配置文 件夹 ui.config/src/.../apps/wknd-app/osgiconfig

生成基本AEM项目后,进行一些调整可确保SPA编辑器与远程SPA兼容。

删除ui.frontend项目

由于SPA是远程SPA,因此假定它是在AEM项目之外开发和管理的。 要避免冲突,请从部署中删除ui.frontend项目。 如果未删除ui.frontend项目,则将同时在AEM SPA编辑器中加载ui.frontend项目和远程SPA中提供的两个SPA(默认的SPA)。

  1. 在IDE中打开AEM项目(~/Code/wknd-app/com.adobe.aem.guides.wknd-app)

  2. 打开根pom.xml

  3. <modules>列表中注释<module>ui.frontend</module

    <modules>
        <module>all</module>
        <module>core</module>
    
        <!-- <module>ui.frontend</module> -->
    
        <module>ui.apps</module>
        <module>ui.apps.structure</module>
        <module>ui.config</module>
        <module>ui.content</module>
        <module>it.tests</module>
        <module>dispatcher</module>
        <module>ui.tests</module>
        <module>analyse</module>
    </modules>
    

    pom.xml文件应该如下所示:

    从Reactor pom中删除ui.frontend模块

  4. 打开ui.apps/pom.xml

  5. 注释<artifactId>wknd-app.ui.frontend</artifactId>上的<dependency>

    <dependencies>
    
        <!-- Remote SPA project will provide all frontend resources
        <dependency>
            <groupId>com.adobe.aem.guides.wkndapp</groupId>
            <artifactId>wknd-app.ui.frontend</artifactId>
            <version>${project.version}</version>
            <type>zip</type>
        </dependency>
        -->
    </dependencies>
    

    ui.apps/pom.xml文件应该如下所示:

    从ui.apps中删除ui.frontend依赖项

如果AEM项目是在这些更改之前构建的,请从ui.apps项目(ui.apps/src/main/content/jcr_root/apps/wknd-app/clientlibs/clientlib-react)中手动删除ui.frontend生成的客户端库。

AEM内容映射

要使AEM在SPA编辑器中加载远程SPA,必须建立SPA路由和用于打开和创作内容的AEM页面之间的映射。

此配置的重要性稍后会进行探讨。

映射可以通过在/etc/map中定义的Sling映射来完成。

  1. 在IDE中,打开ui.content子项目

  2. 导航至 src/main/content/jcr_root/etc

  3. 创建文件夹map

  4. map中创建文件夹http

  5. http中,创建包含以下内容的文件.content.xml:

    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
        jcr:primaryType="sling:Mapping">
        <localhost_any/>
    </jcr:root>
    
  6. http中,创建文件夹localhost_any

  7. localhost_any中,创建包含以下内容的文件.content.xml:

    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
        jcr:primaryType="sling:Mapping"
        sling:match="localhost\\.\\d+">
        <wknd-app-routes-adventure/>
    </jcr:root>
    
  8. localhost_any中,创建文件夹wknd-app-routes-adventure

  9. wknd-app-routes-adventure中,创建包含以下内容的文件.content.xml:

    <?xml version="1.0" encoding="UTF-8"?>
    
    <!--
    The 'wknd-app-routes-adventure' mapping, maps requests to the SPA's adventure route
    to it's corresponding page in AEM at /content/wknd-app/us/en/home/adventure/xxx.
    
    Note the adventure AEM pages will be created directly in AEM.
    -->
    
    <jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
        jcr:primaryType="sling:Mapping"
        sling:match="adventure:.*/([^/]+)/?$"
        sling:internalRedirect="/content/wknd-app/us/en/home/adventure/$1"/>
    
  10. 将映射节点添加到AEM包中包含的ui.content/src/main/content/META-INF/vault/filter.xml中。

    <?xml version="1.0" encoding="UTF-8"?>
    <workspaceFilter version="1.0">
        <filter root="/conf/wknd-app" mode="merge"/>
        <filter root="/content/wknd-app" mode="merge"/>
        <filter root="/content/dam/wknd-app/asset.jpg" mode="merge"/>
        <filter root="/content/experience-fragments/wknd-app" mode="merge"/>
    
        <!-- Add the Sling Mapping rules for the WKND App -->
        <filter root="/etc/map" mode="merge"/>
    </workspaceFilter>
    

文件夹结构和.context.xml文件应如下所示:

Sling映射

filter.xml文件应该如下所示:

Sling映射

现在,部署AEM项目时,会自动包含这些配置。

Sling映射会影响在httplocalhost上运行的AEM,因此仅支持本地开发。 在将AEM作为Cloud Service部署时,必须添加类似的Sling映射,以便将目标https和相应的AEM作为Cloud Service域。 有关更多信息,请参阅Sling映射文档

跨源资源共享安全策略

接下来,配置AEM以保护内容,以便只有此SPA可以访问AEM内容。 C在AEM🔗中配置跨域资源共享。

  1. 在IDE中,打开ui.config Maven子项目

  2. 导航 src/main/content/jcr_root/apps/wknd-app/osgiconfig/config

  3. 创建名为com.adobe.granite.cors.impl.CORSPolicyImpl~wknd-app_remote-spa.cfg.json的文件

  4. 将以下内容添加到文件中:

    {
        "supportscredentials":true,
        "exposedheaders":[
            ""
        ],
        "supportedmethods":[
            "GET",
            "HEAD",
            "POST",
            "OPTIONS"
        ],
        "alloworigin":[
            "https://external-hosted-app", "localhost:3000"
        ],
        "maxage:Integer":1800,
        "alloworiginregexp":[
            ".*"
        ],
        "allowedpaths":[
            ".*"
        ],
        "supportedheaders":[
            "Origin",
            "Accept",
            "X-Requested-With",
            "Content-Type",
            "Access-Control-Request-Method",
            "Access-Control-Request-Headers",
            "Authorization"
        ]
    }
    

com.adobe.granite.cors.impl.CORSPolicyImpl~wknd-app_remote-spa.cfg.json文件应该如下所示:

SPA编辑器CORS配置

关键配置元素包括:

  • alloworigin 指定允许哪些主机从AEM检索内容。
    • localhost:3000 添加了以支持在本地运行的SPA
    • https://external-hosted-app 用作占位符,以替换为Remote SPA托管的域。
  • allowedpaths 指定此CORS配置涵盖AEM中的哪些路径。默认设置允许访问AEM中的所有内容,但其范围只能为SPA可访问的特定路径,例如:/content/wknd-app

将AEM页面设置为远程SPA页面模板

AEM项目原型会生成一个为AEM与远程SPA集成做准备的项目,但需要对自动生成的AEM页面结构进行细微而重要的调整。 自动生成的AEM页面必须将其类型更改为​远程SPA页面,而不是​SPA页面

  1. 在IDE中,打开ui.content子项目

  2. 打开至src/main/content/jcr_root/content/wknd-app/us/en/home/.content.xml

  3. 使用以下项更新此.content.xml文件:

    <?xml version="1.0" encoding="UTF-8"?>
    <jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
            jcr:primaryType="cq:Page">
        <jcr:content
            cq:template="/conf/wknd-app/settings/wcm/templates/spa-remote-page"
            jcr:primaryType="cq:PageContent"
            jcr:title="WKND App Home Page"
            sling:resourceType="wknd-app/components/remotepage">
            <root
                jcr:primaryType="nt:unstructured"
                sling:resourceType="wcm/foundation/components/responsivegrid">
                <responsivegrid
                    jcr:primaryType="nt:unstructured"
                    sling:resourceType="wcm/foundation/components/responsivegrid">
                    <text
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="wknd-app/components/text"
                        text="&lt;p>Hello World!&lt;/p>"
                        textIsRich="true">
                        <cq:responsive jcr:primaryType="nt:unstructured"/>
                    </text>
                </responsivegrid>
            </root>
        </jcr:content>
    </jcr:root>
    

关键更改是对jcr:content节点的:

  • cq:template/conf/wknd-app/settings/wcm/templates/spa-remote-page
  • sling:resourceTypewknd-app/components/remotepage

src/main/content/jcr_root/content/wknd-app/us/en/home/.content.xml文件应该如下所示:

主页.content.xml更新

这些更改允许此页面(在AEM中充当SPA根)在SPA编辑器中加载远程SPA。

注意

如果此项目之前是AEM的项目,请确保将AEM页面作为​__站点> WKND应用程序>用户> en > WKND应用程序主页__​删除,因为ui.content项目被设置为​__merge__​节点,而不是​__update__。

此页面也可以删除,并重新创建为AEM中的远程SPA页面,但是,由于此页面是在ui.content项目中自动创建的,因此最好在代码库中更新它。

将AEM项目部署到AEM SDK

  1. 确保AEM创作服务在端口4502上运行

  2. 从命令行中,导航到AEM Maven项目的根

  3. 使用Maven将项目部署到本地AEM SDK创作服务

    $ mvn clean install -PautoInstallSinglePackage
    

    mvn clean install -PautoInstallSinglePackage

配置根AEM页面

部署AEM项目后,需要最后一步来准备SPA Editor以加载我们的远程SPA。 在AEM中,标记与AEM项目原型生成的SPA根目录/content/wknd-app/us/en/home对应的AEM页面。

  1. 登录到AEM作者

  2. 导航至​站点> WKND应用程序>使用> en

  3. 选择​WKND应用程序主页,然后点按​属性

    WKND应用程序主页 — 属性

  4. 导航到​SPA​选项卡

  5. 填写​远程SPA配置

    • SPA主机URL: http://localhost:3000
      • 指向远程SPA根的URL

    WKND应用程序主页 — 远程SPA配置

  6. 点按​保存并关闭

请记住,我们已将此页面的类型更改为​远程SPA页面​的类型,这样我们便能够在其​页面属性​中查看​SPA​选项卡。

此配置只能在与SPA根对应的AEM页面上设置。 此页面下方的所有AEM页面都将继承该值。

恭喜

您现在已准备好AEM配置并将其部署到本地AEM作者! 您现在知道如何:

  • 通过注释掉ui.frontend中的依赖项,删除AEM项目原型生成的SPA
  • 将Sling映射添加到AEM,以将SPA路由映射到AEM中的资源
  • 设置AEM跨源资源共享安全策略,以允许远程SPA使用AEM中的内容
  • 将AEM项目部署到本地AEM SDK创作服务
  • 使用AEM主机URL页面属性将SPA页面标记为远程SPA根

后续步骤

配置了AEM后,我们可以将重点放在引导远程SPA上,同时支持使用AEM SPA编辑器来编辑区域!

在此页面上