AEM 專案結構
本文概述Adobe Experience Manager Maven專案為與AEMas a Cloud Service相容所需的變更,確保專案遵守可變和不可變內容的分割。 此外,相依性是為了建立不衝突、確定性的部署,並封裝在可部署的結構中。
AEM應用程式部署必須由單一AEM套件組成。 此套件繼而應包含子套件,子套件包含應用程式運作所需的一切,包括程式碼、設定及任何支援的基準線內容。
AEM需要分隔 內容 和 程式碼,這表示單一內容套件 無法 部署至 兩者 /apps
和執行階段可寫入區域(例如, /content
, /conf
, /home
,或不存在的任何專案 /apps
)。 而應用程式必須將程式碼和內容分隔為獨立套件,以便部署至AEM。
本檔案中概述的套件結構與本機開 發部署 和AEM cloud服務部署都相容。
存放庫的可變與不可變區域 mutable-vs-immutable
此 /apps
和 /libs
考慮AEM的區域 不可變 因為它們在AEM啟動(即在執行階段)後無法變更(建立、更新、刪除)。 任何在執行階段變更不可變區域的嘗試都會失敗。
存放庫中的所有其他專案, /content
, /conf
, /var
, /etc
, /oak:index
, /system
, /tmp
,依此類推,都是 可變 區域,表示可在執行階段變更這些區域。
/libs
不應修改。 只有AEM產品程式碼可以部署至 /libs
.Oak索引 oak-indexes
Oak索引(/oak:index
)由AEMas a Cloud Service部署程式管理。 這是因為Cloud Manager必須等到部署任何新索引並完全重新索引後,才能切換至新的程式碼影像。
因此,雖然Oak索引在執行階段是可變的,但它們必須部署為程式碼,以便在安裝任何可變套件之前可以安裝。 因此 /oak:index
設定是程式碼套件的一部分,而不是內容套件的一部分 如下所述.
建議的封裝結構 recommended-package-structure
此圖表提供建議的專案結構和套件部署成品概觀。
建議的應用程式部署結構如下:
程式碼套件/ OSGi套裝
-
會產生OSGi套件Jar檔案,並直接內嵌在所有專案中。
-
此
ui.apps
套件包含要部署的所有程式碼,且僅部署至/apps
. 的常見元素ui.apps
套件包含但不限於:- 元件定義和HTL 指令碼
/apps/my-app/components
- JavaScript和CSS (透過 使用者端資料庫)
/apps/my-app/clientlibs
- 覆蓋 之
/libs
/apps/cq
,/apps/dam/
, 以此類推.
- 遞補內容感知設定
/apps/settings
- ACL (許可權)
- 任何
rep:policy
下的任何路徑/apps
- 任何
- 預先編譯的套件指令碼
- 元件定義和HTL 指令碼
內容套件
-
此
ui.content
套件包含所有內容和設定。 內容套件包含不在中的所有節點定義ui.apps
或ui.config
封裝,或換言之,任何不在中的內容/apps
或/oak:index
. 的常見元素ui.content
套件包含但不限於:- 內容感知設定
/conf
- 必要的複雜內容結構(亦即,建置並延伸超過存放庫初始中定義的基準內容結構的內容建置)。
/content
,/content/dam
, 以此類推.
- 控管的標籤分類
/content/cq:tags
- 舊版etc節點(理想情況下,請將這些節點移轉至非/etc位置)
/etc
- 內容感知設定
容器封裝
-
此
all
套件是容器套件,僅包含可部署的成品、OSGI套件Jar檔案、ui.apps
,ui.config
、和ui.content
套件作為內嵌。 此all
套件不得具有 任何內容或程式碼 將其本身部署,而是將所有部署委派給存放庫的子套件或OSGi套件Jar檔案。套件現在包含使用Maven FileVault Package Maven外掛程式的內嵌設定,而非
<subPackages>
設定。對於複雜的Experience Manager部署,最好建立多個
ui.apps
,ui.config
、和ui.content
代表AEM中特定網站或租使用者的專案/套件。 如果完成此方法,請確保遵循可變和不可變內容之間的拆分,並將所需的內容包和OSGi捆綁Jar檔案作為子包嵌入到all
容器內容封裝。例如,複雜的部署內容套件結構可能如下所示:
-
all
內容套件內嵌下列套件,以建立單一部署成品common.ui.apps
部署所需的程式碼 兩者 網站A和網站Bsite-a.core
網站A所需的OSGi套件Jarsite-a.ui.apps
部署網站A所需的程式碼site-a.ui.config
部署網站A所需的OSGi設定site-a.ui.content
部署網站A所需的內容和設定site-b.core
網站B所需的OSGi套件Jarsite-b.ui.apps
部署網站B所需的程式碼site-b.ui.config
部署網站B所需的OSGi設定site-b.ui.content
部署網站B所需的內容和設定
-
-
此
ui.config
套件包含全部 OSGi設定:-
視為程式碼且屬於OSGi套件組合,但不包含一般內容節點。 因此會標示為容器封裝
-
包含執行模式特定OSGi設定定義的組織資料夾
/apps/my-app/osgiconfig
-
包含套用至所有目標AEMas a Cloud Service部署目標的預設OSGi設定的通用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 (許可權)
-
-
額外的應用程式套件 extra-application-packages
如果AEM部署使用其他AEM專案(專案本身由專案自己的程式碼和內容套件組成),則其容器套件應內嵌在專案的 all
封裝。
例如,包含兩個廠商AEM應用程式的AEM專案可能如下所示:
-
all
內容套件內嵌下列套件,以建立單一部署成品core
AEM應用程式所需的OSGi套件Jarui.apps
部署AEM應用程式所需的程式碼ui.config
部署AEM應用程式所需的OSGi設定ui.content
部署AEM應用程式所需的內容和設定vendor-x.all
部署廠商X應用程式所需的一切(程式碼和內容)vendor-y.all
部署廠商Y應用程式所需的一切(程式碼和內容)
封裝型別 package-types
套件將標示其宣告的套件型別。 套件型別有助於釐清套件的用途和部署。
- 容器套件必須設定其
packageType
至container
. 容器套件不得包含一般節點。 僅允許OSGi套件組合、設定和子套件。 AEMas a Cloud Service中的容器不允許使用 安裝鉤點. - 程式碼(不可變)套件必須設定其
packageType
至application
. - 內容(可變)套件必須設定其
packageType
至content
.
如需詳細資訊,請參閱 Apache Jackrabbit FileVault — 套件Maven外掛程式檔案, Apache Jackrabbit套件型別,以及 FileVault Maven設定片段 下方的。
透過AdobeCloud Manager標籤要部署的套件 marking-packages-for-deployment-by-adoube-cloud-manager
根據預設,Adobe Cloud Manager會收集由Maven組建版本產生的所有套件。 不過,由於容器(all
)套件是包含所有程式碼和內容套件的單一部署成品,您必須確定 僅限 容器(all
)套裝軟體已部署。 為確保此,Maven構建版本生成的其他軟體包必須用的FileVault Content Package Maven插件配置進行標籤 <properties><cloudManagerTarget>none</cloudManageTarget></properties>
。
Repo Init repo-init
Repo Init提供定義JCR結構的指示或指令碼,範圍從資料夾樹狀結構等通用節點結構,到使用者、服務使用者、群組和ACL定義。
Repo Init的主要優點是,使用者具有執行其指令碼所定義之所有動作的隱含許可權。 此外,這類指令碼會在部署生命週期的早期叫用,確保所有必要的JCR結構在執行程式碼時都存在。
雖然Repo Init指令碼本身會在 ui.config
以指令碼方式專案時,可以也應該使用它們來定義下列可變結構:
- 基準內容結構
- 服務使用者
- 使用者
- 群組
- ACL
存放庫初始指令碼儲存為 scripts
專案: RepositoryInitializer
OSGi工廠設定。 因此,它們可以由執行模式隱含定位,從而允許AEM Author和AEM Publish Services的Repo Init指令碼之間,甚至環境(開發、階段和生產環境)之間的差異。
Repo Init OSGi設定最好寫入 .config
OSGi設定格式 因為它們支援多行,這是使用的最佳實務的例外情況 .cfg.json
定義OSGi設定的方式.
定義「使用者」和「群組」時,只有群組會被視為應用程式的一部分,並且是其功能的必要部分。 您仍然可以在AEM執行階段定義組織使用者和群組。 例如,如果自訂工作流程將工作指派給已命名的群組,請在AEM應用程式中透過Repo Init定義該群組。 不過,如果「群組」只是組織性的,例如「Wendy的團隊」和「Sean的團隊」,這些群組最適合在AEM中執行階段定義和管理。
scripts
欄位,或 references
設定無法運作。Repo Init指令碼的完整辭彙表可在以下網址取得: Apache Sling Repo初始檔案.
存放庫結構套件 repository-structure-package
程式碼套件需要將FileVault Maven外掛程式的設定設定為參照 <repositoryStructurePackage>
這會強制結構相依性的正確性(以確保一個程式碼套件不會安裝在另一個程式碼套件上)。 您可以 為您的專案建立自己的存放庫結構套件.
僅限必要 若為程式碼套件,表示任何標示為 <packageType>application</packageType>
.
若要瞭解如何為您的應用程式建立存放庫結構套件,請參閱 開發存放庫結構套件.
內容套件(<packageType>content</packageType>
) 不要 需要此存放庫結構套件。
將子封裝內嵌在容器封裝中 embeddeds
內容或程式碼套件會放置在特殊的「side-car」資料夾中,並可鎖定為安裝在AEM author、AEM publish上,或兩者上都使用FileVault Maven外掛程式的 <embeddeds>
設定。 請勿使用 <subPackages>
設定。
常見的使用案例包括:
- AEM作者使用者和AEM發佈使用者之間不同的ACL/許可權
- 僅用於支援AEM作者上活動的設定
- 程式碼(例如與後台系統的整合)僅需在AEM作者上執行
若要鎖定AEM作者、AEM發佈,或兩者兼而有之,套件會內嵌於 all
容器封裝在特殊資料夾位置中,格式如下:
/apps/<app-name>-packages/(content|application|container)/install(.author|.publish)?
劃分此資料夾結構:
-
第一層資料夾 必須是
/apps
. -
第二層資料夾代表應用程式,具有
-packages
在資料夾名稱中加上後置修正。 通常,所有子封裝都內嵌在單一的第二層資料夾下,但可以建立任意數量的第二層資料夾,以最好地代表應用程式的邏輯結構:/apps/my-app-packages
/apps/my-other-app-packages
/apps/vendor-packages
note warning WARNING 按照慣例,子封裝內嵌資料夾的名稱為尾碼為 -packages
. 此命名可確保部署程式碼和內容套件是 not 已部署任何子封裝的目標資料夾/apps/<app-name>/...
會導致破壞性的循環安裝行為。 -
第3層資料夾必須是
application
,content
或container
-
第4層資料夾包含子封裝,且必須是下列其中一項:
install
所以您要安裝 兩者 AEM作者和AEM發佈install.author
所以您安裝 僅限 在AEM作者上install.publish
所以您安裝 僅限 僅於AEM發佈install.author
和install.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 publish
容器封裝的篩選器定義 container-package-filter-definition
由於程式碼和內容子套件內嵌在容器套件中,因此內嵌的目標路徑必須新增到容器專案的 filter.xml
. 這樣做可確保內巢狀件在建置時包含在容器套件中。
只需新增 <filter root="/apps/<my-app>-packages"/>
包含要部署的子套件的任何第二層資料夾專案。
內嵌第三方套件 embedding-3rd-party-packages
所有套件都必須透過 Adobe的公用Maven成品存放庫 或可存取的公開、可參照的第三方Maven成品存放庫。
如果第三方套件位於 Adobe的公用Maven成品存放庫,AdobeCloud Manager無需進一步設定即可解析成品。
如果協力廠商套件位於 公用第三方Maven成品存放庫,此存放庫必須在專案的 pom.xml
和嵌入在方法之後 上面概述.
協力廠商應用程式/聯結器應使用其 all
封裝為專案容器中的容器(all
)封裝。
新增Maven相依性會遵循標準Maven做法,以及嵌入第三方成品(程式碼和內容套件)有 上面概述.
套件之間的相依性 ui.apps
從 ui.content
套件 package-dependencies
為確保正確安裝套件,建議建立套件間相依性。
一般規則是包含可變內容的套件(ui.content
)取決於不可變程式碼(ui.apps
)可支援呈現和使用可變內容。
此一般規則有一個顯著的例外情況,就是如果不可變的程式碼套件(ui.apps
或任何其他), 僅限 包含OSGi套件組合。 如果是,則任何AEM套件都不應宣告其上的相依性。 原因是因為不可變的程式碼套件會 僅限 包含OSGi套件組合,未向AEM註冊 封裝管理員. 因此,依賴它的任何AEM套件都有不滿足的相依性,並且無法安裝。
內容套件相依性的常見模式包括:
簡易部署套件相依性 simple-deployment-package-dependencies
簡單案例會設定 ui.content
可變的內容套件依賴於 ui.apps
不可變的程式碼套件。
-
all
沒有相依性ui.apps
沒有相依性ui.content
依據ui.apps
複雜的部署套件相依性 complex-deploxment-package-dependencies
複雜的部署會以簡單案例展開,並設定對應可變內容與不可變程式碼套件之間的相依性。 如有需要,也可以在不可變的程式碼套件之間建立相依性。
-
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
本機開發和部署 local-development-and-deployment
本文中概述的專案結構和組織為 完全相容 本機開發AEM執行個體。
POM XML代碼片段 pom-xml-snippets
以下是Maven pom.xml
可新增至Maven專案的設定片段以與上述建議一致。
封裝型別 xml-package-types
程式碼和內容封裝(部署為子封裝)必須宣告封裝型別 應用計畫 或 內容,視其包含的內容而定。
容器封裝型別 container-package-types
容器 all/pom.xml
專案 不會 宣告 <packageType>
.
程式碼(不可變)封裝型別 immutable-package-types
程式碼套件必須設定其 packageType
至 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>
...
內容(可變)封裝型別 mutable-package-types
內容套件必須設定其 packageType
至 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部署 cloud-manager-target
在每個產生套件的專 案中 ,除容器(all
)專案外,將外掛程式聲明的 <cloudManagerTarget>none</cloudManagerTarget>
組態新增至外掛程式宣告的組態,以確 <properties>
filevault-package-maven-plugin
保Adobe Cloud Manager不會部署它們。容器(all
)套件應該是透過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 snippet-repo-init
包含Repo Init指令碼的Repo Init指令碼定義於 RepositoryInitializer
OSGi工廠設定,透過 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語言.
存放庫結構套件 xml-repository-structure-package
在 ui.apps/pom.xml
和任何其他 pom.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>
...
將子封裝內嵌在容器封裝中 xml-embeddeds
在 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>
...
容器封裝的篩選器定義 xml-container-package-filters
在 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存放庫 xml-3rd-party-maven-repositories
在Reactor專案的 pom.xml
,新增任何必要的第三方公用Maven存放庫指示。 完整 <repository>
組態應該可以從協力廠商存放庫提供者取得。
<repositories>
...
<repository>
<id>3rd-party-repository</id>
<name>Public Third-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.apps
從 ui.content
套件 xml-package-dependencies
在 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>
...
正在清除容器專案的目標資料夾 xml-clean-container-package
在 all/pom.xml
,新增 maven-clean-plugin
外掛程式,可在Maven組建之前清除目標目錄。
<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>