Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify usage of FilePatternResourceHintsRegistrar

Browse Source 
This commit review the API using a builder to make it more clear what
the registrar does.

Closes gh-29161
This commit is contained in:
Stephane Nicoll
2023-08-18 15:35:03 +02:00
parent e6565c600a
commit 47b1a2bc55
2 changed files with 166 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
spring-core/src/main/java/org/springframework/aot/hint/support/FilePatternResourceHintsRegistrar.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 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.
@@ -17,6 +17,7 @@
package org.springframework.aot.hint.support;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.aot.hint.ResourceHints;
@@ -25,10 +26,12 @@ import org.springframework.util.Assert;
import org.springframework.util.ResourceUtils;
/**
* Register the necessary resource hints for loading files from the classpath.
* Register the necessary resource hints for loading files from the classpath,
* based on a file name prefix and an extension with convenience to support
* multiple classpath locations.
*
* <p>Candidates are identified by a file name, a location, and an extension.
* The location can be the empty string to refer to the root of the classpath.
* <p>Only register hints for matching classpath locations, which allows for
* several locations to be provided without contributing unnecessary hints.
*
* @author Stephane Nicoll
* @since 6.0
@@ -47,51 +50,28 @@ public class FilePatternResourceHintsRegistrar {
* @param names the file names
* @param locations the classpath locations
* @param extensions the file extensions (starts with a dot)
* @deprecated as of 6.0.12 in favor of {@link #forClassPathLocations(String...) the builder}
*/
@Deprecated(since = "6.0.12", forRemoval = true)
public FilePatternResourceHintsRegistrar(List<String> names, List<String> locations,
List<String> extensions) {
this.names = validateNames(names);
this.locations = validateLocations(locations);
this.extensions = validateExtensions(extensions);
this.names = Builder.validateFilePrefixes(names.toArray(String[]::new));
this.locations = Builder.validateClasspathLocations(locations.toArray(String[]::new));
this.extensions = Builder.validateFileExtensions(extensions.toArray(String[]::new));
}
private static List<String> validateNames(List<String> names) {
for (String name : names) {
if (name.contains("*")) {
throw new IllegalArgumentException("File name '" + name + "' cannot contain '*'");
}
}
return names;
}
private static List<String> validateLocations(List<String> locations) {
Assert.notEmpty(locations, "At least one location should be specified");
List<String> parsedLocations = new ArrayList<>();
for (String location : locations) {
if (location.startsWith(ResourceUtils.CLASSPATH_URL_PREFIX)) {
location = location.substring(ResourceUtils.CLASSPATH_URL_PREFIX.length());
}
if (location.startsWith("/")) {
location = location.substring(1);
}
if (!location.isEmpty() && !location.endsWith("/")) {
location = location + "/";
}
parsedLocations.add(location);
}
return parsedLocations;
}
private static List<String> validateExtensions(List<String> extensions) {
for (String extension : extensions) {
if (!extension.startsWith(".")) {
throw new IllegalArgumentException("Extension '" + extension + "' should start with '.'");
}
}
return extensions;
/**
* Configure the registrar with the specified
* {@linkplain Builder#withClasspathLocations(String...) classpath locations}.
* @param locations the classpath locations
* @return a {@link Builder} to further configure the registrar
*/
public static Builder forClassPathLocations(String... locations) {
Assert.notEmpty(locations, "At least one classpath location should be specified");
return new Builder().withClasspathLocations(locations);
}
@Deprecated(since = "6.0.12", forRemoval = true)
public void registerHints(ResourceHints hints, @Nullable ClassLoader classLoader) {
ClassLoader classLoaderToUse = (classLoader != null) ? classLoader : getClass().getClassLoader();
List<String> includes = new ArrayList<>();
@@ -108,4 +88,106 @@ public class FilePatternResourceHintsRegistrar {
hints.registerPattern(hint -> hint.includes(includes.toArray(String[]::new)));
}
}
/**
* Builder for {@link FilePatternResourceHintsRegistrar}.
*/
public static final class Builder {
private final List<String> classpathLocations = new ArrayList<>();
private final List<String> filePrefixes = new ArrayList<>();
private final List<String> fileExtensions = new ArrayList<>();
/**
* Consider the specified classpath locations. A location can either be
* a special "classpath" pseudo location or a standard location, such as
* {@code com/example/resources}. An empty String represents the root of
* the classpath.
* @param classpathLocations the classpath locations to consider
* @return this builder
*/
public Builder withClasspathLocations(String... classpathLocations) {
this.classpathLocations.addAll(validateClasspathLocations(classpathLocations));
return this;
}
/**
* Consider the specified file prefixes. Any file whose name starts with one
* of the specified prefix is considered. A prefix cannot contain the {@code *}
* character.
* @param filePrefixes the file prefixes to consider
* @return this builder
*/
public Builder withFilePrefixes(String... filePrefixes) {
this.filePrefixes.addAll(validateFilePrefixes(filePrefixes));
return this;
}
/**
* Consider the specified file extensions. A file extension must starts with a
* {@code .} character..
* @param fileExtensions the file extensions to consider
* @return this builder
*/
public Builder withFileExtensions(String... fileExtensions) {
this.fileExtensions.addAll(validateFileExtensions(fileExtensions));
return this;
}
FilePatternResourceHintsRegistrar build() {
Assert.notEmpty(this.classpathLocations, "At least one location should be specified");
return new FilePatternResourceHintsRegistrar(this.filePrefixes,
this.classpathLocations, this.fileExtensions);
}
/**
* Register resource hints for the current state of this builder. For each
* classpath location that resolves against the {@code ClassLoader}, file
* starting with the configured file prefixes and extensions are registered.
* @param hints the hints contributed so far for the deployment unit
* @param classLoader the classloader, or {@code null} if even the system ClassLoader isn't accessible
*/
public void registerHints(ResourceHints hints, @Nullable ClassLoader classLoader) {
build().registerHints(hints, classLoader);
}
private static List<String> validateClasspathLocations(String... locations) {
List<String> parsedLocations = new ArrayList<>();
for (String location : locations) {
if (location.startsWith(ResourceUtils.CLASSPATH_URL_PREFIX)) {
location = location.substring(ResourceUtils.CLASSPATH_URL_PREFIX.length());
}
if (location.startsWith("/")) {
location = location.substring(1);
}
if (!location.isEmpty() && !location.endsWith("/")) {
location = location + "/";
}
parsedLocations.add(location);
}
return parsedLocations;
}
private static List<String> validateFilePrefixes(String... fileNames) {
for (String name : fileNames) {
if (name.contains("*")) {
throw new IllegalArgumentException("File prefix '" + name + "' cannot contain '*'");
}
}
return Arrays.asList(fileNames);
}
private static List<String> validateFileExtensions(String... fileExtensions) {
for (String fileExtension : fileExtensions) {
if (!fileExtension.startsWith(".")) {
throw new IllegalArgumentException("Extension '" + fileExtension + "' should start with '.'");
}
}
return Arrays.asList(fileExtensions);
}
}
}