构建
基本编译和测试
要构建源代码,您需要安装 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 中。 |