Polish 'Refactor ApplicationResourceLoader preferFileResolution support'

See gh-44535

Author: philwebb

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/io/ApplicationResourceLoader.java

@@ -131,7 +131,7 @@ public static ResourceLoader get(ResourceLoader resourceLoader) {
 	 * class loader at the time this call is made.
 	 * @param resourceLoader the delegate resource loader
 	 * @param preferFileResolution if file based resolution is preferred when a suitable
-	 * {@link ResourceFilePathResolver} support the resource
+	 * {@link FilePathResolver} support the resource
 	 * @return a {@link ResourceLoader} instance
 	 * @since 3.4.1
 	 */
@@ -160,8 +160,8 @@ private static ResourceLoader get(ResourceLoader resourceLoader, SpringFactories
 		Assert.notNull(resourceLoader, "'resourceLoader' must not be null");
 		Assert.notNull(springFactoriesLoader, "'springFactoriesLoader' must not be null");
 		List<ProtocolResolver> protocolResolvers = springFactoriesLoader.load(ProtocolResolver.class);
-		List<ResourceFilePathResolver> filePathResolvers = (preferFileResolution)
-				? springFactoriesLoader.load(ResourceFilePathResolver.class) : Collections.emptyList();
+		List<FilePathResolver> filePathResolvers = (preferFileResolution)
+				? springFactoriesLoader.load(FilePathResolver.class) : Collections.emptyList();
 		return new ProtocolResolvingResourceLoader(resourceLoader, protocolResolvers, filePathResolvers);
 	}
 
@@ -188,6 +188,28 @@ static ResourceLoader get(ClassLoader classLoader) {
 
 	}
 
+	/**
+	 * Strategy interface registered in {@code spring.factories} and used by
+	 * {@link ApplicationResourceLoader} to determine the file path of loaded resource
+	 * when it can also be represented as a {@link FileSystemResource}.
+	 *
+	 * @author Phillip Webb
+	 * @since 3.4.5
+	 */
+	public interface FilePathResolver {
+
+		/**
+		 * Return the {@code path} of the given resource if it can also be represented as
+		 * a {@link FileSystemResource}.
+		 * @param location the location used to create the resource
+		 * @param resource the resource to check
+		 * @return the file path of the resource or {@code null} if the it is not possible
+		 * to represent the resource as a {@link FileSystemResource}.
+		 */
+		String resolveFilePath(String location, Resource resource);
+
+	}
+
 	/**
 	 * An application {@link Resource}.
 	 */
@@ -214,10 +236,10 @@ private static class ProtocolResolvingResourceLoader implements ResourceLoader {
 
 		private final List<ProtocolResolver> protocolResolvers;
 
-		private final List<ResourceFilePathResolver> filePathResolvers;
+		private final List<FilePathResolver> filePathResolvers;
 
 		ProtocolResolvingResourceLoader(ResourceLoader resourceLoader, List<ProtocolResolver> protocolResolvers,
-				List<ResourceFilePathResolver> filePathResolvers) {
+				List<FilePathResolver> filePathResolvers) {
 			this.resourceLoader = resourceLoader;
 			this.protocolResolvers = protocolResolvers;
 			this.filePathResolvers = filePathResolvers;
@@ -239,12 +261,12 @@ public Resource getResource(String location) {
 				}
 			}
 			Resource resource = this.resourceLoader.getResource(location);
-			String fileSystemPath = getFileSystemPath(location, resource);
-			return (fileSystemPath != null) ? new ApplicationResource(fileSystemPath) : resource;
+			String filePath = getFilePath(location, resource);
+			return (filePath != null) ? new ApplicationResource(filePath) : resource;
 		}
 
-		private String getFileSystemPath(String location, Resource resource) {
-			for (ResourceFilePathResolver filePathResolver : this.filePathResolvers) {
+		private String getFilePath(String location, Resource resource) {
+			for (FilePathResolver filePathResolver : this.filePathResolvers) {
 				String filePath = filePathResolver.resolveFilePath(location, resource);
 				if (filePath != null) {
 					return filePath;

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/io/ClassPathResourceFilePathResolver.java

@@ -16,16 +16,17 @@
 
 package org.springframework.boot.io;
 
+import org.springframework.boot.io.ApplicationResourceLoader.FilePathResolver;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 
 /**
- * {@link ResourceFilePathResolver} for {@link ClassPathResource}.
+ * {@link FilePathResolver} for {@link ClassPathResource}.
  *
  * @author Phillip Webb
  */
-class ClassPathResourceFilePathResolver implements ResourceFilePathResolver {
+class ClassPathResourceFilePathResolver implements ApplicationResourceLoader.FilePathResolver {
 
 	@Override
 	public String resolveFilePath(String location, Resource resource) {

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/io/ResourceFilePathResolver.java

@@ -16,17 +16,18 @@
 
 package org.springframework.boot.web.context;
 
-import org.springframework.boot.io.ResourceFilePathResolver;
+import org.springframework.boot.io.ApplicationResourceLoader;
+import org.springframework.boot.io.ApplicationResourceLoader.FilePathResolver;
 import org.springframework.core.io.Resource;
 import org.springframework.util.ClassUtils;
 import org.springframework.web.context.support.ServletContextResource;
 
 /**
- * {@link ResourceFilePathResolver} for {@link ServletContextResource}.
+ * {@link FilePathResolver} for {@link ServletContextResource}.
  *
  * @author Phillip Webb
  */
-class ServletContextResourceFilePathResolver implements ResourceFilePathResolver {
+class ServletContextResourceFilePathResolver implements ApplicationResourceLoader.FilePathResolver {
 
 	private static final String RESOURCE_CLASS_NAME = "org.springframework.web.context.support.ServletContextResource";
 

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/context/ServletContextResourceFilePathResolver.java

@@ -16,15 +16,16 @@
 
 package org.springframework.boot.web.reactive.context;
 
-import org.springframework.boot.io.ResourceFilePathResolver;
+import org.springframework.boot.io.ApplicationResourceLoader;
+import org.springframework.boot.io.ApplicationResourceLoader.FilePathResolver;
 import org.springframework.core.io.Resource;
 
 /**
- * {@link ResourceFilePathResolver} for {@link FilteredReactiveWebContextResource}.
+ * {@link FilePathResolver} for {@link FilteredReactiveWebContextResource}.
  *
  * @author Dmytro Nosan
  */
-class FilteredReactiveWebContextResourceFilePathResolver implements ResourceFilePathResolver {
+class FilteredReactiveWebContextResourceFilePathResolver implements ApplicationResourceLoader.FilePathResolver {
 
 	@Override
 	public String resolveFilePath(String location, Resource resource) {

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/reactive/context/FilteredReactiveWebContextResourceFilePathResolver.java

@@ -107,7 +107,7 @@ org.springframework.core.io.ProtocolResolver=\
 org.springframework.boot.io.Base64ProtocolResolver
 
 # Resource File Path Resolvers
-org.springframework.boot.io.ResourceFilePathResolver=\
+org.springframework.boot.io.ApplicationResourceLoader$FilePathResolver=\
 org.springframework.boot.io.ClassPathResourceFilePathResolver,\
 org.springframework.boot.web.context.ServletContextResourceFilePathResolver,\
 org.springframework.boot.web.reactive.context.FilteredReactiveWebContextResourceFilePathResolver