Update bootJar and bootWar to use new main class resolution mechanism
See gh-22922pull/23886/head
Andy Wilkinson
4 years ago
parent
c078a48064
commit
b1c4af4081
@ -1,109 +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.gradle.plugin;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.lang.reflect.Method;
|
|
||||||
import java.util.Objects;
|
|
||||||
import java.util.concurrent.Callable;
|
|
||||||
import java.util.function.Supplier;
|
|
||||||
|
|
||||||
import org.gradle.api.InvalidUserDataException;
|
|
||||||
import org.gradle.api.Project;
|
|
||||||
import org.gradle.api.file.FileCollection;
|
|
||||||
import org.gradle.api.plugins.JavaApplication;
|
|
||||||
import org.gradle.api.provider.Property;
|
|
||||||
|
|
||||||
import org.springframework.boot.gradle.dsl.SpringBootExtension;
|
|
||||||
import org.springframework.boot.loader.tools.MainClassFinder;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* A {@link Callable} that provides a convention for the project's main class name.
|
|
||||||
*
|
|
||||||
* @author Andy Wilkinson
|
|
||||||
*/
|
|
||||||
final class MainClassConvention implements Callable<String> {
|
|
||||||
|
|
||||||
private static final String SPRING_BOOT_APPLICATION_CLASS_NAME = "org.springframework.boot.autoconfigure.SpringBootApplication";
|
|
||||||
|
|
||||||
private final Project project;
|
|
||||||
|
|
||||||
private final Supplier<FileCollection> classpathSupplier;
|
|
||||||
|
|
||||||
MainClassConvention(Project project, Supplier<FileCollection> classpathSupplier) {
|
|
||||||
this.project = project;
|
|
||||||
this.classpathSupplier = classpathSupplier;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public String call() throws Exception {
|
|
||||||
SpringBootExtension springBootExtension = this.project.getExtensions().findByType(SpringBootExtension.class);
|
|
||||||
if (springBootExtension != null) {
|
|
||||||
String mainClass = springBootExtension.getMainClass().getOrNull();
|
|
||||||
if (mainClass != null) {
|
|
||||||
return mainClass;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
String javaApplicationMainClass = getJavaApplicationMainClass();
|
|
||||||
return (javaApplicationMainClass != null) ? javaApplicationMainClass : resolveMainClass();
|
|
||||||
}
|
|
||||||
|
|
||||||
@SuppressWarnings({ "unchecked", "deprecation" })
|
|
||||||
private String getJavaApplicationMainClass() {
|
|
||||||
JavaApplication javaApplication = this.project.getConvention().findByType(JavaApplication.class);
|
|
||||||
if (javaApplication == null) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
Method getMainClass = findMethod(JavaApplication.class, "getMainClass");
|
|
||||||
if (getMainClass != null) {
|
|
||||||
try {
|
|
||||||
Property<String> mainClass = (Property<String>) getMainClass.invoke(javaApplication);
|
|
||||||
return mainClass.getOrElse(null);
|
|
||||||
}
|
|
||||||
catch (Exception ex) {
|
|
||||||
// Continue
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return javaApplication.getMainClassName();
|
|
||||||
}
|
|
||||||
|
|
||||||
private static Method findMethod(Class<?> type, String name) {
|
|
||||||
for (Method candidate : type.getMethods()) {
|
|
||||||
if (candidate.getName().equals(name)) {
|
|
||||||
return candidate;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
private String resolveMainClass() {
|
|
||||||
return this.classpathSupplier.get().filter(File::isDirectory).getFiles().stream().map(this::findMainClass)
|
|
||||||
.filter(Objects::nonNull).findFirst().orElseThrow(() -> new InvalidUserDataException(
|
|
||||||
"Main class name has not been configured and it could not be resolved"));
|
|
||||||
}
|
|
||||||
|
|
||||||
private String findMainClass(File file) {
|
|
||||||
try {
|
|
||||||
return MainClassFinder.findSingleMainClass(file, SPRING_BOOT_APPLICATION_CLASS_NAME);
|
|
||||||
}
|
|
||||||
catch (IOException ex) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@ -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.springframework.boot.gradle.plugin;
|
|
||||||
|
|
||||||
import java.io.File;
|
|
||||||
import java.io.IOException;
|
|
||||||
|
|
||||||
import org.gradle.api.Project;
|
|
||||||
import org.gradle.api.plugins.ApplicationPlugin;
|
|
||||||
import org.gradle.api.plugins.JavaApplication;
|
|
||||||
import org.gradle.testfixtures.ProjectBuilder;
|
|
||||||
import org.junit.jupiter.api.BeforeEach;
|
|
||||||
import org.junit.jupiter.api.Test;
|
|
||||||
import org.junit.jupiter.api.io.TempDir;
|
|
||||||
|
|
||||||
import org.springframework.boot.gradle.dsl.SpringBootExtension;
|
|
||||||
|
|
||||||
import static org.assertj.core.api.Assertions.assertThat;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Integration tests for {@link MainClassConvention}.
|
|
||||||
*
|
|
||||||
* @author Andy Wilkinson
|
|
||||||
*/
|
|
||||||
class MainClassConventionTests {
|
|
||||||
|
|
||||||
@TempDir
|
|
||||||
File temp;
|
|
||||||
|
|
||||||
private Project project;
|
|
||||||
|
|
||||||
private MainClassConvention convention;
|
|
||||||
|
|
||||||
@BeforeEach
|
|
||||||
void createConvention() throws IOException {
|
|
||||||
this.project = ProjectBuilder.builder().withProjectDir(this.temp).build();
|
|
||||||
this.convention = new MainClassConvention(this.project, () -> null);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
|
||||||
void javaApplicationExtensionMainClassNameIsUsed() throws Exception {
|
|
||||||
this.project.getPlugins().apply(ApplicationPlugin.class);
|
|
||||||
JavaApplication extension = this.project.getExtensions().findByType(JavaApplication.class);
|
|
||||||
extension.getMainClass().set("com.example.MainClass");
|
|
||||||
assertThat(this.convention.call()).isEqualTo("com.example.MainClass");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
|
||||||
void springBootExtensionMainClassNameIsUsed() throws Exception {
|
|
||||||
SpringBootExtension extension = this.project.getExtensions().create("springBoot", SpringBootExtension.class,
|
|
||||||
this.project);
|
|
||||||
extension.getMainClass().set("com.example.MainClass");
|
|
||||||
assertThat(this.convention.call()).isEqualTo("com.example.MainClass");
|
|
||||||
}
|
|
||||||
|
|
||||||
@Test
|
|
||||||
void springBootExtensionMainClassNameIsUsedInPreferenceToJavaApplicationExtensionMainClassName() throws Exception {
|
|
||||||
this.project.getPlugins().apply(ApplicationPlugin.class);
|
|
||||||
JavaApplication javaApplication = this.project.getExtensions().findByType(JavaApplication.class);
|
|
||||||
javaApplication.getMainClass().set("com.example.JavaApplicationMainClass");
|
|
||||||
SpringBootExtension extension = this.project.getExtensions().create("springBoot", SpringBootExtension.class,
|
|
||||||
this.project);
|
|
||||||
extension.getMainClass().set("com.example.SpringBootExtensionMainClass");
|
|
||||||
assertThat(this.convention.call()).isEqualTo("com.example.SpringBootExtensionMainClass");
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
plugins {
|
||||||
|
id 'java'
|
||||||
|
id 'application'
|
||||||
|
id 'org.springframework.boot' version '{version}'
|
||||||
|
}
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
plugins {
|
||||||
|
id 'war'
|
||||||
|
id 'application'
|
||||||
|
id 'org.springframework.boot' version '{version}'
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue