此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Boot 4.0.4!spring-doc.cadn.net.cn

运行集成测试

虽然您可以非常轻松地从测试(或测试套件)本身启动 Spring Boot 应用程序,但可能更希望在构建过程中处理该操作。 为了确保在集成测试期间正确管理 Spring Boot 应用程序的生命周期,您可以使用 startstop 目标,如下例所示:spring-doc.cadn.net.cn

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<executions>
				<execution>
					<id>pre-integration-test</id>
					<goals>
						<goal>start</goal>
					</goals>
				</execution>
				<execution>
					<id>post-integration-test</id>
					<goals>
						<goal>stop</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>

现在可以使用 failsafe-plugin 来运行您的集成测试,正如您所期望的那样。spring-doc.cadn.net.cn

应用程序在单独的进程中启动,并使用 JMX 与应用程序通信。 默认情况下,插件使用端口 9001。 如果需要配置 JMX 端口,请参阅 专用示例

您还可以配置更高级的设置,以便在设置了特定属性时跳过集成测试,请参阅专用示例spring-doc.cadn.net.cn

在不使用 Spring Boot 父 POM 的情况下使用 Failsafe

Spring Boot 的父级 POM,spring-boot-starter-parent,将 Failsafe 的 <classesDirectory> 配置为 ${project.build.outputDirectory}。 如果没有此配置(该配置使 Failsafe 使用编译后的类而非重新打包的 jar),Failsafe 将无法加载您应用程序的类。 如果您未使用父级 POM,则应以相同的方式配置 Failsafe,如下例所示:spring-doc.cadn.net.cn

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-failsafe-plugin</artifactId>
	<configuration>
		<classesDirectory>${project.build.outputDirectory}</classesDirectory>
	</configuration>
</plugin>

spring-boot:start

org.springframework.boot:spring-boot-maven-plugin:3.5.13-SNAPSHOTspring-doc.cadn.net.cn

启动一个 Spring 应用程序。与 run 目标相反,此操作不会阻塞,并允许其他目标对该应用程序进行操作。此目标通常用于集成测试场景,其中应用程序在测试套件之前启动,并在之后停止。spring-doc.cadn.net.cn

必需参数

名称 类型 默认

classesDirectoryspring-doc.cadn.net.cn

Filespring-doc.cadn.net.cn

${project.build.outputDirectory}spring-doc.cadn.net.cn

可选参数

名称 类型 默认

addResourcesspring-doc.cadn.net.cn

booleanspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

additionalClasspathElementsspring-doc.cadn.net.cn

String[]spring-doc.cadn.net.cn

代理spring-doc.cadn.net.cn

File[]spring-doc.cadn.net.cn

参数spring-doc.cadn.net.cn

String[]spring-doc.cadn.net.cn

commandlineArgumentsspring-doc.cadn.net.cn

Stringspring-doc.cadn.net.cn

environmentVariablesspring-doc.cadn.net.cn

Mapspring-doc.cadn.net.cn

excludeGroupIdsspring-doc.cadn.net.cn

Stringspring-doc.cadn.net.cn

排除项spring-doc.cadn.net.cn

Listspring-doc.cadn.net.cn

包含spring-doc.cadn.net.cn

Listspring-doc.cadn.net.cn

jmxNamespring-doc.cadn.net.cn

Stringspring-doc.cadn.net.cn

org.springframework.boot:type=Admin,name=SpringApplicationspring-doc.cadn.net.cn

jmxPortspring-doc.cadn.net.cn

intspring-doc.cadn.net.cn

9001spring-doc.cadn.net.cn

jvmArgumentsspring-doc.cadn.net.cn

Stringspring-doc.cadn.net.cn

mainClassspring-doc.cadn.net.cn

Stringspring-doc.cadn.net.cn

maxAttemptsspring-doc.cadn.net.cn

intspring-doc.cadn.net.cn

60spring-doc.cadn.net.cn

不验证spring-doc.cadn.net.cn

booleanspring-doc.cadn.net.cn

配置文件spring-doc.cadn.net.cn

String[]spring-doc.cadn.net.cn

跳过spring-doc.cadn.net.cn

booleanspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

systemPropertyVariablesspring-doc.cadn.net.cn

Mapspring-doc.cadn.net.cn

useTestClasspathspring-doc.cadn.net.cn

Booleanspring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

等待spring-doc.cadn.net.cn

longspring-doc.cadn.net.cn

500spring-doc.cadn.net.cn

workingDirectoryspring-doc.cadn.net.cn

Filespring-doc.cadn.net.cn

参数详情

addResources

将 Maven 资源直接添加到类路径中,这样可以对资源进行实时原地编辑。重复的资源会从 target/classes 中移除,以防止在调用 ClassLoader.getResources() 时它们出现两次。请考虑改为向您的项目添加 spring-boot-devtools,因为它提供了此功能以及更多其他功能。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

addResourcesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

booleanspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.addResourcesspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.0.0spring-doc.cadn.net.cn

additionalClasspathElements

应添加到类路径中的其他类路径元素。元素可以是包含类和资源的目录,也可以是 jar 文件。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

additionalClasspathElementsspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.String[]spring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.additional-classpath-elementsspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

3.2.0spring-doc.cadn.net.cn

classesDirectory

包含用于运行应用程序的类和资源文件的目录。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

classesDirectoryspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.io.Filespring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

${project.build.outputDirectory}spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.0.0spring-doc.cadn.net.cn

commandlineArguments

应从命令行传递给应用程序的参数。使用空格分隔多个参数,并确保将多个值用引号括起来。指定时,优先于 #argumentsspring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

commandlineArgumentsspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.argumentsspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

2.2.3spring-doc.cadn.net.cn

environmentVariables

应与用于运行应用程序的派生进程关联的环境变量列表。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

environmentVariablesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.util.Mapspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

2.1.0spring-doc.cadn.net.cn

excludeGroupIds

要排除的 groupId 名称列表(精确匹配),以逗号分隔。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

excludeGroupIdsspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.excludeGroupIdsspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.1.0spring-doc.cadn.net.cn

excludes

要排除的构件定义集合。第 Exclude 个元素定义了必需的 groupIdartifactId 组件,以及一个可选的 classifier 组件。当配置为属性时,值应以逗号分隔,组件之间以冒号分隔:groupId:artifactId,groupId:artifactId:classifierspring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

excludesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.util.Listspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.excludesspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.1.0spring-doc.cadn.net.cn

includes

要包含的构件定义集合。第 Include 个元素定义了必需的 groupIdartifactId 组件,以及一个可选的 classifier 组件。当配置为属性时,值应以逗号分隔,组件之间以冒号分隔:groupId:artifactId,groupId:artifactId:classifierspring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

includesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.util.Listspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.includesspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.2.0spring-doc.cadn.net.cn

jmxName

管理 Spring 应用程序生命周期的自动部署 MBean 的 JMX 名称。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

jmxNamespring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

org.springframework.boot:type=Admin,name=SpringApplicationspring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

jvmArguments

应与用于运行应用程序的派生进程关联的 JVM 参数。在命令行上,请确保将多个值用引号括起来。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

jvmArgumentsspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.jvmArgumentsspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.1.0spring-doc.cadn.net.cn

mainClass

主类的名称。如果未指定,将使用找到的第一个包含“main”方法的已编译类。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

mainClassspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.main-classspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.0.0spring-doc.cadn.net.cn

maxAttempts

检查 Spring 应用程序是否就绪的最大尝试次数。与“wait”参数结合使用时,这将给出一个全局超时值(默认为 30 秒)spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

maxAttemptsspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

intspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

60spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.start.maxAttemptsspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

profiles

要激活的 Spring 配置文件。这是指定 'spring.profiles.active' 参数的便捷快捷方式。在命令行上,使用逗号分隔多个配置文件。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

profilesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.String[]spring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.profilesspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.3.0spring-doc.cadn.net.cn

systemPropertyVariables

要传递给进程的 JVM 系统属性列表。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

systemPropertyVariablesspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.util.Mapspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

2.1.0spring-doc.cadn.net.cn

useTestClasspath

运行时包含测试类路径的标志。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

useTestClasspathspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Booleanspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

falsespring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.useTestClasspathspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

wait

每次尝试检查 Spring 应用程序是否就绪之间等待的毫秒数。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

waitspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

longspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

500spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.start.waitspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

workingDirectory

应用程序使用的当前工作目录。如果未指定,将使用 basedir。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

workingDirectoryspring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.io.Filespring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

spring-boot.run.workingDirectoryspring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

1.5.0spring-doc.cadn.net.cn

spring-boot:stop

org.springframework.boot:spring-boot-maven-plugin:3.5.13-SNAPSHOTspring-doc.cadn.net.cn

停止由“start”目标启动的应用程序。通常在测试套件完成后调用一次。spring-doc.cadn.net.cn

参数详情

jmxName

自动部署的 MBean 的 JMX 名称,该 MBean 负责管理应用程序的生命周期。spring-doc.cadn.net.cn

名称spring-doc.cadn.net.cn

jmxNamespring-doc.cadn.net.cn

类型spring-doc.cadn.net.cn

java.lang.Stringspring-doc.cadn.net.cn

默认值spring-doc.cadn.net.cn

org.springframework.boot:type=Admin,name=SpringApplicationspring-doc.cadn.net.cn

用户属性spring-doc.cadn.net.cn

自从spring-doc.cadn.net.cn

示例

集成测试的随机端口

Spring Boot 测试集成的一个良好特性是,它可以为 Web 应用程序分配一个空闲端口。 当使用插件的 start 目标时,Spring Boot 应用程序会单独启动,这使得难以将实际端口传递给集成测试本身。spring-doc.cadn.net.cn

下面的示例展示了如何使用 Build Helper Maven Plugin 实现相同的功能:spring-doc.cadn.net.cn

<build>
	<plugins>
		<plugin>
			<groupId>org.codehaus.mojo</groupId>
			<artifactId>build-helper-maven-plugin</artifactId>
			<executions>
				<execution>
					<id>reserve-tomcat-port</id>
					<goals>
						<goal>reserve-network-port</goal>
					</goals>
					<phase>process-resources</phase>
					<configuration>
						<portNames>
							<portName>tomcat.http.port</portName>
						</portNames>
					</configuration>
				</execution>
			</executions>
		</plugin>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<executions>
				<execution>
					<id>pre-integration-test</id>
					<goals>
						<goal>start</goal>
					</goals>
					<configuration>
						<arguments>
							<argument>--server.port=${tomcat.http.port}</argument>
						</arguments>
					</configuration>
				</execution>
				<execution>
					<id>post-integration-test</id>
					<goals>
						<goal>stop</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
		<plugin>
			<groupId>org.apache.maven.plugins</groupId>
			<artifactId>maven-failsafe-plugin</artifactId>
			<configuration>
				<systemPropertyVariables>
					<test.server.port>${tomcat.http.port}</test.server.port>
				</systemPropertyVariables>
			</configuration>
		</plugin>
	</plugins>
</build>

您现在可以在任何集成测试中检索 test.server.port 系统属性,以创建到服务器的正确 URLspring-doc.cadn.net.cn

自定义 JMX 端口

jmxPort 属性允许自定义插件用于与 Spring Boot 应用程序通信的端口。spring-doc.cadn.net.cn

此示例展示了在 9001 已被占用的情况下如何自定义端口:spring-doc.cadn.net.cn

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<configuration>
				<jmxPort>9009</jmxPort>
			</configuration>
			<executions>
				<execution>
					<id>pre-integration-test</id>
					<goals>
						<goal>start</goal>
					</goals>
				</execution>
				<execution>
					<id>post-integration-test</id>
					<goals>
						<goal>stop</goal>
					</goals>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>
如果您需要配置 JMX 端口,请确保按照上述示例在全局配置中进行设置,以便两个目标共享该配置。

跳过集成测试

skip 属性允许完全跳过 Spring Boot Maven 插件的执行。spring-doc.cadn.net.cn

此示例展示了如何通过命令行属性跳过集成测试,并确保 repackage 目标仍然运行:spring-doc.cadn.net.cn

<project>
	<properties>
		<skip.it>false</skip.it>
	</properties>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<executions>
					<execution>
						<id>pre-integration-test</id>
						<goals>
							<goal>start</goal>
						</goals>
						<configuration>
							<skip>${skip.it}</skip>
						</configuration>
					</execution>
					<execution>
						<id>post-integration-test</id>
						<goals>
							<goal>stop</goal>
						</goals>
						<configuration>
							<skip>${skip.it}</skip>
						</configuration>
					</execution>
				</executions>
			</plugin>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-failsafe-plugin</artifactId>
				<configuration>
					<skip>${skip.it}</skip>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

默认情况下,集成测试将会运行,但此设置允许您通过命令行轻松地禁用它们,如下所示:spring-doc.cadn.net.cn

$ mvn verify -Dskip.it=true