ResourcePatternResolver接口源码分析

master
xuchengsheng 2023-11-27 16:13:36 +08:00
parent 8c4ed93240
commit cb380b779e
12 changed files with 316 additions and 115 deletions

View File

@ -67,6 +67,8 @@
- [`Resource`](spring-resources/spring-resource/README.md):抽象接口,表示文件、类路径等,用于访问不同来源的资源。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
- [`ResourceLoader`](spring-resources/spring-resource-resourceLoader/README.md):资源获取核心接口,实现统一加载不同位置资源的策略。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
- [`ResourcePatternResolver`](spring-resources/spring-resource-resourcePatternResolver/README.md):资源模式解析接口,支持多种位置、通配符,用于加载应用程序中的资源。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
- [`DocumentLoader`](spring-resources/spring-resource-documentLoader/README.md)XML文档加载解析核心接口支持后台自动配置Spring应用。<img src="https://img.shields.io/badge/Level-%E7%AE%80%E5%8D%95-0099ff"></img>
- 元数据与过滤

View File

@ -16,6 +16,7 @@
<module>spring-resource</module>
<module>spring-resource-resourceLoader</module>
<module>spring-resource-documentLoader</module>
<module>spring-resource-resourcePatternResolver</module>
</modules>
</project>

View File

@ -19,10 +19,15 @@
### 二、知识储备
1. **Spring 资源抽象**
- [Resource](https://github.com/xuchengsheng/spring-reading/blob/master/spring-resources/spring-resource) 接口及其各种实现。
2. **路径和模式解析**
- Spring 中的路径解析,特别是使用 ant 风格的路径模式,例如 `classpath*:com/example/**/*.xml`
3. **理解不同的资源类型**
- 文件资源、类路径资源、URL 资源、JAR 中的资源等。
### 三、基本描述
@ -32,16 +37,27 @@
### 四、主要功能
1. **统一资源加载**
- `ResourceLoader` 提供了一个标准化的方法来加载资源不论资源是存放在类路径、文件系统、网络URL还是其他位置。
2. **资源位置解析**
- 根据提供的资源字符串位置(如 "classpath:", "file:", "http:"`ResourceLoader` 可以确定资源的类型,并为其创建相应的 `Resource` 实例。
3. **返回 `Resource` 实例**
- 通过 `Resource getResource(String location)` 方法,`ResourceLoader` 返回一个 `Resource` 对象,代表了指定位置的资源。这使得读取和操作资源变得简单且统一。
4. **`ClassLoader` 的交互**
- `ResourceLoader` 通过 `ClassLoader getClassLoader()` 方法返回与其关联的 `ClassLoader`。这使得资源加载策略可以与特定的类加载器关联。
5. **扩展性**
- `ResourceLoader` 是一个接口,这意味着我们可以实现自己的资源加载策略,或者扩展默认的策略以满足特定需求。
6. **内置实现与整合**
- Spring 提供了默认的 `ResourceLoader` 实现,如 `DefaultResourceLoader`。但更重要的是,`org.springframework.context.ApplicationContext` 也实现了 `ResourceLoader`,这意味着 Spring 上下文本身就是一个资源加载器。
### 五、接口源码
@ -89,55 +105,10 @@ public interface ResourceLoader {
}
```
`ResourcePatternResolver` 接口提供了一种机制允许使用特定的模式如Ant风格的路径模式从不同的来源解析多个 `Resource` 对象。这不仅限于解析单一资源而是可以批量解析符合某个模式的所有资源这在加载分散在多个位置或JAR文件中的配置文件时特别有用。与普通的 `ResourceLoader` 相比,它增加了位置模式解析的能力,使得资源加载更加灵活和强大。
```java
/**
* 用于将位置模式例如Ant风格的路径模式解析为 Resource 对象的策略接口。
*
* 这是 ResourceLoader 接口的扩展。可以检查传入的 ResourceLoader例如通过
* ResourceLoaderAware 在上下文中运行时传入的 ApplicationContext是否也实现了这个扩展接口。
*
* PathMatchingResourcePatternResolver 是一个独立的实现,可以在 ApplicationContext 外部使用,
* 也被 ResourceArrayPropertyEditor 用于填充 Resource 数组bean属性。
*
* 可以与任何形式的位置模式一起使用(例如 "/WEB-INF/*-context.xml"):输入模式必须匹配策略实现。
* 此接口仅指定转换方法而不是特定的模式格式。
*
* 此接口还为类路径中的所有匹配资源建议了一个新的资源前缀 "classpath*:"。
* 请注意,这种情况下的资源位置预计是一个没有占位符的路径(例如 "/beans.xml"
* JAR 文件或类路径中的不同目录可能包含多个同名文件。
*
* @author Juergen Hoeller
* @since 1.0.2
*/
public interface ResourcePatternResolver extends ResourceLoader {
/**
* 从类路径获取所有匹配资源的伪 URL 前缀:"classpath*:"。
* 这与 ResourceLoader 的类路径 URL 前缀不同,因为它检索给定名称的所有匹配资源(例如 "/beans.xml"
* 例如所有部署的 JAR 文件的根目录。
*/
String CLASSPATH_ALL_URL_PREFIX = "classpath*:";
/**
* 将给定的位置模式解析为 Resource 对象。
* 尽可能避免重叠的资源条目指向同一物理资源。结果应该具有集合语义。
* @param locationPattern 要解析的位置模式
* @return 对应的 Resource 对象
* @throws IOException 如果出现 I/O 错误
*/
Resource[] getResources(String locationPattern) throws IOException;
}
```
### 六、主要实现
1. **`DefaultResourceLoader`**
+ 这是基本的资源加载器实现。它可以处理 "classpath:" 前缀的资源,如果没有提供这样的前缀,它会尝试使用类加载器或文件系统来加载资源。
2. **`PathMatchingResourcePatternResolver`**
+ 这个类不仅实现了 `ResourceLoader` 接口,还实现了 `ResourcePatternResolver` 接口。它扩展了 `DefaultResourceLoader` 的功能,支持 "classpath*:" 这样的模式来加载匹配的所有资源。
~~~mermaid
classDiagram
@ -148,22 +119,11 @@ classDiagram
+ getClassLoader() : ClassLoader
}
class ResourcePatternResolver {
<<interface>>
+getResources(locationPattern) : Resource[]
}
class DefaultResourceLoader {
-ClassLoader classLoader
}
class PathMatchingResourcePatternResolver {
-ResourceLoader resourceLoader
}
ResourcePatternResolver --|> ResourceLoader
DefaultResourceLoader ..|> ResourceLoader
PathMatchingResourcePatternResolver ..|> ResourcePatternResolver
~~~
@ -209,43 +169,6 @@ Classpath Exists= true
File Exists = true
```
**`PathMatchingResourcePatternResolver`**
使用 `PathMatchingResourcePatternResolver` 来加载匹配指定模式的资源。
```java
public class PathMatchingResourcePatternResolverDemo {
public static void main(String[] args) throws Exception {
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
// 加载所有匹配的类路径资源
Resource[] resources = resolver.getResources("classpath*:*.properties");
for (Resource resource : resources) {
System.out.println("Classpath = " + resource.getFilename());
}
// 加载文件系统中的所有匹配资源
Resource[] fileResources = resolver.getResources("file:/idea-work-space-xcs/spring-reading/spring-resources/spring-resource-resourceLoader/*.txt");
for (Resource resource : fileResources) {
System.out.println("File = " + resource.getFilename());
}
}
}
```
运行结果发现
- 从类路径上,我们加载了两个文件:`application.properties` 和 `bootstrap.properties`。这意味着在我们的项目的类路径中,有这两个文件。
- 从文件系统上,我们加载了三个文件:`myfile1.txt`, `myfile2.txt`, 和 `myfile3.txt`。这些文件位于我们之前在代码中硬编码的文件路径 `/idea-work-space-xcs/spring-reading/spring-resources/spring-resource-resourceLoader/` 下。
```java
Classpath = application.properties
Classpath = bootstrap.properties
File = myfile1.txt
File = myfile2.txt
File = myfile3.txt
```
### 八、与其他组件的关系
1. **`ApplicationContext`**
@ -271,25 +194,33 @@ File = myfile3.txt
### 九、常见问题
1. **如何加载类路径资源?**
- 使用前缀 "classpath:",例如:`loader.getResource("classpath:myconfig.xml")`。
2. **如何加载文件系统资源?**
- 使用前缀 "file:",例如:`loader.getResource("file:/path/to/myconfig.xml")`。
3. **如何加载URL资源**
- 直接使用 URL例如`loader.getResource("http://www.example.com/config.xml")`。
4. **为什么我加载的资源不存在?**
- 使用 `Resource.exists()` 方法检查资源是否存在。确保路径或位置正确,并且资源真的存在于预期的位置。
5. **如何读取资源内容?**
1. **加载类路径资源**
- 使用前缀 "classpath:",例如:`loader.getResource("classpath:myconfig.xml")`。
2. **加载文件系统资源**
- 使用前缀 "file:",例如:`loader.getResource("file:/path/to/myconfig.xml")`。
3. **加载URL资源**
- 直接使用 URL例如`loader.getResource("http://www.example.com/config.xml")`。
4. **资源不存在**
- 使用 `Resource.exists()` 方法检查资源是否存在。确保路径或位置正确,并且资源真的存在于预期的位置。
5. **如何读取资源内容**
- 从 `Resource` 对象中获取 `InputStream`,例如:`resource.getInputStream()`。
6. **我可以从 `Resource` 获取到文件路径吗?**
- 使用 `Resource.getFile()`。但请注意这并不总是有效的例如当资源实际上是一个类路径资源或URL资源时。
7. **如何加载匹配特定模式的多个资源?**
- 使用 `ResourcePatternResolver` 或其实现 `PathMatchingResourcePatternResolver`
8. **如何自动注入 `ResourceLoader`**
- 实现 `ResourceLoaderAware` 接口Spring 将自动为我们的 bean 提供 `ResourceLoader` 的引用。
9. **我如何扩展或自定义资源加载机制?**
- 我们可以实现自己的 `ResourceLoader` 或继承现有的实现,如 `DefaultResourceLoader`
10. **加载资源时出现了异常,如何处理?**
- 捕获 `IOException` 或具体的异常,例如 `FileNotFoundException`
11. **是否可以在加载资源时考虑环境或属性占位符?**
- 使用 `PropertyPlaceholderConfigurer``PropertySourcesPlaceholderConfigurer``@Value` 注解可以解析属性值中的资源路径。
6. **`Resource` 获取到文件路径**
- 使用 `Resource.getFile()`。但请注意这并不总是有效的例如当资源实际上是一个类路径资源或URL资源时。
7. **加载匹配特定模式的多个资源**
- 使用 `ResourcePatternResolver` 或其实现 `PathMatchingResourcePatternResolver`
8. **自动注入 `ResourceLoader`**
- 实现 `ResourceLoaderAware` 接口Spring 将自动为我们的 bean 提供 `ResourceLoader` 的引用。
9. **扩展或自定义资源加载机制**
- 我们可以实现自己的 `ResourceLoader` 或继承现有的实现,如 `DefaultResourceLoader`
11. **加载资源时考虑环境或属性占位符**
- 使用 `PropertyPlaceholderConfigurer``PropertySourcesPlaceholderConfigurer``@Value` 注解可以解析属性值中的资源路径。

View File

@ -0,0 +1,221 @@
### ResourcePatternResolver
- [ResourcePatternResolver](#resourcepatternresolver)
- [一、基本信息](#一基本信息)
- [二、知识储备](#二知识储备)
- [三、基本描述](#三基本描述)
- [四、主要功能](#四主要功能)
- [五、接口源码](#五接口源码)
- [六、主要实现](#六主要实现)
- [七、最佳实践](#七最佳实践)
- [八、与其他组件的关系](#八与其他组件的关系)
- [九、常见问题](#九常见问题)
### 一、基本信息
✒️ **作者** - Lex 📝 **博客** - [掘金](https://juejin.cn/user/4251135018533068/posts) 📚 **源码地址** - [github](https://github.com/xuchengsheng/spring-reading)
### 二、知识储备
+ **`ResourceLoader`**
+ [ResourceLoader](https://github.com/xuchengsheng/spring-reading/blob/master/spring-resources/spring-resource-resourceLoader/README.md) 是 Spring 框架中的一个关键接口,它定义了如何获取资源(例如类路径资源、文件系统资源或网页资源)的策略。这个接口是 Spring 资源加载抽象的核心,使得应用程序可以从不同的资源位置以统一的方式加载资源。
### 三、基本描述
`ResourcePatternResolver`是Spring框架中的一个接口扩展自`ResourceLoader`,用于解析资源模式,支持通过模式匹配检索多个资源。其中,常见的实现类是`PathMatchingResourcePatternResolver`它通过类路径、文件系统或URL等多种资源位置能够根据给定的资源模式获取匹配的资源。通过调用`getResources(String locationPattern)`方法,您可以使用包含通配符的资源模式,例如`classpath*:com/example/**/*.xml`,来获取满足条件的资源数组。这提供了一种灵活的机制,使得在应用程序中能够方便地加载和处理符合特定模式的资源文件,如配置文件、模板文件等。
### 四、主要功能
1. **资源模式解析**
+ 通过`getResources(String locationPattern)`方法,支持使用通配符的资源模式,如`classpath*:com/example/**/*.xml`,用于检索匹配特定模式的多个资源。
2. **资源获取**
+ 通过`getResources(Resource location)`方法,根据给定的资源对象,返回匹配的资源数组。这使得可以获取与特定资源相关联的其他资源,例如获取与给定类路径下的一个文件相关的所有资源。
3. **多种资源位置支持**
+ 可以处理不同的资源位置包括类路径classpath、文件系统、URL等。这使得应用程序能够以不同的方式组织和存储资源而不影响资源的检索和加载。
4. **灵活的资源加载**
+ 结合`ResourceLoader`的能力,`ResourcePatternResolver`允许在应用程序中以统一的方式加载各种资源,而无需关心底层资源的存储位置或形式。
5. **通用资源操作**
+ 通过`Resource`接口提供了对资源的通用操作例如获取资源的URL、输入流、文件句柄等。
### 五、接口源码
`ResourcePatternResolver`是Spring框架中用于解析位置模式为资源对象的策略接口。它扩展了`ResourceLoader`接口允许通过类路径、文件系统、URL等多种方式获取匹配指定模式的资源。
```java
/**
* 策略接口用于将位置模式例如Ant风格的路径模式解析为 Resource 对象。
*
* 这是对 org.springframework.core.io.ResourceLoader 接口的扩展。传入的
* ResourceLoader例如在上下文中通过 org.springframework.context.ResourceLoaderAware
* 传递的 org.springframework.context.ApplicationContext可以检查是否也实现了这个扩展接口。
*
* PathMatchingResourcePatternResolver 是一个独立的实现,可在不依赖
* ApplicationContext 的情况下使用,也被 ResourceArrayPropertyEditor 用于
* 填充 Resource 数组的 bean 属性。
*
* 可用于任何类型的位置模式(例如 "/WEB-INF/*-context.xml"):输入模式必须与策略实现匹配。
* 这个接口只指定了转换方法,而不是具体的模式格式。
*
* 该接口还引入了一个新的资源前缀 "classpath*:",用于匹配类路径下的所有资源。注意,在这种情况下,
* 资源位置预期是没有占位符的路径(例如 "/beans.xml");类路径中的 JAR 文件或不同目录可以包含相同名称的多个文件。
*
* @author Juergen Hoeller
* @since 1.0.2
* @see org.springframework.core.io.Resource
* @see org.springframework.core.io.ResourceLoader
* @see org.springframework.context.ApplicationContext
* @see org.springframework.context.ResourceLoaderAware
*/
public interface ResourcePatternResolver extends ResourceLoader {
/**
* 类路径匹配所有资源的伪 URL 前缀:"classpath*:"
* 这与 ResourceLoader 的类路径 URL 前缀不同,它检索给定名称(例如 "/beans.xml")的
* 所有匹配资源,例如在所有部署的 JAR 文件的根目录中。
* 详见 org.springframework.core.io.ResourceLoader#CLASSPATH_URL_PREFIX
*/
String CLASSPATH_ALL_URL_PREFIX = "classpath*:";
/**
* 将给定的位置模式解析为 Resource 对象。
* 应尽可能避免指向相同物理资源的重叠资源条目。结果应具有集合语义。
* @param locationPattern 要解析的位置模式
* @return 相应的 Resource 对象数组
* @throws IOException 如果发生 I/O 错误
*/
Resource[] getResources(String locationPattern) throws IOException;
}
```
### 六、主要实现
+ PathMatchingResourcePatternResolver
+ 支持使用Ant风格的路径模式例如`classpath*:com/example/**/*.xml`,这允许在类路径中检索符合指定模式的资源。
~~~mermaid
classDiagram
direction BT
class ResourceLoader {
<<interface>>
+ getResource(location) : Resource
+ getClassLoader() : ClassLoader
}
class ResourcePatternResolver {
<<interface>>
+getResources(locationPattern) : Resource[]
}
class PathMatchingResourcePatternResolver {
-ResourceLoader resourceLoader
}
ResourcePatternResolver --|> ResourceLoader
PathMatchingResourcePatternResolver ..|> ResourcePatternResolver
~~~
### 七、最佳实践
使用 `PathMatchingResourcePatternResolver` 来加载匹配指定模式的资源。
```java
public class PathMatchingResourcePatternResolverDemo {
public static void main(String[] args) throws Exception {
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
// 加载所有匹配的类路径资源
Resource[] resources = resolver.getResources("classpath*:*.properties");
for (Resource resource : resources) {
System.out.println("Classpath = " + resource.getFilename());
}
// 加载文件系统中的所有匹配资源
Resource[] fileResources = resolver.getResources("file:/idea-work-space-xcs/spring-reading/spring-resources/spring-resource-resourceLoader/*.txt");
for (Resource resource : fileResources) {
System.out.println("File = " + resource.getFilename());
}
}
}
```
运行结果发现
- 从类路径上,我们加载了两个文件:`application.properties` 和 `bootstrap.properties`。这意味着在我们的项目的类路径中,有这两个文件。
- 从文件系统上,我们加载了三个文件:`myfile1.txt`, `myfile2.txt`, 和 `myfile3.txt`。这些文件位于我们之前在代码中硬编码的文件路径 `/idea-work-space-xcs/spring-reading/spring-resources/spring-resource-resourceLoader/` 下。
```java
Classpath = application.properties
Classpath = bootstrap.properties
File = myfile1.txt
File = myfile2.txt
File = myfile3.txt
```
### 八、与其他组件的关系
1. **BeanDefinitionLoader:**
- `BeanDefinitionLoader` 是 Spring 框架中用于加载 `BeanDefinition` 的接口,提供了对加载过程的抽象。在加载过程中,需要使用 `PathMatchingResourcePatternResolver` 来解析资源模式。
2. **MessageSourceAutoConfiguration:**
- `MessageSourceAutoConfiguration` 是 Spring Boot 中的一个自动配置类用于配置消息源MessageSource。在配置中可能涉及到加载国际化资源文件`PathMatchingResourcePatternResolver` 用于解析这些资源文件的路径。
3. **AbstractBeanDefinitionReader:**
- `AbstractBeanDefinitionReader` 是 Spring 框架中用于读取 `BeanDefinition` 的抽象类,具体的实现类(如 `XmlBeanDefinitionReader`)在加载 XML 文件时可能使用 `PathMatchingResourcePatternResolver`
4. **ClassPathScanningCandidateComponentProvider:**
- `ClassPathScanningCandidateComponentProvider` 是 Spring 框架中用于基于类路径进行组件扫描的类,其中使用了 `PathMatchingResourcePatternResolver` 来解析类路径中的资源。
5. **AbstractApplicationContext:**
- `AbstractApplicationContext` 是 Spring 框架中 `ApplicationContext` 接口的抽象实现,其中在资源加载阶段使用了 `PathMatchingResourcePatternResolver`
6. **ResourcePatternUtils:**
- `ResourcePatternUtils` 提供了一些工具方法,用于处理资源模式。在这个类中,涉及到使用 `PathMatchingResourcePatternResolver` 来解析资源模式。
7. **ResourceArrayPropertyEditor:**
- `ResourceArrayPropertyEditor` 是 Spring 框架中用于处理 `Resource` 数组类型属性的属性编辑器。在处理这些属性时,需要解析资源模式,而 `PathMatchingResourcePatternResolver` 提供了相应的功能。
### 九、常见问题
1. **资源模式不匹配**
+ 如果使用的资源模式没有正确匹配到预期的资源,可能是模式本身不正确或者资源位置设置有误。确保使用的资源模式与实际的资源路径匹配,并检查是否有拼写错误。
2. **类路径下资源无法加载**
+ 如果使用的是类路径前缀(例如 "classpath:" 或 "classpath*:"),但是资源未被正确加载,可能是因为资源位置设置有误。检查资源路径是否正确,尤其是相对于类路径的路径。
3. **文件系统资源加载问题**
+ 当使用文件系统路径时,确保路径的正确性,并确保应用程序有足够的权限来读取这些文件。同时,注意跨平台路径分隔符的问题,尽量使用`File.separator`来确保跨平台兼容性。
4. **资源不存在或为空**
+ 如果 `getResources` 方法返回的数组为空,可能是因为资源位置不存在,或者匹配的资源为空。确保资源位置正确,并验证是否存在符合条件的资源。
5. **资源路径中包含特殊字符**
+ 如果资源路径中包含特殊字符,可能会导致解析问题。考虑在使用路径时进行适当的转义或编码。
6. **性能问题**
+ 在处理大量资源或者模式时,可能会遇到性能问题。考虑对资源模式进行优化,避免过度使用通配符和递归,以提高性能。

View File

@ -0,0 +1 @@
hello world1

View File

@ -0,0 +1 @@
hello world2

View File

@ -0,0 +1 @@
hello world3

View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>spring-resources</artifactId>
<groupId>com.xcs.spring</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-resource-resourcePatternResolver</artifactId>
</project>

View File

@ -0,0 +1,27 @@
package com.xcs.spring;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
/**
* @author xcs
* @date 20231030 1730
**/
public class ResourcePatternResolverDemo {
public static void main(String[] args) throws Exception {
ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
// 加载所有匹配的类路径资源
Resource[] resources = resolver.getResources("classpath*:*.properties");
for (Resource resource : resources) {
System.out.println("Classpath = " + resource.getFilename());
}
// 加载文件系统中的所有匹配资源
Resource[] fileResources = resolver.getResources("file:/idea-work-space-xcs/spring-reading/spring-resources/spring-resource-resourceLoader/*.txt");
for (Resource resource : fileResources) {
System.out.println("File = " + resource.getFilename());
}
}
}

View File

@ -10,7 +10,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>spring-resource</artifactId>
<packaging>pom</packaging>
<dependencies>
<dependency>