附录
附录 A: 构建
A.1. 基本编译和测试
要构建源代码,您需要安装 JDK 1.8。
The构建使用Maven包装器,因此无需安装特定 版本的Maven。要运行测试,您需要在本地主机上的默认端口(5672) 先启动RabbitMQ服务器。
The main build command is
$ ./mvnw clean install
您也可以添加 '-DskipTests',以避免运行测试。<br/>
您也可以自行安装 Maven(>=3.3.3),并在以下示例中用 mvn 替代 ./mvnw。如果您这样做,且本地 Maven 配置中未包含 Spring 预发布构件的仓库声明,则可能还需要添加 -P spring。 |
请注意,您可能需要通过设置一个 MAVEN_OPTS 环境变量来增加 Maven 可用的内存,其值可类似为 -Xmx1024m。我们已在 build 配置中尽量涵盖此情况;如果您发现必须进行此类设置才能使构建成功,请提交工单,以便将相关配置添加到源代码控制中。 |
需要中间件的项目通常包括docker-compose.yml,因此请考虑使用Docker Compose在Docker容器中运行中间件服务器。
A.2. 文档
有一个“docs”配置文件,将生成文档。
./mvnw clean package -Pdocs -DskipTests
参考文档可以在docs/target/contents/reference找到。
A.3. 处理代码
如果您没有特定的IDE偏好,我们建议您在处理代码时使用Spring Tools Suite或Eclipse。我们使用m2eclipe插件来支持Maven。其他IDE和其他工具也应该可以正常工作。
A.3.1. 在 Eclipse 中使用 m2eclipse 导入项目
我们建议在使用 eclipse 时安装 m2eclipe 插件。如果您尚未安装 m2eclipse,可以从 "eclipse 市场" 安装。
不幸的是,m2e 目前还不支持 Maven 3.3,因此一旦项目导入到 Eclipse 中后,您还需要告诉 m2eclipse 使用项目的 .settings.xml 文件。如果您不这样做,则可能会看到与项目中的 POM 相关的许多不同错误。打开您的 Eclipse 首选项,展开 Maven 首选项,并选择用户设置。在“用户设置”字段中点击浏览并导航到您导入的 Spring Cloud 项目,选择该项目中的.settings.xml文件。单击应用,然后单击确定以保存首选项更改。
另外,您可以将仓库设置从.settings.xml复制到您自己的~/.m2/settings.xml中。 |
A.3.2. 在没有 m2eclipse 的情况下导入到 eclipse
如果您不希望使用 m2eclipse,可以使用以下命令生成 Eclipse 项目元数据:
$ ./mvnw eclipse:eclipse
生成的 Eclipse 项目可以通过选择 import existing projects 从 file 菜单中导入。