Use Class.forName rather than ClassLoader.loadClass

snicoll · snicoll · commit 95be41952714 · 2020-01-23T10:47:53.000+01:00
This commit changes uses of ClassLoader.loadClass to Class.forName for consistency with what was initiated in #19342 and better compatibility with GraalVM. Closes gh-19824
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -242,7 +242,7 @@ void checkAvailableImplementations() {
 
 		private void addCandidateIfAvailable(List<Class<?>> candidates, String type) {
 			try {
-				Class<?> candidate = this.classLoader.loadClass(type);
+				Class<?> candidate = Class.forName(type, false, this.classLoader);
 				if (candidate != null) {
 					candidates.add(candidate);
 				}
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJavaTests.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJavaTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -104,7 +104,7 @@ void java8IsTheFallback() throws Exception {
 
 	private String getJavaVersion(Class<?>... hiddenClasses) throws Exception {
 		FilteredClassLoader classLoader = new FilteredClassLoader(hiddenClasses);
-		Class<?> javaVersionClass = classLoader.loadClass(JavaVersion.class.getName());
+		Class<?> javaVersionClass = Class.forName(JavaVersion.class.getName(), false, classLoader);
 		Method getJavaVersionMethod = ReflectionUtils.findMethod(javaVersionClass, "getJavaVersion");
 		Object javaVersion = ReflectionUtils.invokeMethod(getJavaVersionMethod, null);
 		classLoader.close();
diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/app/SpringApplicationLauncher.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/app/SpringApplicationLauncher.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -59,7 +59,7 @@ public SpringApplicationLauncher(ClassLoader classLoader) {
 	public Object launch(Class<?>[] sources, String[] args) throws Exception {
 		Map<String, Object> defaultProperties = new HashMap<>();
 		defaultProperties.put("spring.groovy.template.check-template-location", "false");
-		Class<?> applicationClass = this.classLoader.loadClass(getSpringApplicationClassName());
+		Class<?> applicationClass = Class.forName(getSpringApplicationClassName(), false, this.classLoader);
 		Constructor<?> constructor = applicationClass.getDeclaredConstructor(Class[].class);
 		constructor.setAccessible(true);
 		Object application = constructor.newInstance((Object) sources);
diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/app/SpringApplicationWebApplicationInitializer.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/app/SpringApplicationWebApplicationInitializer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -72,7 +72,7 @@ protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
 			ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
 			Class<?>[] sourceClasses = new Class<?>[this.sources.length];
 			for (int i = 0; i < this.sources.length; i++) {
-				sourceClasses[i] = classLoader.loadClass(this.sources[i]);
+				sourceClasses[i] = Class.forName(this.sources[i], false, classLoader);
 			}
 			return builder.sources(sourceClasses).properties("spring.groovy.template.check-template-location=false");
 		}
diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/archive/PackagedSpringApplicationLauncher.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/archive/PackagedSpringApplicationLauncher.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -73,7 +73,7 @@ private boolean isCliPackaged(Manifest manifest) {
 	private Class<?>[] loadClasses(ClassLoader classLoader, String[] names) throws ClassNotFoundException {
 		Class<?>[] classes = new Class<?>[names.length];
 		for (int i = 0; i < names.length; i++) {
-			classes[i] = classLoader.loadClass(names[i]);
+			classes[i] = Class.forName(names[i], false, classLoader);
 		}
 		return classes;
 	}
diff --git a/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/ExtendedGroovyClassLoader.java b/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/ExtendedGroovyClassLoader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -238,7 +238,7 @@ public Enumeration<URL> getResources(String name) throws IOException {
 		@Override
 		protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
 			if (!name.startsWith("java.")) {
-				this.groovyOnlyClassLoader.loadClass(name);
+				Class.forName(name, false, this.groovyOnlyClassLoader);
 			}
 			return super.loadClass(name, resolve);
 		}
diff --git a/spring-boot-project/spring-boot-cli/src/test/java/org/springframework/boot/cli/compiler/ExtendedGroovyClassLoaderTests.java b/spring-boot-project/spring-boot-cli/src/test/java/org/springframework/boot/cli/compiler/ExtendedGroovyClassLoaderTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -35,27 +35,27 @@ class ExtendedGroovyClassLoaderTests {
 
 	@Test
 	void loadsGroovyFromSameClassLoader() throws Exception {
-		Class<?> c1 = this.contextClassLoader.loadClass("groovy.lang.Script");
-		Class<?> c2 = this.defaultScopeGroovyClassLoader.loadClass("groovy.lang.Script");
+		Class<?> c1 = Class.forName("groovy.lang.Script", false, this.contextClassLoader);
+		Class<?> c2 = Class.forName("groovy.lang.Script", false, this.defaultScopeGroovyClassLoader);
 		assertThat(c1.getClassLoader()).isSameAs(c2.getClassLoader());
 	}
 
 	@Test
 	void filtersNonGroovy() throws Exception {
-		this.contextClassLoader.loadClass("org.springframework.util.StringUtils");
-		assertThatExceptionOfType(ClassNotFoundException.class)
-				.isThrownBy(() -> this.defaultScopeGroovyClassLoader.loadClass("org.springframework.util.StringUtils"));
+		Class.forName("org.springframework.util.StringUtils", false, this.contextClassLoader);
+		assertThatExceptionOfType(ClassNotFoundException.class).isThrownBy(
+				() -> Class.forName("org.springframework.util.StringUtils", false, this.defaultScopeGroovyClassLoader));
 	}
 
 	@Test
 	void loadsJavaTypes() throws Exception {
-		this.defaultScopeGroovyClassLoader.loadClass("java.lang.Boolean");
+		Class.forName("java.lang.Boolean", false, this.defaultScopeGroovyClassLoader);
 	}
 
 	@Test
 	void loadsSqlTypes() throws Exception {
-		this.contextClassLoader.loadClass("java.sql.SQLException");
-		this.defaultScopeGroovyClassLoader.loadClass("java.sql.SQLException");
+		Class.forName("java.sql.SQLException", false, this.contextClassLoader);
+		Class.forName("java.sql.SQLException", false, this.defaultScopeGroovyClassLoader);
 	}
 
 }
diff --git a/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/classloader/RestartClassLoaderTests.java b/spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/restart/classloader/RestartClassLoaderTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -125,13 +125,13 @@ void getResourcesFiltersDuplicates() throws Exception {
 
 	@Test
 	void loadClassFromReloadableUrl() throws Exception {
-		Class<?> loaded = this.reloadClassLoader.loadClass(PACKAGE + ".Sample");
+		Class<?> loaded = Class.forName(PACKAGE + ".Sample", false, this.reloadClassLoader);
 		assertThat(loaded.getClassLoader()).isEqualTo(this.reloadClassLoader);
 	}
 
 	@Test
 	void loadClassFromParent() throws Exception {
-		Class<?> loaded = this.reloadClassLoader.loadClass(PACKAGE + ".SampleParent");
+		Class<?> loaded = Class.forName(PACKAGE + ".SampleParent", false, this.reloadClassLoader);
 		assertThat(loaded.getClassLoader()).isEqualTo(getClass().getClassLoader());
 	}
 
@@ -180,23 +180,23 @@ void getDeletedClass() throws Exception {
 		String name = PACKAGE_PATH + "/Sample.class";
 		this.updatedFiles.addFile(name, new ClassLoaderFile(Kind.DELETED, null));
 		assertThatExceptionOfType(ClassNotFoundException.class)
-				.isThrownBy(() -> this.reloadClassLoader.loadClass(PACKAGE + ".Sample"));
+				.isThrownBy(() -> Class.forName(PACKAGE + ".Sample", false, this.reloadClassLoader));
 	}
 
 	@Test
 	void getUpdatedClass() throws Exception {
 		String name = PACKAGE_PATH + "/Sample.class";
 		this.updatedFiles.addFile(name, new ClassLoaderFile(Kind.MODIFIED, new byte[10]));
 		assertThatExceptionOfType(ClassFormatError.class)
-				.isThrownBy(() -> this.reloadClassLoader.loadClass(PACKAGE + ".Sample"));
+				.isThrownBy(() -> Class.forName(PACKAGE + ".Sample", false, this.reloadClassLoader));
 	}
 
 	@Test
 	void getAddedClass() throws Exception {
 		String name = PACKAGE_PATH + "/SampleParent.class";
 		byte[] bytes = FileCopyUtils.copyToByteArray(getClass().getResourceAsStream("SampleParent.class"));
 		this.updatedFiles.addFile(name, new ClassLoaderFile(Kind.ADDED, bytes));
-		Class<?> loaded = this.reloadClassLoader.loadClass(PACKAGE + ".SampleParent");
+		Class<?> loaded = Class.forName(PACKAGE + ".SampleParent", false, this.reloadClassLoader);
 		assertThat(loaded.getClassLoader()).isEqualTo(this.reloadClassLoader);
 	}
 
diff --git a/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/FilteredClassLoaderTests.java b/spring-boot-project/spring-boot-test/src/test/java/org/springframework/boot/test/context/FilteredClassLoaderTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -43,22 +43,22 @@ void loadClassWhenFilteredOnPackageShouldThrowClassNotFound() throws Exception {
 		try (FilteredClassLoader classLoader = new FilteredClassLoader(
 				FilteredClassLoaderTests.class.getPackage().getName())) {
 			assertThatExceptionOfType(ClassNotFoundException.class)
-					.isThrownBy(() -> classLoader.loadClass(getClass().getName()));
+					.isThrownBy(() -> Class.forName(getClass().getName(), false, classLoader));
 		}
 	}
 
 	@Test
 	void loadClassWhenFilteredOnClassShouldThrowClassNotFound() throws Exception {
 		try (FilteredClassLoader classLoader = new FilteredClassLoader(FilteredClassLoaderTests.class)) {
 			assertThatExceptionOfType(ClassNotFoundException.class)
-					.isThrownBy(() -> classLoader.loadClass(getClass().getName()));
+					.isThrownBy(() -> Class.forName(getClass().getName(), false, classLoader));
 		}
 	}
 
 	@Test
 	void loadClassWhenNotFilteredShouldLoadClass() throws Exception {
 		FilteredClassLoader classLoader = new FilteredClassLoader((className) -> false);
-		Class<?> loaded = classLoader.loadClass(getClass().getName());
+		Class<?> loaded = Class.forName(getClass().getName(), false, classLoader);
 		assertThat(loaded.getName()).isEqualTo(getClass().getName());
 		classLoader.close();
 	}
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/fieldvalues/javac/ReflectionWrapper.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/fieldvalues/javac/ReflectionWrapper.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -54,7 +54,7 @@ protected Method findMethod(String name, Class<?>... parameterTypes) {
 
 	protected static Class<?> findClass(ClassLoader classLoader, String name) {
 		try {
-			return classLoader.loadClass(name);
+			return Class.forName(name, false, classLoader);
 		}
 		catch (ClassNotFoundException ex) {
 			throw new IllegalStateException(ex);
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-exclude/src/main/java/org/test/SampleApplication.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/run-exclude/src/main/java/org/test/SampleApplication.java
@@ -32,7 +32,7 @@ private static boolean isClassPresent(String className) {
 
 		try {
 			ClassLoader classLoader = SampleApplication.class.getClassLoader();
-			classLoader.loadClass(className);
+			Class.forName(className, false, classLoader);
 			return true;
 		}
 		catch (ClassNotFoundException e) {
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java
@@ -559,7 +559,7 @@ public void run() {
 			Thread thread = Thread.currentThread();
 			ClassLoader classLoader = thread.getContextClassLoader();
 			try {
-				Class<?> startClass = classLoader.loadClass(this.startClassName);
+				Class<?> startClass = Class.forName(this.startClassName, false, classLoader);
 				Method mainMethod = startClass.getMethod("main", String[].class);
 				if (!mainMethod.isAccessible()) {
 					mainMethod.setAccessible(true);
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/classpath/ModifiedClassPathExtension.java b/spring-boot-project/spring-boot-tools/spring-boot-test-support/src/main/java/org/springframework/boot/testsupport/classpath/ModifiedClassPathExtension.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * 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.
@@ -96,7 +96,7 @@ private void runTestWithModifiedClassPath(ReflectiveInvocationContext<Method> in
 	}
 
 	private void runTest(ClassLoader classLoader, String testClassName, String testMethodName) throws Throwable {
-		Class<?> testClass = classLoader.loadClass(testClassName);
+		Class<?> testClass = Class.forName(testClassName, false, classLoader);
 		Method testMethod = findMethod(testClass, testMethodName);
 		LauncherDiscoveryRequest request = new LauncherDiscoveryRequestBuilder(classLoader)
 				.selectors(DiscoverySelectors.selectMethod(testClass, testMethod)).build();

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2019 the original author or authors.`
	`2`	`+ * Copyright 2012-2020 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -242,7 +242,7 @@ void checkAvailableImplementations() {`
`242`	`242`
`243`	`243`	`private void addCandidateIfAvailable(List<Class<?>> candidates, String type) {`
`244`	`244`	`try {`
`245`		`- Class<?> candidate = this.classLoader.loadClass(type);`
	`245`	`+ Class<?> candidate = Class.forName(type, false, this.classLoader);`
`246`	`246`	`if (candidate != null) {`
`247`	`247`	`candidates.add(candidate);`
`248`	`248`	`}`