AEM 项目存储库结构包

将Adobe Experience Manager作为Cloud Service的Maven项目需要存储库结构子包定义,其唯一目的是定义项目代码子包部署到的JCR存储库根。 这可以确保在Experience Manager中安装包,因为Cloud Service是按JCR资源依赖项自动排序的。 缺少依赖项可能会导致子结构在其父结构之前安装,从而意外删除,从而破坏部署的情况。

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

存储库结构包

存储库结构包定义/apps的预期公共状态,包验证器使用该状态确定区域“避免潜在冲突”,因为它们是标准根。

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

  • /apps 是系统提供的节点
  • /apps/cq/.../apps/dam/.../apps/wcm/.../apps/sling/... ,为提供通用叠加 /libs图。
  • /apps/settings 共享的上下文感知配置根路径

请注意,此子包​没有​任何内容,只由定义过滤器根的pom.xml组成。

创建存储库结构包

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://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 will be deployed and remove all defined filter roots -->
                    <cloudManagerTarget>none</cloudManagerTarget>
                </properties>
                <configuration>
                    <properties>
                        <!-- Set Cloud Manager Target to none, else this package will be 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 overlayed 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的子包)通过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

如果未从代码包A上的代码包B建立包级别依赖关系,则代码包B可以先部署到/apps/a中,然后部署到/apps/a中的代码包B,从而删除之前安装的/apps/a/b

在这种情况下:

  • 代码包A应在项目的存储库结构包(应具有/apps的过滤器)上定义<repositoryStructurePackage>
  • 代码包B应在代码包A上定义<repositoryStructurePackage>,因为代码包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.

这表示中断代码包的过滤器列表中没有列出/apps/some/path<repositoryStructurePackage>

其他资源

在此页面上