Spring Cloud【從無到有從有到無】【SKB3】附錄

附錄A:Building

A.1. 基本編譯和測試

要構建源代碼,您將需要安裝JDK 1.7。

該版本使用Maven包裝器,因此您不必安裝特定版本的Maven。 要啓用測試,應在構建之前運行Kafka服務器0.9或更高版本。 有關運行服務器的更多信息,請參見下文。

主要的構建命令是

$ ./mvnw clean install

您也可以根據需要添加“ -DskipTests”,以避免運行測試。

您也可以自己安裝Maven(> = 3.3.3),並在下面的示例中運行mvn 命令代替./mvnw。 如果這樣做,則如果本地Maven設置不包含Spring預發行項目的存儲庫聲明,則可能還需要添加 -P spring

請注意,您可能需要通過將MAVEN_OPTS環境變量設置爲 -Xmx512m -XX:MaxPermSize = 128m 這樣的值來增加Maven可用的內存量。 我們嘗試在.mvn配置中進行介紹,因此,如果您必須執行此操作才能使構建成功,請提出票證以將設置添加到源代碼管理中。

需要中間件的項目通常包括docker-compose.yml,因此請考慮使用 Docker Compose在Docker容器中運行中間件服務器。

A.2. 文獻資料

有一個“full”的配置文件將生成文檔。

A.3.使用代碼

如果您沒有IDE偏好設置,我們建議您在使用代碼時使用Spring Tools SuiteEclipse。 我們使用m2eclipe eclipse插件來獲得maven支持。 其他IDE和工具也應該可以正常工作。

A.3.1.使用m2eclipse導入eclipse

當使用eclipse時,我們建議使用m2eclipe eclipse插件。 如果您尚未安裝m2eclipse,則可以從“ eclipse市場”中獲取。

不幸的是m2e尚不支持Maven 3.3,因此一旦將項目導入Eclipse,您還需要告訴m2eclipse對項目使用.settings.xml文件。 如果不這樣做,您可能會看到許多與項目中的POM相關的錯誤。 打開Eclipse首選項,展開Maven首選項,然後選擇User Settings。 在“User Settings”字段中,單擊“Browse”,然後導航到您導入的Spring Cloud項目,選擇該項目中的.settings.xml文件。 單擊應用,然後單擊確定以保存首選項更改。

或者,您可以將存儲庫設置從.settings.xml複製到您自己的~/.m2/settings.xml中

A.3.2.不使用m2eclipse導入eclipse

如果您不想使用m2eclipse,則可以使用以下命令生成eclipse項目元數據:

$ ./mvnw eclipse:eclipse

可以通過從文件菜單中選擇導入現有項目來導入生成的Eclipse項目。

[[contributing] == Contributing

Spring Cloud是在非限制性Apache 2.0許可下發布的,並遵循非常標準的Github開發流程,使用Github跟蹤程序解決問題並將合併請求合併到master中。 如果您想貢獻些微不足道的東西,請不要猶豫,但請遵循以下準則。

 

A.4.簽署貢獻者許可協議

在我們接受不重要的補丁或請求請求之前,我們需要您簽署貢獻者的協議。 簽署貢獻者協議並不會授予任何人對主存儲庫的提交權,但這確實意味着我們可以接受您的貢獻,如果這樣做,您將獲得作者的榮譽。 可能需要活躍的貢獻者加入核心團隊,並具有合併合併請求的能力。

A.5.規範和內務守則

對於拉取請求,這些都不是必不可少的,但它們都會有所幫助。 也可以在原始請求請求之後但在合併之前添加它們。

  • 使用Spring Framework代碼格式約定。如果您使用Eclipse,則可以使用Spring Cloud Build項目中的 eclipse-code-formatter.xml 文件導入格式化程序設置。如果使用IntelliJ,則可以使用 Eclipse Code Formatter Plugin來導入相同的文件。
  • 確保所有新的.java文件都具有簡單的Javadoc類註釋,並至少帶有一個@author標記來標識您,並且最好至少包含有關該類用途的段落。
  • 將ASF許可證標頭註釋添加到所有新的.java文件(從項目中的現有文件複製)
  • 將您自己作爲@author添加到您進行了實質性修改(不只是外觀上的更改)的.java文件中。
  • 添加一些Javadocs,如果更改名稱空間,則添加一些XSD doc元素。
  • 進行一些單元測試也會有很大幫助。——有人必須這樣做。
  • 如果沒有其他人在使用您的分支,請根據當前的主節點(或主項目中的其他目標分支)對其進行重新設置。
  • 在編寫提交消息時,請遵循以下約定,如果要解決現有問題,請在提交消息的末尾添加Fixes gh-XXXX(其中XXXX是問題編號)。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章