类 PathMatchingResourcePatternResolver
- java.lang.Object
- org.springframework.core.io.support.PathMatchingResourcePatternResolver
- 所有已实现的接口:
ResourceLoader
,ResourcePatternResolver
public class PathMatchingResourcePatternResolver extends Object implements ResourcePatternResolver
AResourcePatternResolver
implementation that is able to resolve a specified resource location path into one or more matching Resources. The source path may be a simple path which has a one-to-one mapping to a targetResource
, or alternatively may contain the special "classpath*:
" prefix and/or internal Ant-style regular expressions (matched using Spring'sAntPathMatcher
utility). Both of the latter are effectively wildcards.No Wildcards:
In the simple case, if the specified location path does not start with the
"classpath*:
" prefix, and does not contain a PathMatcher pattern, this resolver will simply return a single resource via agetResource()
call on the underlyingResourceLoader
. Examples are real URLs such as "file:C:/context.xml
", pseudo-URLs such as "classpath:/context.xml
", and simple unprefixed paths such as "/WEB-INF/context.xml
". The latter will resolve in a fashion specific to the underlyingResourceLoader
(e.g.ServletContextResource
for aWebApplicationContext
).Ant-style Patterns:
When the path location contains an Ant-style pattern, e.g.:
/WEB-INF/*-context.xml com/mycompany/**/applicationContext.xml file:C:/some/path/*-context.xml classpath:com/mycompany/**/applicationContext.xml
the resolver follows a more complex but defined procedure to try to resolve the wildcard. It produces aResource
for the path up to the last non-wildcard segment and obtains aURL
from it. If this URL is not a "jar:
" URL or container-specific variant (e.g. "zip:
" in WebLogic, "wsjar
" in WebSphere", etc.), then ajava.io.File
is obtained from it, and used to resolve the wildcard by walking the filesystem. In the case of a jar URL, the resolver either gets ajava.net.JarURLConnection
from it, or manually parses the jar URL, and then traverses the contents of the jar file, to resolve the wildcards.Implications on portability:
If the specified path is already a file URL (either explicitly, or implicitly because the base
ResourceLoader
is a filesystem one, then wildcarding is guaranteed to work in a completely portable fashion.If the specified path is a classpath location, then the resolver must obtain the last non-wildcard path segment URL via a
Classloader.getResource()
call. Since this is just a node of the path (not the file at the end) it is actually undefined (in the ClassLoader Javadocs) exactly what sort of a URL is returned in this case. In practice, it is usually ajava.io.File
representing the directory, where the classpath resource resolves to a filesystem location, or a jar URL of some sort, where the classpath resource resolves to a jar location. Still, there is a portability concern on this operation.If a jar URL is obtained for the last non-wildcard segment, the resolver must be able to get a
java.net.JarURLConnection
from it, or manually parse the jar URL, to be able to walk the contents of the jar, and resolve the wildcard. This will work in most environments, but will fail in others, and it is strongly recommended that the wildcard resolution of resources coming from jars be thoroughly tested in your specific environment before you rely on it.classpath*:
Prefix:There is special support for retrieving multiple class path resources with the same name, via the "
classpath*:
" prefix. For example, "classpath*:META-INF/beans.xml
" will find all "beans.xml" files in the class path, be it in "classes" directories or in JAR files. This is particularly useful for autodetecting config files of the same name at the same location within each jar file. Internally, this happens via aClassLoader.getResources()
call, and is completely portable.The "classpath*:" prefix can also be combined with a PathMatcher pattern in the rest of the location path, for example "classpath*:META-INF/*-beans.xml". In this case, the resolution strategy is fairly simple: a
ClassLoader.getResources()
call is used on the last non-wildcard path segment to get all the matching resources in the class loader hierarchy, and then off each resource the same PathMatcher resolution strategy described above is used for the wildcard subpath.Other notes:
WARNING: Note that "
classpath*:
" when combined with Ant-style patterns will only work reliably with at least one root directory before the pattern starts, unless the actual target files reside in the file system. This means that a pattern like "classpath*:*.xml
" will not retrieve files from the root of jar files but rather only from the root of expanded directories. This originates from a limitation in the JDK'sClassLoader.getResources()
method which only returns file system locations for a passed-in empty String (indicating potential roots to search). ThisResourcePatternResolver
implementation is trying to mitigate the jar root lookup limitation throughURLClassLoader
introspection and "java.class.path" manifest evaluation; however, without portability guarantees.WARNING: Ant-style patterns with "classpath:" resources are not guaranteed to find matching resources if the root package to search is available in multiple class path locations. This is because a resource such as
com/mycompany/package1/service-context.xml
may be in only one location, but when a path such asclasspath:com/mycompany/**/service-context.xml
is used to try to resolve it, the resolver will work off the (first) URL returned bygetResource("com/mycompany");
. If this base package node exists in multiple classloader locations, the actual end resource may not be underneath. Therefore, preferably, use "classpath*:
" with the same Ant-style pattern in such a case, which will search all class path locations that contain the root package.- 从以下版本开始:
- 1.0.2
- 作者:
- Juergen Hoeller, Colin Sampaleanu, Marius Bogoevici, Costin Leau, Phillip Webb
- 另请参阅:
ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX
,AntPathMatcher
,ResourceLoader.getResource(String)
,ClassLoader.getResources(String)
字段概要
从接口继承的字段 org.springframework.core.io.ResourceLoader
CLASSPATH_URL_PREFIX
从接口继承的字段 org.springframework.core.io.support.ResourcePatternResolver
CLASSPATH_ALL_URL_PREFIX
构造器概要
构造器 构造器 说明 PathMatchingResourcePatternResolver()
Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.PathMatchingResourcePatternResolver(ClassLoader classLoader)
Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.PathMatchingResourcePatternResolver(ResourceLoader resourceLoader)
Create a new PathMatchingResourcePatternResolver.
方法概要
所有方法 实例方法 具体方法 已过时的方法 修饰符和类型 方法 说明 protected void
addAllClassLoaderJarRoots(ClassLoader classLoader, Set<Resource> result)
Search allURLClassLoader
URLs for jar file references and add them to the given set of resources in the form of pointers to the root of the jar file content.protected void
addClassPathManifestEntries(Set<Resource> result)
Determine jar file references from the "java.class.path." manifest property and add them to the given set of resources in the form of pointers to the root of the jar file content.protected Resource
convertClassLoaderURL(URL url)
Convert the given URL as returned from the ClassLoader into aResource
.protected String
determineRootDir(String location)
Determine the root directory for the given location.protected Set<Resource>
doFindAllClassPathResources(String path)
Find all class location resources with the given path via the ClassLoader.protected Set<Resource>
doFindMatchingFileSystemResources(File rootDir, String subPattern)
Find all resources in the file system that match the given location pattern via the Ant-style PathMatcher.protected Set<Resource>
doFindPathMatchingFileResources(Resource rootDirResource, String subPattern)
Find all resources in the file system that match the given location pattern via the Ant-style PathMatcher.protected Set<Resource>
doFindPathMatchingJarResources(Resource rootDirResource, String subPattern)
已过时。as of Spring 4.3, in favor ofdoFindPathMatchingJarResources(Resource, URL, String)
protected Set<Resource>
doFindPathMatchingJarResources(Resource rootDirResource, URL rootDirURL, String subPattern)
Find all resources in jar files that match the given location pattern via the Ant-style PathMatcher.protected void
doRetrieveMatchingFiles(String fullPattern, File dir, Set<File> result)
Recursively retrieve files that match the given pattern, adding them to the given result list.protected Resource[]
findAllClassPathResources(String location)
Find all class location resources with the given location via the ClassLoader.protected Resource[]
findPathMatchingResources(String locationPattern)
Find all resources that match the given location pattern via the Ant-style PathMatcher.ClassLoader
getClassLoader()
Expose the ClassLoader used by this ResourceLoader.protected JarFile
getJarFile(String jarFileUrl)
Resolve the given jar file URL into a JarFile object.PathMatcher
getPathMatcher()
Return the PathMatcher that this resource pattern resolver uses.Resource
getResource(String location)
Return a Resource handle for the specified resource location.ResourceLoader
getResourceLoader()
Return the ResourceLoader that this pattern resolver works with.Resource[]
getResources(String locationPattern)
Resolve the given location pattern into Resource objects.protected boolean
isJarResource(Resource resource)
Return whether the given resource handle indicates a jar resource that thedoFindPathMatchingJarResources
method can handle.protected Resource
resolveRootDirResource(Resource original)
Resolve the specified resource for path matching.protected Set<File>
retrieveMatchingFiles(File rootDir, String pattern)
Retrieve files that match the given path pattern, checking the given directory and its subdirectories.void
setPathMatcher(PathMatcher pathMatcher)
Set the PathMatcher implementation to use for this resource pattern resolver.
构造器详细资料
PathMatchingResourcePatternResolver
public PathMatchingResourcePatternResolver()
Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.ClassLoader access will happen via the thread context class loader.
PathMatchingResourcePatternResolver
public PathMatchingResourcePatternResolver(ResourceLoader resourceLoader)
Create a new PathMatchingResourcePatternResolver.ClassLoader access will happen via the thread context class loader.
- 参数:
resourceLoader
- the ResourceLoader to load root directories and actual resources with
PathMatchingResourcePatternResolver
public PathMatchingResourcePatternResolver(ClassLoader classLoader)
Create a new PathMatchingResourcePatternResolver with a DefaultResourceLoader.- 参数:
classLoader
- the ClassLoader to load classpath resources with, ornull
for using the thread context class loader at the time of actual resource access- 另请参阅:
DefaultResourceLoader
方法详细资料
getResourceLoader
public ResourceLoader getResourceLoader()
Return the ResourceLoader that this pattern resolver works with.
getClassLoader
public ClassLoader getClassLoader()
从接口复制的说明:ResourceLoader
Expose the ClassLoader used by this ResourceLoader.Clients which need to access the ClassLoader directly can do so in a uniform manner with the ResourceLoader, rather than relying on the thread context ClassLoader.
- 指定者:
getClassLoader
在接口中ResourceLoader
- 返回:
- the ClassLoader (only
null
if even the system ClassLoader isn't accessible) - 另请参阅:
ClassUtils.getDefaultClassLoader()
setPathMatcher
public void setPathMatcher(PathMatcher pathMatcher)
Set the PathMatcher implementation to use for this resource pattern resolver. Default is AntPathMatcher.- 另请参阅:
AntPathMatcher
getPathMatcher
public PathMatcher getPathMatcher()
Return the PathMatcher that this resource pattern resolver uses.
getResource
public Resource getResource(String location)
从接口复制的说明:ResourceLoader
Return a Resource handle for the specified resource location.The handle should always be a reusable resource descriptor, allowing for multiple
InputStreamSource.getInputStream()
calls.- Must support fully qualified URLs, e.g. "file:C:/test.dat".
- Must support classpath pseudo-URLs, e.g. "classpath:test.dat".
- Should support relative file paths, e.g. "WEB-INF/test.dat". (This will be implementation-specific, typically provided by an ApplicationContext implementation.)
Note that a Resource handle does not imply an existing resource; you need to invoke
Resource.exists()
to check for existence.- 指定者:
getResource
在接口中ResourceLoader
- 参数:
location
- the resource location- 返回:
- a corresponding Resource handle (never
null
) - 另请参阅:
ResourceLoader.CLASSPATH_URL_PREFIX
,Resource.exists()
,InputStreamSource.getInputStream()
getResources
public Resource[] getResources(String locationPattern) throws IOException
从接口复制的说明:ResourcePatternResolver
Resolve the given location pattern into Resource objects.Overlapping resource entries that point to the same physical resource should be avoided, as far as possible. The result should have set semantics.
- 指定者:
getResources
在接口中ResourcePatternResolver
- 参数:
locationPattern
- the location pattern to resolve- 返回:
- the corresponding Resource objects
- 抛出:
IOException
- in case of I/O errors
findAllClassPathResources
protected Resource[] findAllClassPathResources(String location) throws IOException
Find all class location resources with the given location via the ClassLoader. Delegates todoFindAllClassPathResources(String)
.- 参数:
location
- the absolute path within the classpath- 返回:
- the result as Resource array
- 抛出:
IOException
- in case of I/O errors- 另请参阅:
ClassLoader.getResources(java.lang.String)
,convertClassLoaderURL(java.net.URL)
doFindAllClassPathResources
protected Set<Resource> doFindAllClassPathResources(String path) throws IOException
Find all class location resources with the given path via the ClassLoader. Called byfindAllClassPathResources(String)
.- 参数:
path
- the absolute path within the classpath (never a leading slash)- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- 从以下版本开始:
- 4.1.1
convertClassLoaderURL
protected Resource convertClassLoaderURL(URL url)
Convert the given URL as returned from the ClassLoader into aResource
.The default implementation simply creates a
UrlResource
instance.- 参数:
url
- a URL as returned from the ClassLoader- 返回:
- the corresponding Resource object
- 另请参阅:
ClassLoader.getResources(java.lang.String)
,Resource
addAllClassLoaderJarRoots
protected void addAllClassLoaderJarRoots(ClassLoader classLoader, Set<Resource> result)
Search allURLClassLoader
URLs for jar file references and add them to the given set of resources in the form of pointers to the root of the jar file content.- 参数:
classLoader
- the ClassLoader to search (including its ancestors)result
- the set of resources to add jar roots to- 从以下版本开始:
- 4.1.1
addClassPathManifestEntries
protected void addClassPathManifestEntries(Set<Resource> result)
Determine jar file references from the "java.class.path." manifest property and add them to the given set of resources in the form of pointers to the root of the jar file content.- 参数:
result
- the set of resources to add jar roots to- 从以下版本开始:
- 4.3
findPathMatchingResources
protected Resource[] findPathMatchingResources(String locationPattern) throws IOException
Find all resources that match the given location pattern via the Ant-style PathMatcher. Supports resources in jar files and zip files and in the file system.- 参数:
locationPattern
- the location pattern to match- 返回:
- the result as Resource array
- 抛出:
IOException
- in case of I/O errors- 另请参阅:
doFindPathMatchingJarResources(org.springframework.core.io.Resource, java.net.URL, java.lang.String)
,doFindPathMatchingFileResources(org.springframework.core.io.Resource, java.lang.String)
,PathMatcher
determineRootDir
protected String determineRootDir(String location)
Determine the root directory for the given location.Used for determining the starting point for file matching, resolving the root directory location to a
java.io.File
and passing it intoretrieveMatchingFiles
, with the remainder of the location as pattern.Will return "/WEB-INF/" for the pattern "/WEB-INF/*.xml", for example.
- 参数:
location
- the location to check- 返回:
- the part of the location that denotes the root directory
- 另请参阅:
retrieveMatchingFiles(java.io.File, java.lang.String)
resolveRootDirResource
protected Resource resolveRootDirResource(Resource original) throws IOException
Resolve the specified resource for path matching.By default, Equinox OSGi "bundleresource:" / "bundleentry:" URL will be resolved into a standard jar file URL that be traversed using Spring's standard jar file traversal algorithm. For any preceding custom resolution, override this method and replace the resource handle accordingly.
- 参数:
original
- the resource to resolve- 返回:
- the resolved resource (may be identical to the passed-in resource)
- 抛出:
IOException
- in case of resolution failure
isJarResource
protected boolean isJarResource(Resource resource) throws IOException
Return whether the given resource handle indicates a jar resource that thedoFindPathMatchingJarResources
method can handle.By default, the URL protocols "jar", "zip", "vfszip and "wsjar" will be treated as jar resources. This template method allows for detecting further kinds of jar-like resources, e.g. through
instanceof
checks on the resource handle type.- 参数:
resource
- the resource handle to check (usually the root directory to start path matching from)- 抛出:
IOException
- 另请参阅:
doFindPathMatchingJarResources(org.springframework.core.io.Resource, java.net.URL, java.lang.String)
,ResourceUtils.isJarURL(java.net.URL)
doFindPathMatchingJarResources
protected Set<Resource> doFindPathMatchingJarResources(Resource rootDirResource, URL rootDirURL, String subPattern) throws IOException
Find all resources in jar files that match the given location pattern via the Ant-style PathMatcher.- 参数:
rootDirResource
- the root directory as ResourcerootDirURL
- the pre-resolved root directory URLsubPattern
- the sub pattern to match (below the root directory)- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- in case of I/O errors- 从以下版本开始:
- 4.3
- 另请参阅:
JarURLConnection
,PathMatcher
doFindPathMatchingJarResources
@Deprecated protected Set<Resource> doFindPathMatchingJarResources(Resource rootDirResource, String subPattern) throws IOException
已过时。as of Spring 4.3, in favor ofdoFindPathMatchingJarResources(Resource, URL, String)
Find all resources in jar files that match the given location pattern via the Ant-style PathMatcher.- 参数:
rootDirResource
- the root directory as ResourcesubPattern
- the sub pattern to match (below the root directory)- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- in case of I/O errors
getJarFile
protected JarFile getJarFile(String jarFileUrl) throws IOException
Resolve the given jar file URL into a JarFile object.- 抛出:
IOException
doFindPathMatchingFileResources
protected Set<Resource> doFindPathMatchingFileResources(Resource rootDirResource, String subPattern) throws IOException
Find all resources in the file system that match the given location pattern via the Ant-style PathMatcher.- 参数:
rootDirResource
- the root directory as ResourcesubPattern
- the sub pattern to match (below the root directory)- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- in case of I/O errors- 另请参阅:
retrieveMatchingFiles(java.io.File, java.lang.String)
,PathMatcher
doFindMatchingFileSystemResources
protected Set<Resource> doFindMatchingFileSystemResources(File rootDir, String subPattern) throws IOException
Find all resources in the file system that match the given location pattern via the Ant-style PathMatcher.- 参数:
rootDir
- the root directory in the file systemsubPattern
- the sub pattern to match (below the root directory)- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- in case of I/O errors- 另请参阅:
retrieveMatchingFiles(java.io.File, java.lang.String)
,PathMatcher
retrieveMatchingFiles
protected Set<File> retrieveMatchingFiles(File rootDir, String pattern) throws IOException
Retrieve files that match the given path pattern, checking the given directory and its subdirectories.- 参数:
rootDir
- the directory to start frompattern
- the pattern to match against, relative to the root directory- 返回:
- a mutable Set of matching Resource instances
- 抛出:
IOException
- if directory contents could not be retrieved
doRetrieveMatchingFiles
protected void doRetrieveMatchingFiles(String fullPattern, File dir, Set<File> result) throws IOException
Recursively retrieve files that match the given pattern, adding them to the given result list.- 参数:
fullPattern
- the pattern to match against, with prepended root directory pathdir
- the current directoryresult
- the Set of matching File instances to add to- 抛出:
IOException
- if directory contents could not be retrieved