AEM 项目存储库结构包

Adobe Experience Manager as a Cloud Service的Maven项目需要存储库结构子包定义,其唯一用途是定义项目的代码子包部署到其中的JCR存储库根。 此方法确保按照JCR资源依赖关系对Experience Manageras a Cloud Service中包的安装自动排序。 缺少依赖项可能会导致出现以下情况:子结构将安装在父结构之前,因此被意外移除,从而破坏部署。

如果您的代码包部署到位置 未涵盖 之后,必须在存储库结构包中枚举任何上级资源(比较靠近JCR根的JCR资源)。 建立这些依赖关系需要此过程。

存储库结构包

存储库结构包定义了的预期、常见状态 /apps 包验证器用来确定“免受潜在冲突影响”的区域,因为它们是标准根。

要包含在存储库结构包中的最典型路径包括:

  • /apps 即系统提供的节点
  • /apps/cq/.../apps/dam/.../apps/wcm/...、和 /apps/sling/... 这些组件为提供公共覆盖 /libs.
  • /apps/settings 这是共享的上下文感知配置根路径

此子包 没有 任何内容,且仅由 pom.xml 定义过滤器根。

创建存储库结构包

要为Maven项目创建存储库结构包,请创建一个空的Maven子项目,该项目包含以下内容 pom.xml,更新项目元数据以符合父Maven项目。

更新 <filters> 要包含所有JCR存储库路径,请将您的代码包部署到的根。

确保将此新的Maven子项目添加到父项目 <modules> 列表。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- ====================================================================== -->
    <!-- P A R E N T  P R O J E C T  D E S C R I P T I O N                      -->
    <!-- ====================================================================== -->
    <parent>
        <groupId>com.my-company</groupId>
        <artifactId>my-app</artifactId>
        <version>x.x.x</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <!-- ====================================================================== -->
    <!-- P R O J E C T  D E S C R I P T I O N                                   -->
    <!-- ====================================================================== -->
    <artifactId>ui.apps.structure</artifactId>
    <packaging>content-package</packaging>
    <name>UI Apps Structure - Repository Structure Package for /apps</name>

    <description>
        Empty package that defines the structure of the Adobe Experience Manager repository the code packages in this project deploy into.
        Any roots in the code packages of this project should have their parent enumerated in the filters list below.
    </description>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.jackrabbit</groupId>
                <artifactId>filevault-package-maven-plugin</artifactId>
                <extensions>true</extensions>
                <properties>
                    <!-- Set Cloud Manager Target to none, else this package is deployed and remove all defined filter roots -->
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
                <configuration>
                    <properties>
                        <!-- Set Cloud Manager Target to none, else this package is deployed and remove all defined filter roots -->
                        <cloudManagerTarget>none</cloudManagerTarget>
                    </properties>
                    <filters>

                        <!-- /apps root -->
                        <filter><root>/apps</root></filter>

                        <!--
                        Examples of complex roots


                        Overlays of /libs typically require defining the overlay structure, at each level here.

                        For example, adding a new section to the main AEM Tools navigation, necessitates the following rules:

                        <filter><root>/apps/cq</root></filter>
                        <filter><root>/apps/cq/core</root></filter>
                        <filter><root>/apps/cq/core/content</root></filter>
                        <filter><root>/apps/cq/core/content/nav/</root></filter>
                        <filter><root>/apps/cq/core/content/nav/tools</root></filter>


                        Any /apps level Context-aware configurations need to enumerated here.

                        For example, providing email templates under `/apps/settings/notification-templates/com.day.cq.replication` necessitates the following rules:

                        <filter><root>/apps/settings</root></filter>
                        <filter><root>/apps/settings/notification-templates</root></filter>
                        <filter><root>/apps/settings/notification-templates/com.day.cq.replication</root></filter>
                        -->

                    </filters>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

引用存储库结构包

要使用存储库结构包,请通过部署到的所有代码包(子包)引用它 /apps) Maven项目(通过FileVault内容包Maven插件) <repositoryStructurePackage> 配置。

ui.apps/pom.xml和任何其他代码包 pom.xmls,将项目存储库结构包(#repository-structure-package)配置的引用添加到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>
    ...
</build>
<dependencies>
    <!-- Add the dependency for the repository structure package so it resolves -->
    <dependency>
        <groupId>${project.groupId}</groupId>
        <artifactId>ui.apps.structure</artifactId>
        <version>${project.version}</version>
        <type>zip</type>
    </dependency>
    ...
</dependencies>

多代码包用例

不太常见、但更复杂的用例支持部署多个代码包,这些代码包安装在JCR存储库的相同区域中。

例如:

  • 代码包A部署到 /apps/a
  • 代码包B部署到中 /apps/a/b

如果尚未从代码包B在代码包A上建立包级别依赖关系,则代码包B可以首先部署到 /apps/a. 随后将发布代码包B,代码包将部署到 /apps/a. 结果是删除之前安装的 /apps/a/b.

在本例中:

  • 代码包A应定义 <repositoryStructurePackage> 在项目的存储库结构包上(该包应具有过滤器) /apps)。
  • 代码包B应定义 <repositoryStructurePackage> 在代码包A上,因为代码包B部署到代码包A共享的空间中。

错误和调试

如果存储库结构包未正确设置,则会在Maven中报告错误:

1 error(s) detected during dependency analysis.
Filter root's ancestor '/apps/some/path' is not covered by any of the specified dependencies.

此错误表示中断代码包没有 <repositoryStructurePackage> 该列表 /apps/some/path 在其过滤器列表中。

其他资源

在此页面上