AEM 项目结构

小贴士

熟悉基本 AEM项目原型使用FileVault Content Maven插件 因为本文基于这些学习和概念。

本文概述了Adobe Experience Manager Maven项目需要进行的更改,这些更改将通过确保AEM与可变和不可变内容的拆分保持一致,建立依赖关系以创建无冲突的确定性部署,并将它们打包为可部署的结构,从而实现as a Cloud Service兼容。

AEM应用程序部署必须由单个AEM包组成。 此包又应包含子包,子包包含应用程序正常运行所需的所有内容,包括代码、配置和任何支持的基线内容。

AEM 要求将​内容​和​代码​分离,这意味着单个内容包​不能同时​部署到存储库的 /apps 和到运行时可写区域(例如,/content/conf/home/apps 以外的任何区域)。相反,应用程序必须将代码和内容分离到离散包中,以部署到 AEM 中。

本文档中概述的包结构与本地开发部署​ AEM 云服务部署兼容。

小贴士

本文档中概述的配置由 AEM Project Maven Archetype 24或更高版本.

存储库的可变区域与不可变区域

/apps/libs被视为 AEM 中的不可变区域,因为 AEM 启动后(例如,运行时),无法对其进行更改(创建、更新、删除)。​运行时对不可改变区域所做的任何更改尝试都将失败。

存储库中的所有其他内容, /content, /conf, /var, /etc, /oak:index, /system, /tmp等。 全部 可变 区域,即可在运行时更改这些区域。

警告

与以前版本的AEM一样, /libs 不应修改。 只有AEM产品代码可以部署到 /libs.

Oak索引

Oak索引(/oak:index)由AEMas a Cloud Service部署过程专门管理。 这是因为Cloud Manager必须等待任何新索引部署完毕并完全重新编入索引后,才能切换到新代码图像。

因此,尽管Oak索引在运行时是可变的,但必须将其部署为代码,以便在安装任何可变包之前能够安装它们。 因此 /oak:index 配置是代码包的一部分,而不是内容包的一部分 如下所述.

小贴士

有关在AEMas a Cloud Service中索引的更多详细信息,请参阅此文档 内容搜索和索引.

Experience Manager项目包结构

此图表概述了建议的项目结构和包部署工件。

推荐的应用程序部署结构如下:

代码包/ OSGi包

  • 将生成OSGi包Jar文件,并直接嵌入到所有项目中。

  • ui.apps 包中包含要部署的所有代码,并且只部署到 /apps. 的常见元素 ui.apps 包包含,但不限于:

注意

必须将相同的代码部署到所有环境。 为确保在生产环境中也进行置信度验证,需要此功能。 有关更多信息,请参阅 运行模式.

内容包

  • ui.content 包包含所有内容和配置。 内容包包含所有节点定义,这些定义不在 ui.appsui.config 包,换言之, /apps/oak:index. 的常见元素 ui.content 包包含,但不限于:
    • 上下文感知配置
      • /conf
    • 必需且复杂的内容结构(即 内容构建,该构建基于并扩展了在存储库初始化中定义的过去基线内容结构。)
      • /content, /content/dam, 等.
    • 受管制的标记分类
      • /content/cq:tags
    • 旧版等节点(理想情况下,将这些节点迁移到非/等位置)
      • /etc

容器包

  • all 包是一个仅包含可部署工件的容器包,即OSGI包Jar文件, ui.apps, ui.configui.content 包作为嵌入内容。 的 all 包不能 任何内容或代码 ,而是将所有部署委派到存储库的子包或OSGi包Jar文件。

    现在,使用Maven包含包 FileVault Package Maven插件的嵌入式配置,而不是 <subPackages> 配置。

    对于复杂的Experience Manager部署,可能需要创建多个 ui.apps, ui.configui.content 表示AEM中特定站点或租户的项目/包。 如果完成此操作,请确保在可变内容和不可变内容之间进行拆分,并且所需的内容包和OSGi包Jar文件将作为子包嵌入到 all 容器内容包。

    例如,复杂的部署内容包结构可能如下所示:

    • all 内容包嵌入了以下包,以创建单个部署对象
      • common.ui.apps 部署代码 both 网站A和网站B
      • site-a.core 站点A所需的OSGi包Jar
      • site-a.ui.apps 部署站点A所需的代码
      • site-a.ui.config 部署站点A所需的OSGi配置
      • site-a.ui.content 部署站点A所需的内容和配置
      • site-b.core 站点B所需的OSGi包Jar
      • site-b.ui.apps 部署站点B所需的代码
      • site-b.ui.config 部署站点B所需的OSGi配置
      • site-b.ui.content 部署站点B所需的内容和配置
  • ui.config 包包含所有 OSGi配置:

    • 考虑了代码,属于OSGi包,但不包含常规内容节点。 因此,它被标记为容器包
    • 包含特定于运行模式的OSGi配置定义的组织文件夹
      • /apps/my-app/osgiconfig
    • 通用OSGi配置文件夹,其中包含适用于所有目标AEMas a Cloud Service部署目标的默认OSGi配置
      • /apps/my-app/osgiconfig/config
    • 运行特定于模式的OSGi配置文件夹,其中包含应用于所有目标AEMas a Cloud Service部署目标的默认OSGi配置
      • /apps/my-app/osgiconfig/config.<author|publish>.<dev|stage|prod>
    • Repo Init OSGi配置脚本
      • Repo Init 是部署(可变)内容(从逻辑上讲,这些内容是AEM应用程序的一部分)的推荐方法。 Repo Init OSGi配置应位于相应的 config.<runmode> 文件夹(如上所述),并用于定义:
        • 基线内容结构
        • 用户
        • 服务用户
        • ACL(权限)

其他应用程序包

如果AEM部署使用了其他AEM项目(这些项目本身由它们自己的代码和内容包组成),则应将其容器包嵌入项目的 all 包。

例如,包含2个供应商AEM应用程序的AEM项目可能如下所示:

  • all 内容包嵌入了以下包,以创建单个部署对象
    • core AEM应用程序所需的OSGi包Jar
    • ui.apps 部署AEM应用程序所需的代码
    • ui.config 部署AEM应用程序所需的OSGi配置
    • ui.content 部署AEM应用程序所需的内容和配置
    • vendor-x.all 部署供应商X应用程序所需的所有内容(代码和内容)
    • vendor-y.all 部署供应商Y应用程序所需的所有内容(代码和内容)

包类型

将使用其声明的包类型标记包。 包类型有助于阐明包的用途和部署。

  • 容器包必须设置 packageType to container. 容器包不得包含常规节点。 只允许使用OSGi包、配置和子包。 AEMas a Cloud Service中的容器不允许使用 安装挂钩.
  • 代码(不可变)包必须设置其 packageType to application.
  • 内容(可变)包必须设置其 packageType to content.

有关详细信息,请参阅 Apache Jackrabbit FileVault — 包Maven插件文档, Apache Jackrabbit包类型FileVault Maven配置代码段 下。

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

标记要由Adobe Cloud Manager部署的Adobe包

默认情况下,Adobe Cloud Manager 会收集由 Maven 内部版本生成的所有包,但是,由于容器 (all) 包是包含所有代码和内容包的单个部署对象,因此我们必须确保​​部署容器 (all) 包。要确保这一点,Maven 内部版本生成的其他包必须使用 <properties><cloudManagerTarget>none</cloudManageTarget></properties> 的 FileVault Content Package Maven Plug-In 配置进行标记。

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

Repo Init

Repo Init提供了定义JCR结构的指令或脚本,这些结构从常见的节点结构(如文件夹树)到用户、服务用户、组和ACL定义。

Repo Init的主要优势在于它们具有执行其脚本定义的所有操作的隐式权限,并且可在部署生命周期的早期调用,以确保执行时间代码时存在所有必需的JCR结构。

而Repo Init脚本本身位于 ui.config 项目作为脚本,可以且应该使用它们来定义以下可变结构:

  • 基线内容结构
  • 服务用户
  • 用户
  • ACL

Repo Init脚本存储为 scripts 条目 RepositoryInitializer 因此,OSGi工厂配置可以通过运行模式隐式定位,从而允许AEM创作和AEM发布服务的存储库初始脚本之间,甚至环境(开发、暂存和生产)之间存在差异。

存储库初始化OSGi配置最好在 .config OSGi配置格式 因为它们支持多行,这是使用的最佳实践的例外 .cfg.json 定义OSGi配置.

请注意,在定义“用户”和“组”时,只有组被视为应用程序的一部分,并且应在此处定义其功能的组成部分。 组织用户和组仍应在AEM中在运行时进行定义;例如,如果自定义工作流将工作分配给指定的组,则应通过AEM应用程序中的Repo Init在中定义该组,但如果该组只是组织性的,如“Wendy's Team”和“Sean's Team”,则最好定义这些工作,并在AEM中运行时进行管理。

小贴士

Repo Init脚本 必须 在内联中定义 scripts 字段,以及 references 配置将不起作用。

Apache Sling Repo Init文档.

小贴士

请参阅 Repo Init代码段 部分以了解完整的代码片段。

存储库结构包

代码包需要配置FileVault Maven插件的配置以引用 <repositoryStructurePackage> 强制执行结构依赖项的正确性(以确保一个代码包不会安装在另一个代码包上)。 您可以 为项目创建自己的存储库结构包.

此操作​仅适用于​代码包,即任何标有 <packageType>application</packageType> 的包。

要了解如何为应用程序创建存储库结构包,请参阅 开发存储库结构包.

请注意,内容包(<packageType>content</packageType>) 需要此存储库结构包。

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

在容器软件包中嵌入子软件包

内容或代码包放置在特殊的“侧车”文件夹中,并且可以定位在AEM作者、AEM发布或两者上,使用FileVault Maven插件进行安装 <embeddeds> 配置。 请注意, <subPackages> 不应使用配置。

常见用例包括:

  • AEM创作用户和AEM发布用户之间的ACL/权限不同
  • 仅用于在AEM作者上支持活动的配置
  • 代码(如与后台系统的集成),仅在AEM作者上运行时才需要

嵌入包

要定位AEM作者、AEM发布或两者兼有,包将嵌入到 all 文件夹位置中的容器包,格式如下:

/apps/<app-name>-packages/(content|application|container)/install(.author|.publish)?

划分此文件夹结构:

  • 第1级文件夹 必须 /apps.

  • 第2级文件夹表示 -packages 后修复到文件夹名称。 通常,所有子包都只嵌入一个第2级文件夹,但可以创建任意数量的第2级文件夹以最好地表示应用程序的逻辑结构:

    • /apps/my-app-packages
    • /apps/my-other-app-packages
    • /apps/vendor-packages
    警告

    按照惯例,子包嵌入式文件夹的名称带有后缀 -packages。这样可确保部署代码和内容包​不会​部署到任何子包 /apps/<app-name>/... 的目标文件夹,否则将会导致破坏性的循环安装行为。

  • 第3级文件夹必须是
    application, contentcontainer

    • application 文件夹包含代码包
    • content 文件夹包含内容包
    • container 文件夹包含任何 额外的应用程序包 可能包含在AEM应用程序中。
      此文件夹名称对应于 包类型 包中的包。
  • 第 4 级文件夹包含子包,且必须是以下包之一:

    • install,以在 AEM 作者​ AEM 发布上安装
    • install.author,以​​在 AEM 作者上安装
    • install.publish to 在AEM发布时安装注意: install.authorinstall.publish 是受支持的目标。 不支持其 他运行模式

例如,包含AEM作者和发布特定包的部署可能如下所示:

  • all 容器包嵌入以下包,以创建单个部署对象
    • ui.apps 嵌入式 /apps/my-app-packages/application/install 将代码部署到AEM作者和AEM发布
    • ui.apps.author 嵌入式 /apps/my-app-packages/application/install.author 仅将代码部署到AEM作者
    • ui.content 嵌入式 /apps/my-app-packages/content/install 将内容和配置部署到AEM作者和AEM发布
    • ui.content.publish 嵌入式 /apps/my-app-packages/content/install.publish 将内容和配置仅部署到AEM发布
小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

容器包的过滤器定义

由于在容器包中嵌入了代码和内容子包,因此必须将嵌入的目标路径添加到容器项目的 filter.xml 以确保在构建时将嵌入式包包含在容器包中。

只需将 <filter root="/apps/<my-app>-packages"/> 包含要部署的子包的任何第2级文件夹的条目。

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

嵌入第三方包

所有包都必须通过 Adobe的公共Maven对象存储库 或可访问的公共、可引用的第三方Maven对象存储库。

如果第三方包位于 Adobe 的公共 Maven 对象存储库,则 Adobe Cloud Manager 无需进一步配置即可解析对象。

如果第三方包位于​公共的第三方 Maven 对象存储库,则必须在项目的 pom.xml 中注册此存储库,并将其嵌入到以上所述的以下方法中。

第三方应用程序/连接器应使用其 all 包作为项目容器中的容器(all)包。

添加Maven依赖项遵循标准的Maven惯例,并嵌入第三方工件(代码和内容包) 上述.

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

包之间的依赖关系 ui.appsui.content

为确保正确安装软件包,建议建立软件包间依赖关系。

一般规则是包含可变内容(ui.content)应依赖于不可变代码(ui.apps),用于支持可变内容的渲染和使用。

此常规规则的一个显着例外是,如果不可变代码包(ui.apps 或其他任何人)、 包含OSGi包。 如果是,则任何AEM包都不应声明对它的依赖关系。 这是因为不可变代码包 包含的OSGi包未在AEM中注册 包管理器、 因此,任何依赖于AEM包的依赖项都将不满足要求,且无法安装。

小贴士

请参阅 POM XML片段 部分以了解完整的代码片段。

内容包依赖关系的常见模式包括:

简单部署包依赖项

简单的用例可设置 ui.content 可变的内容包依赖于 ui.apps 不可变代码包。

  • all 没有依赖项
    • ui.apps 没有依赖项
    • ui.content 取决于 ui.apps

复杂的部署包依赖项

复杂的部署会根据简单的情况进行扩展,并设置相应可变内容和不可变代码包之间的依赖关系。 根据需要,还可以在不可变代码包之间建立依赖关系。

  • all 没有依赖项
    • common.ui.apps.common 没有依赖项
    • site-a.ui.apps 取决于 common.ui.apps
    • site-a.ui.content 取决于 site-a.ui.apps
    • site-b.ui.apps 取决于 common.ui.apps
    • site-b.ui.content 取决于 site-b.ui.apps

本地开发和部署

本文概述的项目结构和组织是 完全兼容 本地开发AEM实例。

POM XML片段

以下是Maven pom.xml 可添加到Maven项目以符合上述建议的配置片段。

包类型

作为子包部署的代码和内容包必须声明​应用程序​或​内容​包类型,具体取决于它们包含的内容。

容器包类型

容器 all/pom.xml 项目 声明 <packageType>.

代码(不可变)包类型

代码包必须设置 packageType to application.

ui.apps/pom.xml, <packageType>application</packageType> 构建配置指令 filevault-package-maven-plugin 插件声明声明其包类型。

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        <group>${project.groupId}</group>
        <name>my-app.ui.apps</name>
        <packageType>application</packageType>
        <accessControlHandling>merge</accessControlHandling>
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

内容(可变)包类型

内容包必须设置 packageType to content.

ui.content/pom.xml, <packageType>content</packageType> 构建配置指令 filevault-package-maven-plugin 插件声明声明其包类型。

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        <group>${project.groupId}</group>
        <name>my-app.ui.content</name>
        <packageType>content</packageType>
        <accessControlHandling>merge</accessControlHandling>
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

为AdobeCloud Manager部署标记包

在生成包的每个项目中,​容器 (all) 项目外,将 <cloudManagerTarget>none</cloudManagerTarget> 添加到 filevault-package-maven-plugin 插件声明的 <properties> 配置中,以确保 Adobe Cloud Manager ​部署这些它们。容器(all)包应是通过Cloud Manager部署的单个包,Cloud Manager又嵌入所有必需的代码和内容包。

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        ...
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

Repo Init

包含Repo Init脚本的Repo Init脚本在 RepositoryInitializer 通过 scripts 属性。 请注意,由于这些脚本是在OSGi配置中定义的,因此可以使用常规的运行模式轻松确定其范围 ../config.<runmode> 文件夹语义。

请注意,由于脚本通常是多行声明,因此在 .config 文件,而不是基于JSON的 .cfg.json 格式。

/apps/my-app/config.author/org.apache.sling.jcr.repoinit.RepositoryInitializer-author.config

scripts=["
    create service user my-data-reader-service

    set ACL on /var/my-data
        allow jcr:read for my-data-reader-service
    end

    create path (sling:Folder) /conf/my-app/settings
"]

scripts OSGi属性包含由 Apache Sling的Repo Init语言.

存储库结构包

ui.apps/pom.xmlpom.xml 声明了代码包(<packageType>application</packageType>),将以下存储库结构包配置添加到FileVault Maven插件。 您可以 为项目创建自己的存储库结构包.

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        ...
        <repositoryStructurePackages>
          <repositoryStructurePackage>
              <groupId>${project.groupId}</groupId>
              <artifactId>ui.apps.structure</artifactId>
              <version>${project.version}</version>
          </repositoryStructurePackage>
        </repositoryStructurePackages>
      </configuration>
    </plugin>
    ...

在容器软件包中嵌入子软件包

all/pom.xml,添加以下内容 <embeddeds> 指令 filevault-package-maven-plugin 插件声明。 记住, 使用 <subPackages> 配置,因为这将包含 /etc/packages 而不是 /apps/my-app-packages/<application|content|container>/install(.author|.publish)?.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <embeddeds>

          <!-- Include the application's ui.apps and ui.content packages -->
          <!-- Ensure the artifactIds are correct -->

          <!-- OSGi Bundle Jar file that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.core</artifactId>
              <type>jar</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

          <!-- Code package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.apps</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

           <!-- OSGi configuration code package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.config</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

          <!-- Code package that deploys ONLY to AEM Author -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.apps.author</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install.author</target>
          </embedded>

          <!-- Content package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.content</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/content/install</target>
          </embedded>

          <!-- Content package that deploys ONLY to AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.content.publish-only</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/content/install.publish</target>
          </embedded>

          <!-- Include any other extra packages  -->
          <embedded>
              <groupId>com.vendor.x</groupId>
              <artifactId>vendor.plug-in.all</artifactId>
              <type>zip</type>
              <target>/apps/vendor-packages/container/install</target>
          </embedded>
      <embeddeds>
  </configuration>
</plugin>
...

容器包的过滤器定义

all 项目的 filter.xml (all/src/main/content/jcr_root/META-INF/vault/definition/filter.xml) 中,包括​要部署的任何包含子包的 -packages 文件夹:

<filter root="/apps/my-app-packages"/>

如果为多个 /apps/*-packages 在嵌入的目标中使用,则必须在此处枚举所有这些目标。

第三方Maven存储库

警告

添加更多Maven存储库可能会延长Maven内部版本生成时间,因为将检查其他Maven存储库是否存在依赖关系。

在反应堆工程的 pom.xml,添加任何必需的第三方公共Maven存储库指令。 完整 <repository> 配置应可从第三方存储库提供程序中使用。

<repositories>
  ...
  <repository>
      <id>3rd-party-repository</id>
      <name>Public 3rd Party Repository</name>
      <url>https://repo.3rdparty.example.com/...</url>
      <releases>
          <enabled>true</enabled>
          <updatePolicy>never</updatePolicy>
      </releases>
      <snapshots>
          <enabled>false</enabled>
      </snapshots>
  </repository>
  ...
</repositories>

包之间的依赖关系 ui.appsui.content

ui.content/pom.xml,添加以下内容 <dependencies> 指令 filevault-package-maven-plugin 插件声明。

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <dependencies>
        <!-- Declare the content package dependency in the ui.content/pom.xml on the ui.apps project -->
        <dependency>
            <groupId${project.groupId}</groupId>
            <artifactId>my-app.ui.apps</artifactId>
            <version>${project.version}</version>
        </dependency>
      </dependencies>
    ...
  </configuration>
</plugin>
...

清除容器项目的目标文件夹

all/pom.xml 添加 maven-clean-plugin 插件,该插件将在生成Maven之前清理target目录。

<plugins>
  ...
  <plugin>
    <artifactId>maven-clean-plugin</artifactId>
    <executions>
      <execution>
        <id>auto-clean</id>
        <!-- Run at the beginning of the build rather than the default, which is after the build is done -->
        <phase>initialize</phase>
        <goals>
          <goal>clean</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
  ...
</plugins>

其他资源

在此页面上