root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Remove the ability to run an application in the Maven process

Browse Source 
Closes gh-30501
pull/30507/head
Stephane Nicoll 3 years ago
parent 6d7b14a5a2
commit 5f66019706
17 changed files with 28 additions and 708 deletions
Show Stats Download Patch File Download Diff File

3
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/integration-tests.adoc
Unescape Escape View File

@ -10,7 +10,8 @@ include::../maven/integration-tests/pom.xml[tags=integration-tests]
Such setup can now use the https://maven.apache.org/surefire/maven-failsafe-plugin[failsafe-plugin] to run your integration tests as you would expect. Such setup can now use the https://maven.apache.org/surefire/maven-failsafe-plugin[failsafe-plugin] to run your integration tests as you would expect.
NOTE: By default, the application is started in a separate process and JMX is used to communicate with the application. NOTE: The application is started in a separate process and JMX is used to communicate with the application.
By default, the plugin uses port `9001`.
If you need to configure the JMX port, see <<integration-tests.examples.jmx-port,the dedicated example>>. If you need to configure the JMX port, see <<integration-tests.examples.jmx-port,the dedicated example>>.
You could also configure a more advanced setup to skip the integration tests when a specific property has been set, see <<integration-tests.examples.skip,the dedicated example>>. You could also configure a more advanced setup to skip the integration tests when a specific property has been set, see <<integration-tests.examples.skip,the dedicated example>>.

3
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/running.adoc
Unescape Escape View File

@ -15,9 +15,6 @@ There is also explicit support for <<run.examples.system-properties,system prope
As enabling a profile is quite common, there is dedicated `profiles` property that offers a shortcut for `-Dspring-boot.run.jvmArguments="-Dspring.profiles.active=dev"`, see <<run.examples.specify-active-profiles,Specify active profiles>>. As enabling a profile is quite common, there is dedicated `profiles` property that offers a shortcut for `-Dspring-boot.run.jvmArguments="-Dspring.profiles.active=dev"`, see <<run.examples.specify-active-profiles,Specify active profiles>>.
Although this is not recommended (and deprecated), it is possible to execute the application directly from the Maven JVM by disabling the `fork` property.
Doing so means that the `jvmArguments`, `systemPropertyVariables`, `environmentVariables` and `agents` options are ignored.
Spring Boot `devtools` is a module to improve the development-time experience when working on Spring Boot applications. Spring Boot `devtools` is a module to improve the development-time experience when working on Spring Boot applications.
To enable it, just add the following dependency to your project: To enable it, just add the following dependency to your project:

23
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/RunIntegrationTests.java
Unescape Escape View File

@ -44,22 +44,6 @@ class RunIntegrationTests {
}); });
} }
@TestTemplate
@Deprecated
void whenForkingIsDisabledAndDevToolsIsPresentDevToolsIsDisabled(MavenBuild mavenBuild) {
mavenBuild.project("run-devtools").goals("spring-boot:run").execute((project) -> assertThat(buildLog(project))
.contains("I haz been run").contains("Fork mode disabled, devtools will be disabled"));
}
@TestTemplate
@Deprecated
void whenForkingIsDisabledJvmArgumentsAndWorkingDirectoryAreIgnored(MavenBuild mavenBuild) {
mavenBuild.project("run-disable-fork").goals("spring-boot:run")
.execute((project) -> assertThat(buildLog(project)).contains("I haz been run").contains(
"Fork mode disabled, ignoring JVM argument(s) [-Dproperty1=value1 -Dproperty2 -Dfoo=bar]")
.contains("Fork mode disabled, ignoring working directory configuration"));
}
@TestTemplate @TestTemplate
void whenEnvironmentVariablesAreConfiguredTheyAreAvailableToTheApplication(MavenBuild mavenBuild) { void whenEnvironmentVariablesAreConfiguredTheyAreAvailableToTheApplication(MavenBuild mavenBuild) {
mavenBuild.project("run-envargs").goals("spring-boot:run") mavenBuild.project("run-envargs").goals("spring-boot:run")
@ -104,13 +88,6 @@ class RunIntegrationTests {
(project) -> assertThat(buildLog(project)).contains("I haz been run with profile(s) 'foo,bar'")); (project) -> assertThat(buildLog(project)).contains("I haz been run with profile(s) 'foo,bar'"));
} }
@TestTemplate
@Deprecated
void whenProfilesAreConfiguredAndForkingIsDisabledTheyArePassedToTheApplication(MavenBuild mavenBuild) {
mavenBuild.project("run-profiles-fork-disabled").goals("spring-boot:run").execute(
(project) -> assertThat(buildLog(project)).contains("I haz been run with profile(s) 'foo,bar'"));
}
@TestTemplate @TestTemplate
void whenUseTestClasspathIsEnabledTheApplicationHasTestDependenciesOnItsClasspath(MavenBuild mavenBuild) { void whenUseTestClasspathIsEnabledTheApplicationHasTestDependenciesOnItsClasspath(MavenBuild mavenBuild) {
mavenBuild.project("run-use-test-classpath").goals("spring-boot:run") mavenBuild.project("run-use-test-classpath").goals("spring-boot:run")

7
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/StartStopIntegrationTests.java
Unescape Escape View File

@ -32,13 +32,6 @@ import static org.assertj.core.api.Assertions.contentOf;
@ExtendWith(MavenBuildExtension.class) @ExtendWith(MavenBuildExtension.class)
class StartStopIntegrationTests { class StartStopIntegrationTests {
@TestTemplate
@Deprecated
void startStopWithForkDisabledWaitsForApplicationToBeReadyAndThenRequestsShutdown(MavenBuild mavenBuild) {
mavenBuild.project("start-stop-fork-disabled").goals("verify").execute(
(project) -> assertThat(buildLog(project)).contains("isReady: true").contains("Shutdown requested"));
}
@TestTemplate @TestTemplate
void startStopWaitsForApplicationToBeReadyAndThenRequestsShutdown(MavenBuild mavenBuild) { void startStopWaitsForApplicationToBeReadyAndThenRequestsShutdown(MavenBuild mavenBuild) {
mavenBuild.project("start-stop").goals("verify").execute( mavenBuild.project("start-stop").goals("verify").execute(

27
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-devtools/pom.xml
Unescape Escape View File

@ -1,27 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.boot.maven.it</groupId>
<artifactId>run-devtools</artifactId>
<version>0.0.1.BUILD-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>@java.version@</maven.compiler.source>
<maven.compiler.target>@java.version@</maven.compiler.target>
</properties>
<!-- Devtools cannot be added here but the project has the class
that the code is looking for -->
<build>
<plugins>
<plugin>
<groupId>@project.groupId@</groupId>
<artifactId>@project.artifactId@</artifactId>
<version>@project.version@</version>
<configuration>
<fork>false</fork>
</configuration>
</plugin>
</plugins>
</build>
</project>

25
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-devtools/src/main/java/org/springframework/boot/devtools/restart/Restarter.java
Unescape Escape View File

@ -1,25 +0,0 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.devtools.restart;
/**
* Only meant to make sure that the plugin considers that devtools
* is present.
*/
public class Restarter {
}

25
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-devtools/src/main/java/org/test/SampleApplication.java
Unescape Escape View File

@ -1,25 +0,0 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.test;
public class SampleApplication {
public static void main(String[] args) {
System.out.println("I haz been run");
}
}

31
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-disable-fork/pom.xml
Unescape Escape View File

@ -1,31 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.boot.maven.it</groupId>
<artifactId>run-disable-fork</artifactId>
<version>0.0.1.BUILD-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>@java.version@</maven.compiler.source>
<maven.compiler.target>@java.version@</maven.compiler.target>
</properties>
<build>
<plugins>
<plugin>
<groupId>@project.groupId@</groupId>
<artifactId>@project.artifactId@</artifactId>
<version>@project.version@</version>
<configuration>
<fork>false</fork>
<jvmArguments>-Dfoo=bar</jvmArguments>
<workingDirectory>${project.build.sourceDirectory}</workingDirectory>
<systemPropertyVariables>
<property1>value1</property1>
<property2/>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
</project>

29
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-disable-fork/src/main/java/org/test/SampleApplication.java
Unescape Escape View File

@ -1,29 +0,0 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.test;
public class SampleApplication {
public static void main(String[] args) {
String foo = System.getProperty("foo");
if ("bar".equals(foo)) {
throw new IllegalStateException("System property foo should not be available. Fork disabled");
}
System.out.println("I haz been run");
}
}

29
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-profiles-fork-disabled/pom.xml
Unescape Escape View File

@ -1,29 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.boot.maven.it</groupId>
<artifactId>run-profiles</artifactId>
<version>0.0.1.BUILD-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>@java.version@</maven.compiler.source>
<maven.compiler.target>@java.version@</maven.compiler.target>
</properties>
<build>
<plugins>
<plugin>
<groupId>@project.groupId@</groupId>
<artifactId>@project.artifactId@</artifactId>
<version>@project.version@</version>
<configuration>
<fork>false</fork>
<profiles>
<profile>foo</profile>
<profile>bar</profile>
</profiles>
</configuration>
</plugin>
</plugins>
</build>
</project>

36
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-profiles-fork-disabled/src/main/java/org/test/SampleApplication.java
Unescape Escape View File

@ -1,36 +0,0 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.test;
import java.util.Arrays;
public class SampleApplication {
public static void main(String[] args) {
if (args.length < 1) {
throw new IllegalArgumentException("Missing active profile argument " + Arrays.toString(args));
}
String argument = args[0];
if (!argument.startsWith("--spring.profiles.active=")) {
throw new IllegalArgumentException("Invalid argument " + argument);
}
int index = args[0].indexOf('=');
String profile = argument.substring(index + 1);
System.out.println("I haz been run with profile(s) '" + profile + "'");
}
}

36
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/start-stop-fork-disabled/pom.xml
Unescape Escape View File

@ -1,36 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.boot.maven.it</groupId>
<artifactId>start-stop</artifactId>
<version>0.0.1.BUILD-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>@java.version@</maven.compiler.source>
<maven.compiler.target>@java.version@</maven.compiler.target>
</properties>
<build>
<plugins>
<plugin>
<groupId>@project.groupId@</groupId>
<artifactId>@project.artifactId@</artifactId>
<version>@project.version@</version>
<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>
</project>

81
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/start-stop-fork-disabled/src/main/java/org/test/SampleApplication.java
Unescape Escape View File

@ -1,81 +0,0 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.test;
import java.lang.management.ManagementFactory;
import javax.management.MBeanServer;
import javax.management.ObjectName;
/**
* This sample app simulates the JMX Mbean that is exposed by the Spring Boot application.
*/
public class SampleApplication {
private static final Object lock = new Object();
public static void main(String[] args) throws Exception {
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
ObjectName name = new ObjectName(
"org.springframework.boot:type=Admin,name=SpringApplication");
SpringApplicationAdmin mbean = new SpringApplicationAdmin();
mbs.registerMBean(mbean, name);
// Flag the app as ready
mbean.ready = true;
int waitAttempts = 0;
while (!mbean.shutdownInvoked) {
if (waitAttempts > 10) {
throw new IllegalStateException(
"Shutdown should have been invoked by now");
}
synchronized (lock) {
lock.wait(250);
}
waitAttempts++;
}
}
public interface SpringApplicationAdminMXBean {
boolean isReady();
void shutdown();
}
static class SpringApplicationAdmin implements SpringApplicationAdminMXBean {
private boolean ready;
private boolean shutdownInvoked;
@Override
public boolean isReady() {
System.out.println("isReady: " + this.ready);
return this.ready;
}
@Override
public void shutdown() {
this.shutdownInvoked = true;
System.out.println("Shutdown requested");
}
}
}

168
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java
Unescape Escape View File

@ -18,7 +18,6 @@ package org.springframework.boot.maven;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.lang.reflect.Method;
import java.net.MalformedURLException; import java.net.MalformedURLException;
import java.net.URL; import java.net.URL;
import java.util.ArrayList; import java.util.ArrayList;
@ -95,7 +94,7 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
private boolean addResources = false; private boolean addResources = false;
/** /**
* Path to agent jars. NOTE: a forked process is required to use this feature. * Path to agent jars.
* @since 2.2.0 * @since 2.2.0
*/ */
@Parameter(property = "spring-boot.run.agents") @Parameter(property = "spring-boot.run.agents")
@ -110,7 +109,7 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
/** /**
* Current working directory to use for the application. If not specified, basedir * Current working directory to use for the application. If not specified, basedir
* will be used. NOTE: a forked process is required to use this feature. * will be used.
* @since 1.5.0 * @since 1.5.0
*/ */
@Parameter(property = "spring-boot.run.workingDirectory") @Parameter(property = "spring-boot.run.workingDirectory")
@ -119,15 +118,13 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
/** /**
* JVM arguments that should be associated with the forked process used to run the * JVM arguments that should be associated with the forked process used to run the
* application. On command line, make sure to wrap multiple values between quotes. * application. On command line, make sure to wrap multiple values between quotes.
* NOTE: a forked process is required to use this feature.
* @since 1.1.0 * @since 1.1.0
*/ */
@Parameter(property = "spring-boot.run.jvmArguments") @Parameter(property = "spring-boot.run.jvmArguments")
private String jvmArguments; private String jvmArguments;
/** /**
* List of JVM system properties to pass to the process. NOTE: a forked process is * List of JVM system properties to pass to the process.
* required to use this feature.
* @since 2.1.0 * @since 2.1.0
*/ */
@Parameter @Parameter
@ -135,8 +132,7 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
/** /**
* List of Environment variables that should be associated with the forked process * List of Environment variables that should be associated with the forked process
* used to run the application. NOTE: a forked process is required to use this * used to run the application.
* feature.
* @since 2.1.0 * @since 2.1.0
*/ */
@Parameter @Parameter
@ -191,17 +187,6 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
@Parameter(defaultValue = "${project.build.outputDirectory}", required = true) @Parameter(defaultValue = "${project.build.outputDirectory}", required = true)
private File classesDirectory; private File classesDirectory;
/**
* Deprecated. Flag to indicate if the run processes should be forked. Disabling
* forking will disable some features such as an agent, custom JVM arguments, devtools
* or specifying the working directory to use.
* @since 1.2.0
* @deprecated since 2.7.0 for removal in 3.0.0 with no replacement
*/
@Parameter(property = "spring-boot.run.fork", defaultValue = "true")
@Deprecated
private boolean fork;
/** /**
* Flag to include the test classpath when running. * Flag to include the test classpath when running.
* @since 1.3.0 * @since 1.3.0
@ -225,71 +210,14 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
run(getStartClass()); run(getStartClass());
} }
/**
* Specify if the application process should be forked.
* @return {@code true} if the application process should be forked
* @deprecated since 2.7.0 for removal in 3.0.0 with no replacement
*/
@Deprecated
protected boolean isFork() {
return this.fork;
}
private boolean hasAgent() {
return (this.agents != null && this.agents.length > 0);
}
private boolean hasJvmArgs() {
return (this.jvmArguments != null && !this.jvmArguments.isEmpty())
|| (this.systemPropertyVariables != null && !this.systemPropertyVariables.isEmpty());
}
private boolean hasWorkingDirectorySet() {
return this.workingDirectory != null;
}
@SuppressWarnings("deprecation")
private void run(String startClassName) throws MojoExecutionException, MojoFailureException { private void run(String startClassName) throws MojoExecutionException, MojoFailureException {
boolean fork = isFork();
this.project.getProperties().setProperty("_spring.boot.fork.enabled", Boolean.toString(fork));
if (fork) {
doRunWithForkedJvm(startClassName);
}
else {
logDisabledFork();
runWithMavenJvm(startClassName, resolveApplicationArguments().asArray());
}
}
/**
* Log a warning indicating that fork mode has been explicitly disabled while some
* conditions are present that require to enable it.
*/
@Deprecated
protected void logDisabledFork() {
if (getLog().isWarnEnabled()) {
if (hasAgent()) {
getLog().warn("Fork mode disabled, ignoring agent");
}
if (hasJvmArgs()) {
RunArguments runArguments = resolveJvmArguments();
getLog().warn("Fork mode disabled, ignoring JVM argument(s) ["
+ String.join(" ", runArguments.asArray()) + "]");
}
if (hasWorkingDirectorySet()) {
getLog().warn("Fork mode disabled, ignoring working directory configuration");
}
}
}
private void doRunWithForkedJvm(String startClassName) throws MojoExecutionException, MojoFailureException {
List<String> args = new ArrayList<>(); List<String> args = new ArrayList<>();
addAgents(args); addAgents(args);
addJvmArgs(args); addJvmArgs(args);
addClasspath(args); addClasspath(args);
args.add(startClassName); args.add(startClassName);
addArgs(args); addArgs(args);
runWithForkedJvm((this.workingDirectory != null) ? this.workingDirectory : this.project.getBasedir(), args, run((this.workingDirectory != null) ? this.workingDirectory : this.project.getBasedir(), args,
determineEnvironmentVariables()); determineEnvironmentVariables());
} }
@ -301,19 +229,7 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
* @throws MojoExecutionException in case of MOJO execution errors * @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures * @throws MojoFailureException in case of MOJO failures
*/ */
protected abstract void runWithForkedJvm(File workingDirectory, List<String> args, protected abstract void run(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
Map<String, String> environmentVariables) throws MojoExecutionException, MojoFailureException;
/**
* Run with the current VM, using the specified arguments.
* @param startClassName the class to run
* @param arguments the class arguments
* @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures
* @deprecated since 2.7.0 for removal in 3.0.0 with no replacement
*/
@Deprecated
protected abstract void runWithMavenJvm(String startClassName, String... arguments)
throws MojoExecutionException, MojoFailureException; throws MojoExecutionException, MojoFailureException;
/** /**
@ -510,78 +426,6 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
} }
/**
* Isolated {@link ThreadGroup} to capture uncaught exceptions.
*/
class IsolatedThreadGroup extends ThreadGroup {
private final Object monitor = new Object();
private Throwable exception;
IsolatedThreadGroup(String name) {
super(name);
}
@Override
public void uncaughtException(Thread thread, Throwable ex) {
if (!(ex instanceof ThreadDeath)) {
synchronized (this.monitor) {
this.exception = (this.exception != null) ? this.exception : ex;
}
getLog().warn(ex);
}
}
void rethrowUncaughtException() throws MojoExecutionException {
synchronized (this.monitor) {
if (this.exception != null) {
throw new MojoExecutionException(
"An exception occurred while running. " + this.exception.getMessage(), this.exception);
}
}
}
}
/**
* Runner used to launch the application.
*/
class LaunchRunner implements Runnable {
private final String startClassName;
private final String[] args;
LaunchRunner(String startClassName, String... args) {
this.startClassName = startClassName;
this.args = (args != null) ? args : new String[] {};
}
@Override
public void run() {
Thread thread = Thread.currentThread();
ClassLoader classLoader = thread.getContextClassLoader();
try {
Class<?> startClass = Class.forName(this.startClassName, false, classLoader);
Method mainMethod = startClass.getMethod("main", String[].class);
if (!mainMethod.canAccess(null)) {
mainMethod.setAccessible(true);
}
mainMethod.invoke(null, new Object[] { this.args });
}
catch (NoSuchMethodException ex) {
Exception wrappedEx = new Exception(
"The specified mainClass doesn't contain a main method with appropriate signature.", ex);
thread.getThreadGroup().uncaughtException(thread, wrappedEx);
}
catch (Exception ex) {
thread.getThreadGroup().uncaughtException(thread, ex);
}
}
}
/** /**
* Format System properties. * Format System properties.
*/ */

74
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/RunMojo.java
Unescape Escape View File

@ -18,8 +18,6 @@ package org.springframework.boot.maven;
import java.io.File; import java.io.File;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@ -48,13 +46,6 @@ public class RunMojo extends AbstractRunMojo {
private static final int EXIT_CODE_SIGINT = 130; private static final int EXIT_CODE_SIGINT = 130;
private static final String RESTARTER_CLASS_LOCATION = "org/springframework/boot/devtools/restart/Restarter.class";
/**
* Devtools presence flag to avoid checking for it several times per execution.
*/
private Boolean hasDevtools;
/** /**
* Whether the JVM's launch should be optimized. * Whether the JVM's launch should be optimized.
* @since 2.2.0 * @since 2.2.0
@ -63,19 +54,9 @@ public class RunMojo extends AbstractRunMojo {
private boolean optimizedLaunch; private boolean optimizedLaunch;
@Override @Override
@Deprecated
protected void logDisabledFork() {
super.logDisabledFork();
if (hasDevtools()) {
getLog().warn("Fork mode disabled, devtools will be disabled");
}
}
@Override
@SuppressWarnings("deprecation")
protected RunArguments resolveJvmArguments() { protected RunArguments resolveJvmArguments() {
RunArguments jvmArguments = super.resolveJvmArguments(); RunArguments jvmArguments = super.resolveJvmArguments();
if (isFork() && this.optimizedLaunch) { if (this.optimizedLaunch) {
jvmArguments.getArgs().addFirst("-XX:TieredStopAtLevel=1"); jvmArguments.getArgs().addFirst("-XX:TieredStopAtLevel=1");
if (!isJava13OrLater()) { if (!isJava13OrLater()) {
jvmArguments.getArgs().addFirst("-Xverify:none"); jvmArguments.getArgs().addFirst("-Xverify:none");
@ -94,7 +75,7 @@ public class RunMojo extends AbstractRunMojo {
} }
@Override @Override
protected void runWithForkedJvm(File workingDirectory, List<String> args, Map<String, String> environmentVariables) protected void run(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
throws MojoExecutionException { throws MojoExecutionException {
int exitCode = forkJvm(workingDirectory, args, environmentVariables); int exitCode = forkJvm(workingDirectory, args, environmentVariables);
if (exitCode == 0 || exitCode == EXIT_CODE_SIGINT) { if (exitCode == 0 || exitCode == EXIT_CODE_SIGINT) {
@ -115,57 +96,6 @@ public class RunMojo extends AbstractRunMojo {
} }
} }
@Override
@Deprecated
protected void runWithMavenJvm(String startClassName, String... arguments) throws MojoExecutionException {
IsolatedThreadGroup threadGroup = new IsolatedThreadGroup(startClassName);
Thread launchThread = new Thread(threadGroup, new LaunchRunner(startClassName, arguments), "main");
launchThread.setContextClassLoader(new URLClassLoader(getClassPathUrls()));
launchThread.start();
join(threadGroup);
threadGroup.rethrowUncaughtException();
}
private void join(ThreadGroup threadGroup) {
boolean hasNonDaemonThreads;
do {
hasNonDaemonThreads = false;
Thread[] threads = new Thread[threadGroup.activeCount()];
threadGroup.enumerate(threads);
for (Thread thread : threads) {
if (thread != null && !thread.isDaemon()) {
try {
hasNonDaemonThreads = true;
thread.join();
}
catch (InterruptedException ex) {
Thread.currentThread().interrupt();
}
}
}
}
while (hasNonDaemonThreads);
}
private boolean hasDevtools() {
if (this.hasDevtools == null) {
this.hasDevtools = checkForDevtools();
}
return this.hasDevtools;
}
private boolean checkForDevtools() {
try {
URL[] urls = getClassPathUrls();
try (URLClassLoader classLoader = new URLClassLoader(urls)) {
return (classLoader.findResource(RESTARTER_CLASS_LOCATION) != null);
}
}
catch (Exception ex) {
return false;
}
}
private static final class RunProcessKiller implements Runnable { private static final class RunProcessKiller implements Runnable {
private final RunProcess runProcess; private final RunProcess runProcess;

83
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StartMojo.java
Unescape Escape View File

@ -18,9 +18,7 @@ package org.springframework.boot.maven;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.lang.management.ManagementFactory;
import java.net.ConnectException; import java.net.ConnectException;
import java.net.URLClassLoader;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@ -65,7 +63,7 @@ public class StartMojo extends AbstractRunMojo {
private String jmxName; private String jmxName;
/** /**
* The port to use to expose the platform MBeanServer if the application is forked. * The port to use to expose the platform MBeanServer.
*/ */
@Parameter(defaultValue = "9001") @Parameter(defaultValue = "9001")
private int jmxPort; private int jmxPort;
@ -88,7 +86,7 @@ public class StartMojo extends AbstractRunMojo {
private final Object lock = new Object(); private final Object lock = new Object();
@Override @Override
protected void runWithForkedJvm(File workingDirectory, List<String> args, Map<String, String> environmentVariables) protected void run(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
throws MojoExecutionException, MojoFailureException { throws MojoExecutionException, MojoFailureException {
RunProcess runProcess = runProcess(workingDirectory, args, environmentVariables); RunProcess runProcess = runProcess(workingDirectory, args, environmentVariables);
try { try {
@ -113,86 +111,27 @@ public class StartMojo extends AbstractRunMojo {
} }
@Override @Override
@SuppressWarnings("deprecation")
protected RunArguments resolveApplicationArguments() { protected RunArguments resolveApplicationArguments() {
RunArguments applicationArguments = super.resolveApplicationArguments(); RunArguments applicationArguments = super.resolveApplicationArguments();
applicationArguments.getArgs().addLast(ENABLE_MBEAN_PROPERTY); applicationArguments.getArgs().addLast(ENABLE_MBEAN_PROPERTY);
if (isFork()) { applicationArguments.getArgs().addLast(JMX_NAME_PROPERTY_PREFIX + this.jmxName);
applicationArguments.getArgs().addLast(JMX_NAME_PROPERTY_PREFIX + this.jmxName);
}
return applicationArguments; return applicationArguments;
} }
@Override @Override
@SuppressWarnings("deprecation")
protected RunArguments resolveJvmArguments() { protected RunArguments resolveJvmArguments() {
RunArguments jvmArguments = super.resolveJvmArguments(); RunArguments jvmArguments = super.resolveJvmArguments();
if (isFork()) { List<String> remoteJmxArguments = new ArrayList<>();
List<String> remoteJmxArguments = new ArrayList<>(); remoteJmxArguments.add("-Dcom.sun.management.jmxremote");
remoteJmxArguments.add("-Dcom.sun.management.jmxremote"); remoteJmxArguments.add("-Dcom.sun.management.jmxremote.port=" + this.jmxPort);
remoteJmxArguments.add("-Dcom.sun.management.jmxremote.port=" + this.jmxPort); remoteJmxArguments.add("-Dcom.sun.management.jmxremote.authenticate=false");
remoteJmxArguments.add("-Dcom.sun.management.jmxremote.authenticate=false"); remoteJmxArguments.add("-Dcom.sun.management.jmxremote.ssl=false");
remoteJmxArguments.add("-Dcom.sun.management.jmxremote.ssl=false"); remoteJmxArguments.add("-Djava.rmi.server.hostname=127.0.0.1");
remoteJmxArguments.add("-Djava.rmi.server.hostname=127.0.0.1"); jvmArguments.getArgs().addAll(remoteJmxArguments);
jvmArguments.getArgs().addAll(remoteJmxArguments);
}
return jvmArguments; return jvmArguments;
} }
@Override
@Deprecated
protected void runWithMavenJvm(String startClassName, String... arguments) throws MojoExecutionException {
IsolatedThreadGroup threadGroup = new IsolatedThreadGroup(startClassName);
Thread launchThread = new Thread(threadGroup, new LaunchRunner(startClassName, arguments),
startClassName + ".main()");
launchThread.setContextClassLoader(new URLClassLoader(getClassPathUrls()));
launchThread.start();
waitForSpringApplication(this.wait, this.maxAttempts);
}
private void waitForSpringApplication(long wait, int maxAttempts) throws MojoExecutionException {
SpringApplicationAdminClient client = new SpringApplicationAdminClient(
ManagementFactory.getPlatformMBeanServer(), this.jmxName);
getLog().debug("Waiting for spring application to start...");
for (int i = 0; i < maxAttempts; i++) {
if (client.isReady()) {
return;
}
String message = "Spring application is not ready yet, waiting " + wait + "ms (attempt " + (i + 1) + ")";
getLog().debug(message);
synchronized (this.lock) {
try {
this.lock.wait(wait);
}
catch (InterruptedException ex) {
Thread.currentThread().interrupt();
throw new IllegalStateException("Interrupted while waiting for Spring Boot app to start.");
}
}
}
throw new MojoExecutionException(
"Spring application did not start before the configured timeout (" + (wait * maxAttempts) + "ms");
}
@SuppressWarnings("deprecation")
private void waitForSpringApplication() throws MojoFailureException, MojoExecutionException { private void waitForSpringApplication() throws MojoFailureException, MojoExecutionException {
try {
if (isFork()) {
waitForForkedSpringApplication();
}
else {
doWaitForSpringApplication(ManagementFactory.getPlatformMBeanServer());
}
}
catch (IOException ex) {
throw new MojoFailureException("Could not contact Spring Boot application", ex);
}
catch (Exception ex) {
throw new MojoExecutionException("Could not figure out if the application has started", ex);
}
}
private void waitForForkedSpringApplication() throws IOException, MojoFailureException, MojoExecutionException {
try { try {
getLog().debug("Connecting to local MBeanServer at port " + this.jmxPort); getLog().debug("Connecting to local MBeanServer at port " + this.jmxPort);
try (JMXConnector connector = execute(this.wait, this.maxAttempts, new CreateJmxConnector(this.jmxPort))) { try (JMXConnector connector = execute(this.wait, this.maxAttempts, new CreateJmxConnector(this.jmxPort))) {
@ -206,7 +145,7 @@ public class StartMojo extends AbstractRunMojo {
} }
} }
catch (IOException ex) { catch (IOException ex) {
throw ex; throw new MojoFailureException("Could not contact Spring Boot application", ex);
} }
catch (Exception ex) { catch (Exception ex) {
throw new MojoExecutionException("Failed to connect to MBean server at port " + this.jmxPort, ex); throw new MojoExecutionException("Failed to connect to MBean server at port " + this.jmxPort, ex);

56
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/StopMojo.java
Unescape Escape View File

@ -17,7 +17,6 @@
package org.springframework.boot.maven; package org.springframework.boot.maven;
import java.io.IOException; import java.io.IOException;
import java.lang.management.ManagementFactory;
import javax.management.InstanceNotFoundException; import javax.management.InstanceNotFoundException;
import javax.management.MBeanServerConnection; import javax.management.MBeanServerConnection;
@ -48,18 +47,6 @@ public class StopMojo extends AbstractMojo {
@Parameter(defaultValue = "${project}", readonly = true, required = true) @Parameter(defaultValue = "${project}", readonly = true, required = true)
private MavenProject project; private MavenProject project;
/**
* Flag to indicate if the process to stop was forked. By default, the value is
* inherited from the {@link MavenProject} with a fallback on the default fork value
* ({@code true}). If it is set, it must match the value used to {@link StartMojo
* start} the process.
* @since 1.3.0
* @deprecated since 2.7.0 for removal in 3.0.0 with no replacement
*/
@Parameter(property = "spring-boot.stop.fork")
@Deprecated
private Boolean fork;
/** /**
* The JMX name of the automatically deployed MBean managing the lifecycle of the * The JMX name of the automatically deployed MBean managing the lifecycle of the
* application. * application.
@ -68,8 +55,7 @@ public class StopMojo extends AbstractMojo {
private String jmxName; private String jmxName;
/** /**
* The port to use to lookup the platform MBeanServer if the application has been * The port to use to lookup the platform MBeanServer.
* forked.
*/ */
@Parameter(defaultValue = "9001") @Parameter(defaultValue = "9001")
private int jmxPort; private int jmxPort;
@ -82,20 +68,15 @@ public class StopMojo extends AbstractMojo {
private boolean skip; private boolean skip;
@Override @Override
@SuppressWarnings("deprecation")
public void execute() throws MojoExecutionException, MojoFailureException { public void execute() throws MojoExecutionException, MojoFailureException {
if (this.skip) { if (this.skip) {
getLog().debug("skipping stop as per configuration."); getLog().debug("skipping stop as per configuration.");
return; return;
} }
getLog().info("Stopping application..."); getLog().info("Stopping application...");
try { try (JMXConnector connector = SpringApplicationAdminClient.connect(this.jmxPort)) {
if (isForked()) { MBeanServerConnection connection = connector.getMBeanServerConnection();
stopForkedProcess(); stop(connection);
}
else {
stop();
}
} }
catch (IOException ex) { catch (IOException ex) {
// The response won't be received as the server has died - ignoring // The response won't be received as the server has died - ignoring
@ -103,36 +84,13 @@ public class StopMojo extends AbstractMojo {
} }
} }
@Deprecated private void stop(MBeanServerConnection connection) throws IOException, MojoExecutionException {
private boolean isForked() {
if (this.fork != null) {
return this.fork;
}
String forkFromStart = this.project.getProperties().getProperty("_spring.boot.fork.enabled");
if (forkFromStart != null) {
return Boolean.parseBoolean(forkFromStart);
}
return true;
}
private void stopForkedProcess() throws IOException, MojoFailureException, MojoExecutionException {
try (JMXConnector connector = SpringApplicationAdminClient.connect(this.jmxPort)) {
MBeanServerConnection connection = connector.getMBeanServerConnection();
doStop(connection);
}
}
private void stop() throws IOException, MojoFailureException, MojoExecutionException {
doStop(ManagementFactory.getPlatformMBeanServer());
}
private void doStop(MBeanServerConnection connection) throws IOException, MojoExecutionException {
try { try {
new SpringApplicationAdminClient(connection, this.jmxName).stop(); new SpringApplicationAdminClient(connection, this.jmxName).stop();
} }
catch (InstanceNotFoundException ex) { catch (InstanceNotFoundException ex) {
throw new MojoExecutionException("Spring application lifecycle JMX bean not found (fork is " + this.fork throw new MojoExecutionException(
+ "). Could not stop application gracefully", ex); "Spring application lifecycle JMX bean not found. Could not stop application gracefully", ex);
} }
} }

Write Preview
Loading…
Cancel
Save