建置環境 build-environment
了解 Cloud Manager 的構建環境以及它如何構建和測試您的程式碼。
建置環境詳細資訊 build-environment-details
Cloud Manager 使用專門的構建環境構建和測試您的程式碼。
- 建置環境以 Linux 為基礎,衍生自 Ubuntu 22.04。
- 已安裝 Apache Maven 3.9.4。
- Adobe 建議使用者更新其 Maven 存放庫以使用 HTTPS 而非 HTTP。
- 已安裝的Java版本為Oracle JDK 11.0.22、Oracle JDK 17.0.10和Oracle JDK 21.0.4。
-
重要: 依預設,
JAVA_HOME
環境變數設為/usr/lib/jvm/jdk1.8.0_401
,其中包含Oracle JDK 8u401。 AEM雲端專案應覆寫此預設以使用JDK 21 (偏好設定)、17或11。 如需詳細資訊,請參閱設定Maven JDK版本區段。 -
安裝了一些必要的附加系統套件。
bzip2
unzip
libpng
imagemagick
graphicsmagick
-
在建置時間可安裝其他套件,如安裝附加系統套件部份中所述。
-
每個組建都可在乾淨的環境中執行,組建容器在執行之間不保留任何狀態。
-
一直使用下列三個命令執行 Maven:
mvn --batch-mode org.apache.maven.plugins:maven-dependency-plugin:3.1.2:resolve-plugins
mvn --batch-mode org.apache.maven.plugins:maven-clean-plugin:3.1.0:clean -Dmaven.clean.failOnError=false
mvn --batch-mode org.jacoco:jacoco-maven-plugin:prepare-agent package
-
透過
settings.xml
檔案在系統層級設定 Maven,這會利用名為adobe-public
的設定檔自動納入公共 Adobe 成品存放庫。如需更多詳細資訊,請參閱 Adobe 公共 Maven 存放庫。
jacoco-maven-plugin
的特定版本,但使用的版本必須至少為 0.7.5.201505241946
。HTTPS Maven 存放庫 https-maven
Cloud Manager 2023.10.0 版開始推出組建環境的更新 (在 2023.12.0 版時完成),其中包含 Maven 3.8.8 的更新。Maven 3.8.1 引入一項重大變更,即為安全性增強,其目的在減少潛在漏洞。具體而言,Maven 現在預設停用所有不安全的 http://*
鏡像,如 Maven 發行說明中所述。
由於此安全性增強,某些使用者可能會在建置步驟中遇到問題,特別是從使用不安全 HTTP 連線的 Maven 存放庫下載成品時。
為了確保更新的版本有流暢的使用體驗,Adobe 建議使用者更新其 Maven 存放庫以使用 HTTPS 而非 HTTP。這項調整符合產業日益轉向使用安全通訊協定的趨勢,有助於維持安全可靠的建置程序。
使用特定的Java版本 using-java-support
Cloud Manager建置流程預設會使用Oracle 8 JDK建置專案,但AEM Cloud Service客戶應將Maven執行JDK版本設為21 (偏好設定)、17或11。
設定Maven JDK版本 alternate-maven-jdk-version
若要設定Maven執行JDK,請在管道使用的Git存放庫分支中建立名為.cloudmanager/java-version
的檔案。 編輯檔案,使其僅包含文字21
或17
。 雖然Cloud Manager也接受8
的值,但AEM Cloud Service專案不再支援此版本。 任何其他值會受到忽略。指定21
或17
時,會使用Oracle Java 21或Oracle Java 17。
移轉至使用Java 21或Java 17建置的先決條件 prereq-for-building
若要移轉至使用Java 21或Java 17的建置版本,您必須先升級至最新的SonarQube版本。 如需詳細資訊,請參閱Cloud Manager 2025.1.0發行說明。
將應用程式移轉至新的Java組建版本和執行階段版本時,請先在開發和測試環境中徹底測試,然後再部署到生產環境。
我們建議使用下列部署策略:
- 使用Java 21執行您的本機SDK (可從https://experience.adobe.com/#/downloads下載),並將您的應用程式部署至其中並驗證其功能。 檢查記錄檔中是否有錯誤,指出類別載入或位元組碼編排發生問題。
- 在您的Cloud Manager存放庫中設定分支以使用Java 21作為建置時間Java版本,設定開發管道以使用此分支並執行管道。 執行驗證測試。
- 如果看起來不錯,請將您的stage/prod管道設定為使用Java 21做為buildtime Java版本並執行管道。
關於某些翻譯功能 translation-features
在Java 21執行階段上部署下列功能時,這些功能可能會無法正常運作,而Adobe預計可在2025年初解決這些問題:
- 使用人工翻譯時,
XLIFF
(XML本地化交換檔案格式)失敗。 I18n
(國際化)無法正確處理希伯來文(he
)、印尼(in
)和意第緒文(yi
)的語言環境,因為較新Java版本中的語言環境建構函式有所變更。
執行階段需求 runtime-requirements
Java 21執行階段用於具有Java 21和Java 17的組建,並將逐步套用至Java 11組建(請參閱下方的注意事項)。 環境必須位於AEM版本17098本或更高版本上才能接收Java 21更新。 為確保相容性,需要進行下列調整。
程式庫更新可隨時套用,因為維持與舊版Java相容。
-
ASM的最低版本:
將Java套件org.objectweb.asm
(通常整合在org.ow2.asm.*
成品中)的使用更新至9.5版或更新版本,以確保支援較新的JVM執行階段。 -
Groovy的最低版本:
將Java套件org.apache.groovy
或org.codehaus.groovy
的使用更新至4.0.22版或更新版本,以確保支援較新的JVM執行階段。新增第三方相依性 (例如 AEM Groovy 主控台) 可以間接包含此搭售方案。
-
Aries SPIFly的最低版本:
將Java套件org.apache.aries.spifly.dynamic.bundle
的使用更新至1.3.6版或更新版本,以確保支援更新的JVM執行階段。
AEM雲端服務SDK與Java 21相容,可用來在執行Cloud Manager管道之前驗證專案與Java 21的相容性。
-
編輯執行階段引數:
使用Java 21在本機執行AEM時,由於MaxPermSize
引數,啟動指令碼(crx-quickstart/bin/start
或crx-quickstart/bin/start.bat
)會失敗。 作為補救方法,請從指令碼移除-XX:MaxPermSize=256M
或定義環境變數CQ_JVM_OPTS
,將其設定為-Xmx1024m -Djava.awt.headless=true
。AEM Cloud Service SDK版本19149和更新版本可解決此問題。
.cloudmanager/java-version
設定為21
或17
時,就會部署Java 21執行階段。 Java 21執行階段已排定從2025年2月4日星期二開始逐步推出至所有環境(不僅僅是使用Java 11建置程式碼的那些環境)。 推出將從沙箱和開發環境開始,然後在2025年4月推出到所有生產環境。 想要採用Java 21執行階段 較早 的客戶可透過aemcs-java-adopter@adobe.com聯絡Adobe。建置時間需求 build-time-reqs
需要進行下列調整,才能使用Java 21和Java 17建置專案。 甚至在您執行Java 21和Java 17之前,這些檔案就已經可以更新了,因為它們與舊版Java相容。
AEM Cloud Service客戶建議儘早使用Java 21建置專案,以運用新的語言功能。
-
最低版本
bnd-maven-plugin
:
將bnd-maven-plugin
的使用更新至6.4.0版,以確保支援較新的JVM執行階段。版本7或更新版本與Java 11或更低版本不相容,因此不建議升級至該版本。
-
最低版本
aemanalyser-maven-plugin
:
將aemanalyser-maven-plugin
的使用更新至1.6.6版或更新版本,以確保支援較新的JVM執行階段。 -
最低版本
maven-bundle-plugin
:
將maven-bundle-plugin
的使用更新至5.1.5版或更新版本,以確保支援較新的JVM執行階段。版本6或更高版本與Java 11或更低版本不相容,因此不建議升級至該版本。
-
更新
maven-scr-plugin
中的相依性:maven-scr-plugin
與Java 21或Java 17不直接相容。 不過,可以透過更新外掛程式組態中的ASM相依性版本來產生描述項檔案,如下列範例所示:
<project>
...
<build>
...
<plugins>
...
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-scr-plugin</artifactId>
<version>1.26.4</version>
<executions>
<execution>
<id>generate-scr-scrdescriptor</id>
<goals>
<goal>scr</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.ow2.asm</groupId>
<artifactId>asm-analysis</artifactId>
<version>9.7.1</version>
<scope>compile</scope>
</dependency>
</dependencies>
</plugin>
...
</plugins>
...
</build>
...
</project>
環境變數 — 標準 environment-variables
您可能會發現有必要根據有關計畫或管道的資訊來改變建置流程。
例如,如果在建置時間使用gulp之類的工具進行JavaScript縮制,則不同環境可能偏好使用不同的縮制層級。 與中繼和生產環境相比,開發組建可能會使用較輕的縮制層級。
為了支援這一點,Cloud Manager 會在每次執行時將標準環境變數新增到組建容器中。
CM_BUILD
true
BRANCH
CM_PIPELINE_ID
CM_PIPELINE_NAME
CM_PROGRAM_ID
CM_PROGRAM_NAME
ARTIFACTS_VERSION
CM_AEM_PRODUCT_VERSION
環境變數 — 管道 pipeline-variables
您的建置流程可能需要不應儲存在Git存放庫中的特定設定變數。 此外,您可能需要在使用同一分支的管道執行之間調整這些變數。
另請參閱設定管道變數以取得詳細資訊。
安裝其他系統套件 installing-additional-system-packages
部分組建需要其他系統套件才能完全運作。 例如,組建可能會叫用Python或Ruby指令碼,而且必須安裝適當的語言解譯器。 您可以呼叫pom.xml
中的exec-maven-plugin
來叫用APT,以管理此安裝程式。 這項執行通常應包裝在 Cloud Manager 特定的 Maven 設定檔中。若要安裝 Python。
<profile>
<id>install-python</id>
<activation>
<property>
<name>env.CM_BUILD</name>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.6.0</version>
<executions>
<execution>
<id>apt-get-update</id>
<phase>validate</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>apt-get</executable>
<arguments>
<argument>update</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>install-python</id>
<phase>validate</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>apt-get</executable>
<arguments>
<argument>install</argument>
<argument>-y</argument>
<argument>--no-install-recommends</argument>
<argument>python</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
此同一技術可用於安裝特定語言的套件,例如將 gem
用於 RubyGems 或將 pip
用於 Python 套件。