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

Log and skip resource hint registration for classpath location patterns

Browse Source 
Since we do not yet have support for registering resource hints for
classpath location patterns, we have decided to explicitly skip such
resources and log a warning to inform users that they need to manually
supply resource hints for the exact resources needed by their
application.

This commit applies this change for @⁠PropertySource and
@⁠TestPropertySource.

See gh-31162
Closes gh-31429
This commit is contained in:
Sam Brannen
2023-10-25 12:25:46 +02:00
parent 9a7f141867
commit d7e6b79336
4 changed files with 200 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java
View File

@@ -91,6 +91,7 @@ import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.io.support.PropertySourceDescriptor;
import org.springframework.core.io.support.PropertySourceProcessor;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.metrics.ApplicationStartup;
import org.springframework.core.metrics.StartupStep;
import org.springframework.core.type.AnnotationMetadata;
@@ -655,6 +656,8 @@ public class ConfigurationClassPostProcessor implements BeanDefinitionRegistryPo
private static final String RESOURCE_LOADER_VARIABLE = "resourceLoader";
private final Log logger = LogFactory.getLog(getClass());
private final List<PropertySourceDescriptor> descriptors;
private final Function<String, Resource> resourceResolver;
@@ -679,9 +682,23 @@ public class ConfigurationClassPostProcessor implements BeanDefinitionRegistryPo
hints.reflection().registerType(factoryClass, MemberCategory.INVOKE_DECLARED_CONSTRUCTORS);
}
for (String location : descriptor.locations()) {
Resource resource = this.resourceResolver.apply(location);
if (resource instanceof ClassPathResource classPathResource && classPathResource.exists()) {
hints.resources().registerPattern(classPathResource.getPath());
if (location.startsWith(ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX) ||
(location.startsWith(ResourcePatternResolver.CLASSPATH_URL_PREFIX) &&
(location.contains("*") || location.contains("?")))) {
if (logger.isWarnEnabled()) {
logger.warn("""
Runtime hint registration is not supported for the 'classpath*:' \
prefix or wildcards in @PropertySource locations. Please manually \
register a resource hint for each property source location represented \
by '%s'.""".formatted(location));
}
}
else {
Resource resource = this.resourceResolver.apply(location);
if (resource instanceof ClassPathResource classPathResource && classPathResource.exists()) {
hints.resources().registerPattern(classPathResource.getPath());
}
}
}
}