构建

基本编译和测试

要构建源代码,您需要安装 JDK 17。

Spring Cloud 使用 Maven 进行大多数与构建相关的活动,您可以通过克隆您感兴趣的项目并键入以下命令快速入门:

$ ./mvnw install
您也可以自行安装 Maven(>=3.3.3)并在下面的示例中使用 `mvn` 命令代替 `./mvnw`。如果您这样做,如果您的本地 Maven 设置不包含 Spring 预发行构件的存储库声明,您可能还需要添加 `-P spring`。
请注意,您可能需要增加 Maven 可用的内存量,方法是设置一个值为 `-Xmx512m -XX:MaxPermSize=128m` 的 `MAVEN_OPTS` 环境变量。我们尝试在 `.mvn` 配置中涵盖这一点,因此,如果您发现必须这样做才能使构建成功,请提交工单以将设置添加到源代码控制。

需要中间件(例如 Redis)进行测试的项目通常需要安装并运行本地 [Docker](www.docker.com/get-started) 实例。

文档

spring-cloud-build 模块具有“docs”配置文件,如果您启用该配置文件,它将尝试使用来自 `modules/ROOT/` 的 Antora 构建 asciidoc 源代码。

在此过程中,它将查找 `docs/src/main/asciidoc/README.adoc` 并通过加载所有包含文件来处理它,但不进行解析或渲染,只是将其复制到 `${main.basedir}`(默认为 `${basedir}`,即项目的根目录)。如果 README 中有任何更改,则在 Maven 构建后,它将作为修改后的文件显示在正确的位置。只需提交并推送更改即可。

使用代码

如果您没有 IDE 偏好,我们建议您在使用代码时使用 Spring Tools SuiteEclipse。我们使用 m2eclipse eclipse 插件来支持 maven。只要其他 IDE 和工具使用 Maven 3.3.3 或更高版本,它们也应该可以正常工作。

激活 Spring Maven 配置文件

Spring Cloud 项目需要激活“spring”Maven 配置文件才能解析 Spring 里程碑和快照存储库。使用您喜欢的 IDE 设置此配置文件为活动状态,否则您可能会遇到构建错误。

使用 m2eclipse 导入到 eclipse 中

我们建议使用 m2eclipse eclipse 插件与 eclipse 一起使用。如果您尚未安装 m2eclipse,则可以从“eclipse 市场”中获取它。

较旧版本的 m2e 不支持 Maven 3.3,因此,一旦项目导入到 Eclipse 中,您还需要告诉 m2eclipse 为项目使用正确的配置文件。如果您看到许多与项目中的 POM 相关的不同错误,请检查您是否安装了最新版本。如果您无法升级 m2e,请将“spring”配置文件添加到您的 `settings.xml` 中。或者,您可以将父 pom 的“spring”配置文件中的存储库设置复制到您的 `settings.xml` 中。

在没有 m2eclipse 的情况下导入到 eclipse 中

如果您不想使用 m2eclipse,您可以使用以下命令生成 eclipse 项目元数据:

$ ./mvnw eclipse:eclipse

可以通过从“文件”菜单中选择“导入现有项目”来导入生成的 eclipse 项目。