構建
基本編譯和測試
要構建原始碼,您需要安裝 JDK 17。
Spring Cloud 大部分構建相關的活動都使用 Maven,您應該能夠透過克隆您感興趣的專案並輸入以下命令來快速上手:
$ ./mvnw install
您也可以自行安裝 Maven(>=3.3.3),並在下面的示例中用 mvn 命令代替 ./mvnw。如果您這樣做,並且您的本地 Maven 設定不包含 Spring 預釋出構件的倉庫宣告,您可能還需要新增 -P spring。 |
請注意,您可能需要透過設定 MAVEN_OPTS 環境變數,並將其值設定為 -Xmx512m -XX:MaxPermSize=128m 來增加 Maven 可用的記憶體量。我們嘗試在 .mvn 配置中涵蓋這一點,因此如果您發現必須這樣做才能使構建成功,請提出一個問題,將這些設定新增到原始碼控制中。 |
測試需要中介軟體(即 Redis)的專案通常需要安裝並執行本地 [Docker](www.docker.com/get-started) 例項。
文件
spring-cloud-build 模組有一個 "docs" 配置檔案,如果您啟用它,它將嘗試使用 modules/ROOT/ 中的 Antora 構建 asciidoc 源。
作為該過程的一部分,它將查詢 docs/src/main/asciidoc/README.adoc 並透過載入所有 include 來處理它,但不會解析或渲染它,只是將其複製到 ${main.basedir}(預設為 ${basedir},即專案根目錄)。如果 README 中有任何更改,在 Maven 構建後它將顯示為正確位置的已修改檔案。只需提交併推送更改即可。
使用程式碼
如果您沒有 IDE 偏好,我們建議您在使用程式碼時使用 Spring Tools Suite 或 Eclipse。我們使用 m2eclipse Eclipse 外掛來支援 Maven。其他 IDE 和工具也應該可以正常工作,只要它們使用 Maven 3.3.3 或更高版本。
啟用 Spring Maven 配置檔案
Spring Cloud 專案需要啟用“spring”Maven 配置檔案來解析 Spring 里程碑和快照倉庫。使用您首選的 IDE 將此配置檔案設定為活動狀態,否則您可能會遇到構建錯誤。
使用 m2eclipse 匯入到 Eclipse
我們建議在使用 Eclipse 時使用 m2eclipse Eclipse 外掛。如果您尚未安裝 m2eclipse,可以從“Eclipse Marketplace”獲取。
m2e 的舊版本不支援 Maven 3.3,因此一旦專案匯入到 Eclipse 中,您還需要告訴 m2eclipse 為專案使用正確的配置檔案。如果您在專案中看到許多與 POM 相關的錯誤,請檢查您的安裝是否是最新版本。如果您無法升級 m2e,請將“spring”配置檔案新增到您的 settings.xml 中。或者,您可以將父 pom 的“spring”配置檔案中的倉庫設定複製到您的 settings.xml 中。 |