Spring Cloud构建_Spring Cloud中文网

Spring Cloud Build 是 Spring Cloud 的一个通用实用程序项目，用于插件和依赖项管理。

构建和部署

本地安装：

$ mvn install -s .settings.xml

并将快照部署到 repo.spring.io：

$ mvn deploy -DaltSnapshotDeploymentRepository=repo.spring.io::default::https://repo.spring.io/snapshot

用于 RELEASE 构建使用

$ mvn deploy -DaltReleaseDeploymentRepository=repo.spring.io::default::https://repo.spring.io/release

并供 jcenter 使用

$ mvn deploy -DaltReleaseDeploymentRepository=bintray::default::https://api.bintray.com/maven/spring/jars/org.springframework.cloud:build

并供 Maven Central 使用

$ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging::default::https://oss.sonatype.org/service/local/staging/deploy/maven2

（“central”配置文件适用于 Spring Cloud 中的所有项目，它设置 gpg jar 签名，并且必须为此项目单独指定存储库，因为它是启动器父级的父级，而用户又将其作为其父级自己的父母）。

转到File→ Settings→ Editor→ Code style。单击该Scheme部分旁边的图标。在那里，单击该Import Scheme值并选择该Intellij IDEA code style XML选项。导入spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml文件。

图 2. 检查概况

转到File→ Settings→ Editor→ Inspections。单击该Profile部分旁边的图标。在那里，单击Import Profile并导入spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml文件。

格子风格

要让 Intellij 与 Checkstyle 配合使用，您必须安装该Checkstyle插件。建议还安装Assertions2Assertj自动转换 JUnit 断言

转到File→ Settings→ Other settings→ Checkstyle。单击+该Configuration file部分中的图标。在那里，您必须定义应从何处选择检查样式规则。在上图中，我们从克隆的 Spring Cloud Build 存储库中选择了规则。但是，您可以指向 Spring Cloud Build 的 GitHub 存储库（例如checkstyle.xml: https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml）。我们需要提供以下变量：

checkstyle.header.file- 请将其指向 Spring Cloud Build，spring-cloud-build-tools/src/main/resources/checkstyle-header.txt文件可以在您的克隆存储库中或通过https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txtURL。
checkstyle.suppressions.file- 默认抑制。请将其指向spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml您克隆的存储库中或通过https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xmlURL 的 Spring Cloud Build 文件。
checkstyle.additional.suppressions.file- 此变量对应于本地项目中的抑制。例如，您正在研究spring-cloud-contract. 然后指向该project-root/src/checkstyle/checkstyle-suppressions.xml文件夹。的示例spring-cloud-contract是：/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml。

请记住设置为，Scan Scope因为All sources我们对生产和测试源应用 checkstyle 规则。

重复查找器

Spring Cloud Build 带来了 basepom:duplicate-finder-maven-plugin, ，可以在 java 类路径上标记重复和冲突的类和资源。

重复查找器配置

重复查找器默认启用，并将在verify您的 Maven 构建阶段运行，但只有将添加到duplicate-finder-maven-plugin项目build的pom.xml.

pom.xml

<build>
    <plugins>
        <plugin>
            <groupId>org.basepom.maven</groupId>
            <artifactId>duplicate-finder-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

对于其他属性，我们设置了插件文档中列出的默认值。

您可以轻松地覆盖它们，但设置以为前缀的所选属性的值duplicate-finder-maven-plugin。例如，设置duplicate-finder-maven-plugin.skip为true以便在构建中跳过重复检查。

如果您需要添加ignoredClassPatterns或ignoredResourcePatterns到您的设置中，请确保将它们添加到项目的插件配置部分：

<build>
    <plugins>
        <plugin>
            <groupId>org.basepom.maven</groupId>
            <artifactId>duplicate-finder-maven-plugin</artifactId>
            <configuration>
                <ignoredClassPatterns>
				    <ignoredClassPattern>org.joda.time.base.BaseDateTime</ignoredClassPattern>
					<ignoredClassPattern>.*module-info</ignoredClassPattern>
				</ignoredClassPatterns>
                <ignoredResourcePatterns>
                    <ignoredResourcePattern>changelog.txt</ignoredResourcePattern>
                </ignoredResourcePatterns>
            </configuration>
        </plugin>
    </plugins>
</build>

展平 POM

为了避免传播构建 Spring Cloud 项目所需的构建设置，我们使用 maven flatten 插件。它的优点是可以让您在将“干净”的 pom 发布到存储库时使用所需的任何功能。

为了添加它，请将添加org.codehaus.mojo:flatten-maven-plugin到您的pom.xml.

<build>
	<plugins>
		<plugin>
			<groupId>org.codehaus.mojo</groupId>
			<artifactId>flatten-maven-plugin</artifactId>
		</plugin>
	</plugins>
</build>

重用文档

Spring Cloud Build 发布了其spring-cloud-build-docs模块，其中包含有用的脚本（例如 README 生成 ruby 脚本）以及 Spring Cloud 文档的 css、xslt 和图像。如果您想遵循生成文档的相同约定方法，只需将这些插件添加到您的docs模块中

<properties>
	<upload-docs-zip.phase>deploy</upload-docs-zip.phase> (8)
</properties>
<profiles>
	<profile>
		<id>docs</id>
		<build>
			<plugins>
				<plugin>
					<groupId>pl.project13.maven</groupId>
					<artifactId>git-commit-id-plugin</artifactId> (1)
				</plugin>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-dependency-plugin</artifactId> (2)
				</plugin>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-resources-plugin</artifactId> (3)
				</plugin>
				<plugin>
					<groupId>org.codehaus.mojo</groupId>
					<artifactId>exec-maven-plugin</artifactId> (4)
				</plugin>
				<plugin>
					<groupId>org.asciidoctor</groupId>
					<artifactId>asciidoctor-maven-plugin</artifactId> (5)
				</plugin>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-antrun-plugin</artifactId> (6)
				</plugin>
				<plugin>
					<artifactId>maven-deploy-plugin</artifactId> (7)
				</plugin>
			</plugins>
		</build>
	</profile>
</profiles>

1	该插件下载设置项目的所有git信息
2	`spring-cloud-build-docs`该插件下载模块的资源
3	`spring-cloud-build-docs`该插件解压模块的资源
4	该插件生成一个`adoc`包含类路径中所有配置属性的文件
5	解析 Asciidoctor 文档需要这个插件
6	需要此插件将资源复制到正确的最终目的地并生成主 README.adoc 并断言没有文件使用未解析的链接
7	该插件确保生成的 zip 文档将被发布
8	此属性打开 <7> 的“部署”阶段

插件声明的顺序很重要！

为了使构建生成adoc包含所有配置属性的文件，您的docs模块应包含类路径上的所有依赖项，您希望扫描这些依赖项以查找配置属性。该文件将输出到${docsModule}/src/main/asciidoc/_configprops.adoc文件（可通过configprops.path属性配置）。

如果您想修改表中放入的配置属性，您可以调整模式configprops.inclusionPattern以仅包含属性的子集（例如<configprops.inclusionPattern>spring.sleuth.*</configprops.inclusionPattern>）。

Spring Cloud Build Docs 附带了一组可以重用的 asciidoctor 属性。

<attributes>
	<docinfo>shared</docinfo>
	<allow-uri-read>true</allow-uri-read>
	<nofooter/>
	<toc>left</toc>
	<toc-levels>4</toc-levels>
	<sectlinks>true</sectlinks>
	<sources-root>${project.basedir}/src@</sources-root>
	<asciidoc-sources-root>${project.basedir}/src/main/asciidoc@</asciidoc-sources-root>
	<generated-resources-root>${project.basedir}/target/generated-resources@
	</generated-resources-root>
	<!-- Use this attribute the reference code from another module -->
	<!-- Note the @ at the end, lowering the precedence of the attribute -->
	<project-root>${maven.multiModuleProjectDirectory}@</project-root>
	<!-- It's mandatory for you to pass the docs.main property -->
	<github-repo>${docs.main}@</github-repo>
	<github-project>https://github.com/spring-cloud/${docs.main}@</github-project>
	<github-raw>
		https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}@
	</github-raw>
	<github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}@
	</github-code>
	<github-issues>https://github.com/spring-cloud/${docs.main}/issues/@</github-issues>
	<github-wiki>https://github.com/spring-cloud/${docs.main}/wiki@</github-wiki>
	<github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master@
	</github-master-code>
	<index-link>${index-link}@</index-link>

	<!-- Spring Cloud specific -->
	<!-- for backward compatibility -->
	<spring-cloud-version>${project.version}@</spring-cloud-version>
	<project-version>${project.version}@</project-version>
	<github-tag>${github-tag}@</github-tag>
	<version-type>${version-type}@</version-type>
	<docs-url>/${docs.main}/docs/${project.version}@</docs-url>
	<raw-docs-url>${github-raw}@</raw-docs-url>
	<project-version>${project.version}@</project-version>
	<project-name>${docs.main}@</project-name>
	<source-highlighter>highlight.js</source-highlighter>
</attributes>

更新指南

我们假设您的项目在该guides文件夹下包含指南。

.
└── guides
	├── gs-guide1
	├── gs-guide2
	└── gs-guide3

这意味着该项目包含 3 个指南，与 Spring Guides 组织中的以下指南相对应。

-Pguides如果您使用这样的配置文件部署项目

$ ./mvnw clean deploy -Pguides

对于 GA 项目版本，我们将克隆并gs-guide1使用您项目下的内容更新其内容。gs-guide2gs-guide3guides

您可以通过不添加guides配置文件或-DskipGuides在配置文件打开时传递系统属性来跳过此步骤。

guides-project.version您可以通过（默认为）配置传递给指南的项目版本${project.version}。指南更新的阶段可以通过配置guides-update.phase（默认为deploy）。

1	由于 Checkstyle 错误而导致构建失败
2	因 Checkstyle 违规而导致构建失败
3	Checkstyle 还分析测试源
4	添加 Spring Java Format 插件，该插件将重新格式化您的代码以通过大多数 Checkstyle 格式化规则
5	将 checkstyle 插件添加到您的构建和报告阶段

1	默认 Checkstyle 规则
2	文件头设置
3	默认抑制规则
4	Intellij 的项目默认应用了大多数 Checkstyle 规则
5	应用大多数 Checkstyle 规则的 Intellij 项目样式约定

Spring Cloud构建

构建和部署

贡献

签署贡献者许可协议

行为守则

代码约定和内务管理

格子风格

检查样式配置

IDE设置

Intellij IDEA

重复查找器

重复查找器配置

展平 POM

重用文档

更新指南