Spring源码学习5：BeanDefinitionRegister模块-Resource

已于 2024-08-06 16:50:32 修改
阅读量707 收藏 15
点赞数 14
分类专栏： Sping源码 文章标签： spring 学习 java
于 2024-07-31 20:26:52 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34672539/article/details/140737154
版权

BeanDefinition是怎么来的？

ReourceLoader装载配置文件
BeanDefinitionReader解析配置信息
配置文件
Resource
BeanDefinitionRegister
BeanDefinition

发现流程图中涉及到了4个主要的接口，齐心协力之下，把配置信息变成了我们熟悉的Bean定义，来学习一下吧：

  • ReourceLoader：用于加载资源（如XML配置文件）
  • Resource： 表示加载的资源
  • BeanDefinitionReader：读取资源中的bean定义
  • BeanDefinitionRegistry：用于注册和管理bean定义

什么是资源(Resource)？

在计算机科学和软件工程中，资源通常指的是程序或系统需要访问和使用的外部数据或文件。这些资源可以以多种形式存在，包括但不限于文件系统中的文件、数据库中的数据、网络上的远程文件或服务、类路径中的文件以及内存中的数据。这些资源可以包含配置文件、图像、文档、脚本、音频文件、视频文件等。

1. 类路径资源 (Classpath Resource)
描述：这些资源位于应用程序的类路径中，通常用于加载配置文件、静态资源等。例如，applicationContext.xml位于类路径中，可以通过classpath:applicationContext.xml进行访问。
2.文件系统资源 (File System Resource)
描述：这些资源位于文件系统中，可以通过绝对路径或相对路径进行访问。例如，/path/to/file.txt位于文件系统中，可以通过file:/path/to/file.txt进行访问。
3. URL资源 (URL Resource)
描述：这些资源通过URL进行访问，通常用于加载网络上的远程资源。例如，http://example.com/resource.txt位于网络上，可以通过http://example.com/resource.txt进行访问。
4. 字节数组资源 (Byte Array Resource)
描述：这些资源使用字节数组表示，可以直接在内存中操作。例如，使用new ByteArrayResource(byteArray)创建一个字节数组资源。
5. 输入流资源 (Input Stream Resource)
描述：这些资源使用输入流表示，可以直接从输入流中读取数据。例如，使用new InputStreamResource(inputStream)创建一个输入流资源。
6. ServletContext资源 (ServletContext Resource)
描述：这些资源位于Web应用的ServletContext中，通常用于加载Web应用中的配置文件或静态资源。例如，/WEB-INF/web.xml位于ServletContext中。

Resource实现类

资源类型实现类示例路径
1. 类路径资源ClassPathResourceclasspath:applicationContext.xml
2. 文件系统资源FileSystemResourcefile:/path/to/file.txt
3. Url资源UrlResourcehttp://example.com/resource.txt
4. 字节数组资源ByteArrayResourcenew ByteArrayResource(byteArray)
5. 输入流资源InputStreamResourcenew InputStreamResource(inputStream)
6. ServletContext资源ServletContextResource/WEB-INF/web.xml

统一接口：Resource

Resource接口为这些不同类型的资源提供了统一的操作方法。
"统一接口"说的就是：无论资源类型如何，开发者都可以使用相同的方法来检查资源的存在性、读取资源内容等。

public interface Resource extends InputStreamSource {

	资源是否存在
    boolean exists();

	资源是否可读
    boolean isReadable();

	资源是否已打开
    boolean isOpen();

	1. FileSystemResource：返回实例：file:/path/to/file.txt（文件系统资源）
	2. UrlResource：返回实例：http://example.com/resource.txt（URL资源）
	3. ByteArrayResource：返回实例：抛出FileNotFoundException异常
    URL getURL() throws IOException; 获取资源的URL
    URI getURI() throws IOException; 获取资源的URI

	获取资源对应的文件对象
    File getFile() throws IOException;

	获取资源的内容长度
    long contentLength() throws IOException;

	获取资源的最后修改时间
    long lastModified() throws IOException;

	根据相对路径创建相对于此资源的资源
    Resource createRelative(String relativePath) throws IOException;

	获取资源的文件名
    String getFilename();

	描述资源的内容或位置
	虽然方法名中包含了“描述”，但它并不会实际读取资源的内容或从资源中提取字符串。
	描述内容是指资源的类型和位置信息，而不是资源内部的数据内容。
    String getDescription();
}

方法说明：isOpen

资源是否已打开：打开资源意味着打开一个输入流来读取其内容。

观察：

类getInputStream()返回结果isOpen()返回结果
FileSystemResource每次返回一个新对象false
ClassPathResource每次返回一个新对象false
ByteArrayResource每次返回一个新对象false
InputStreamResource每次返回封装的对象true
………

问题：

  1. FileSystemResource的getInputStream()方法、InputStreamResource的getInputStream()方法有什么不同吗？
  2. 为什么调用getInputStream()方法之后，有些isOpen返回false，有些返回true？

解答：

先看看FileSystemResource 的源码：

public class FileSystemResource extends AbstractResource {

    private final File file;

    public FileSystemResource(File file) {
        this.file = file;
    }

	每次都是返回一个新的FileInputStream，且下面的isOpen永远返回false
    @Override
    public InputStream getInputStream() throws IOException {
        return new FileInputStream(this.file);
    }

	isOpen永远返回true！
    @Override
    public boolean isOpen() {
        return false;
    }

    // 其他方法...
}

FileSystemResource：代表一个文件系统中的资源。每次调用getInputStream方法时，它都会创建一个新的FileInputStream实例。因此，资源的打开状态不依赖于FileSystemResource实例，而是依赖于每次调用时创建的新的输入流。所以isOpen方法必须返回false，因为资源的打开状态与FileSystemResource的实例无关。


再看看InputStreamResource 的源码：

public class InputStreamResource extends AbstractResource {

    private final InputStream inputStream;
    private boolean read = false;

    public InputStreamResource(InputStream inputStream) {
        this.inputStream = inputStream;
    }

	这里是依赖本身的，且会在getInputStream时候将read 设置为true
    @Override
    public InputStream getInputStream() {
        this.read = true;
        return this.inputStream;
    }

	默认为flase，调用getInputStream变为true
    @Override
    public boolean isOpen() {
        return this.read;
    }

    // 其他方法...
}

InputStreamResource：直接包装一个现有的InputStream。每次调用getInputStream方法时，它都是返回包装的同一个InputStream，依赖于自己，并且在第一次调用getInputStream之后，read改变为true，因此isOpen会返回true。

方法说明：getURI | getURL

  • getURI() 会返回一个用于标识资源的 URI；
  • getURL() 通常会返回一个可以用来定位资源的 URL，表示一个可访问的地址；
    • 只要getURL方法能返回一个URL，那就是可以访问的URL，否则，方法会抛出异常。类似于getFile、getInputStream都是返回一个可访问的对象；

观察：

对象getURL返回结果getURI返回结果说明
FileSystemResourcefile:/path/to/file.txtfile:/path/to/file.txt文件系统资源URL
UrlResourcehttp://example.com/resource.txthttp://example.com/resource.txtURL资源
ClassPathResourcefile:/path/to/your/project/target/classes/application.propertiesfile:/path/to/your/project/target/classes/application.properties类路径资源
ServletContextResourcefile:/path/to/your/servlet/context/resource抛出异常ServletContext资源
ByteArrayResource抛出异常抛出异常字节数组资源
InputStreamResource抛出异常抛出异常输入流资源

URL是什么

  • 统一资源定位符
  • 侧重点：指向一个 可以访问 的资源，所以包含了访问资源的必要信息（如http、https、ftp等），以及资源的位置（例如域名和路径）
  • URL示例：http://example.com/resource

URI 是什么？

  • 统一资源标识符
  • 侧重点：用于标识一个资源。URI 可以是一个 URL 或者 URN

使用案例

项目结构:

src/
└── main/
    └── resources/
        └── config.properties

config.properties 文件内容:

app.name=MyApp
app.version=1.0.0

import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
import java.util.Properties;

public class ClassPathResourceExample {

    public static void main(String[] args) {
        // 创建 ClassPathResource 对象，指向类路径中的 config.properties 文件
        Resource resource = new ClassPathResource("config.properties");

        // 调用所有 Resource 接口的方法
        try {
            System.out.println("资源是否存在: " + resource.exists());

            System.out.println("资源是否可读: " + resource.isReadable());

            System.out.println("资源是否打开: " + resource.isOpen());

            URL url = resource.getURL();
            System.out.println("资源 URL: " + url);

            URI uri = resource.getURI();
            System.out.println("资源 URI: " + uri);

            File file = resource.getFile();
            System.out.println("资源文件信息: " + file.getAbsolutePath());

            long contentLength = resource.contentLength();
            System.out.println("资源内容长度: " + contentLength);

            long lastModified = resource.lastModified();
            System.out.println("资源最后修改时间: " + lastModified);

			//createRelative(): 创建一个相对于当前资源路径的新资源对象
            Resource relativeResource = resource.createRelative("anotherConfig.properties");
            System.out.println("创建一个相对于当前资源路径的新资源对象: " + relativeResource.getDescription());

            String filename = resource.getFilename();
            System.out.println("资源文件名: " + filename);

            // getDescription()
            String description = resource.getDescription();
            System.out.println("资源描述信息: " + description);

            // 读取文件内容
            try (InputStream inputStream = resource.getInputStream()) {
                Properties properties = new Properties();
                properties.load(inputStream);

                // 输出读取到的配置内容
                System.out.println("App Name: " + properties.getProperty("app.name"));
                System.out.println("App Version: " + properties.getProperty("app.version"));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

getInputStream、getFile、getURL选择

  1. getInputStream()

    对文件的内容进行操作。提供一种通用的方式读取各种类型的资源，而不关心资源的实际存储位置。

  2. getFile()

    对文件进行操作，比如：文件复制、移动、删除等。 只有当资源实际存储在文件系统中时才能使用。如果资源不是文件系统中的文件，例如位于 JAR 包中的文件或网络资源，调用该方法会抛出异常。

  3. getURL()

    适用于需要将资源作为 URL 处理的场景，例如通过网络访问资源、传递资源的 URL 等。可以用于网络通信、资源定位等。

构造函数参数：绝对路径

  • 文件的完整路径，从文件系统的根目录开始。例如：
    • Windows: C:\Users\username\Documents\file.txt
    • Linux: /home/username/Documents/file.txt

绝对路径：以 / 开头的路径被视为绝对路径，直接指向文件系统中的位置。例如，/data/file.txt 会被解析为根目录下的 data/file.txt（在 Unix/Linux 系统中）。

构造函数参数：相对路径

相对路径：没有以 / 开头的路径被视为相对于当前工作目录的路径。例如，data/file.txt 会被解析为当前工作目录下的data/file.txt。

什么叫 “当前工作目录” ?

工作目录：是指 Java 虚拟机（JVM）启动时的目录。这通常是运行 Java 命令的目录！例如：

包所在目录命令运行目录运行命令工作目录
/home/project/home/projectjava -jar myapp.jar/home/project
/home/project/homejava -jar /home/project/myapp.jar/home/project

“工作目录” = “包所在目录”

构造函数参数：没有“前缀”

在没有前缀的情况下，路径处理的方式取决于具体使用的 Resource 实现类。

  1. FileSystemResource：用于文件系统中的文件，当传递相对路径时，它会解释为相对于当前工作目录的路径。
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;

public class FileSystemResourceExample {
    public static void main(String[] args) {
        Resource resource = new FileSystemResource("data/file.txt");
        printResourceDetails(resource);
    }

    private static void printResourceDetails(Resource resource) {
        try {
            System.out.println("File exists: " + resource.exists());
            System.out.println("URL: " + resource.getURL());
            System.out.println("File: " + resource.getFile());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

  1. ClassPathResource：用于类路径中的资源，当传递相对路径时，它会解释为相对于类路径的路径。

    如果你传递 com/example/config.properties，ClassPathResource 会在类路径下的com/example目录中寻找这个文件。

src
└── main
    └── resources
        ├── config.properties
        └── com
            └── example
                └── config.properties


import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;

public class ClassPathResourceExample {
    public static void main(String[] args) {
        Resource resource = new ClassPathResource("com/example/config.properties");
        printResourceDetails(resource);
    }

    private static void printResourceDetails(Resource resource) {
        try {
            System.out.println("File exists: " + resource.exists());
            System.out.println("URL: " + resource.getURL());
            // Note: getFile() might not work for resources in JAR files
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
  1. UrlResource
    当我们说“相对于当前 URL”的时候，这通常是指一个 URL 基于另一个 URL 的路径来解析。在 Web 开发中，相对路径是基于当前页面的 URL 来解析的，但在 Java 中使用 UrlResource 时，必须明确指定完整的 URL 或相对路径。
import org.springframework.core.io.UrlResource;
import org.springframework.core.io.Resource;

import java.io.IOException;
import java.net.MalformedURLException;

public class UrlResourceExample {
    public static void main(String[] args) {
        try {
            // 创建一个绝对 URL 的资源
            Resource resource = new UrlResource("http://example.com/folder/resource.html");
            printResourceDetails(resource);

            // 如果你尝试使用相对路径，通常需要与一个基 URL 结合使用
            // 例如，构建一个新的 URL
            URL baseUrl = new URL("http://example.com/");
            URL relativeUrl = new URL(baseUrl, "otherpage.html");
            Resource relativeResource = new UrlResource(relativeUrl);
            printResourceDetails(relativeResource);
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }
    }

    private static void printResourceDetails(Resource resource) {
        try {
            System.out.println("Resource exists: " + resource.exists());
            System.out.println("Resource URL: " + resource.getURL());
            System.out.println("Resource Content Length: " + resource.contentLength());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

详细说明

  1. 绝对 URL：
    Resource resource = new UrlResource(“http://example.com/resource.txt”);
    这个构造函数直接使用绝对 URL，UrlResource 会尝试访问这个 URL 指向的资源。

  2. 相对 URL：
    在Web开发中，相对路径是基于当前页面的URL来解析的。例如，如果你在浏览 http://example.com/folder/resource.html，并且页面上有一个相对链接 …/otherpage.html，这个链接会被解析为 http://example.com/otherpage.html。

原来123456
关注
  • 14
    点赞
  • 踩
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring源码分析（一)ClassPathResource类
weixin_43217817的博客
11-28 981
本来说好的短时间不搞spring源码了，但是前端和数据库实在看不下去，加上力扣不知道为什么上不去了，就写个开头吧 我们先写一段简单的spring程序 public static void main(String[] args) { BeanFactory context = new XmlBeanFactory(new ClassPathResource("spring.xml")...
Spring源码学习(八)---注册BeanDefinition
https://juejin.cn/user/4248168663101239/posts
12-15 806
这里主要是使用org.springframework:spring-beans:5.2.0.RELEASE进行分析 文章目录 1. 查看源码相关的快捷键 快捷键 作用 Ctrl + Shift+i 出现类似于预览的小窗口 Ctrl + Enter （接上步）完全打开源码 Ctrl + 鼠标左键 一步到位打开源码 = Ctrl + Shift+i –>Ctrl + Enter Alt+7 查看类的有什么方法 ctrl+f12 查看继承方法 ctrl+h 查看接口的实.
Spring ClassPathResource详解
热门推荐
舞键作歌
08-07 5万+
org.springframework.core.io.ClassPathResource位于Spring核心core下，用以表达类路径下的资源。
Spring源码解析—— ClassPathResource类
weixin_33911824的博客
05-09 1086
一，简单介绍Spring中资源处理相关类 BeanFactory beanFactory=new XmlBeanFactory(new ClassPathResource("applicationContext.xml")); 在Spring中，定义了接口InputStreamSource，这个类中只包含一个方法： publ...
registerBeanDefinition
zzzzzyyyz的博客
05-19 2085
public interface BeanDefinitionRegistry extends AliasRegistry { /** * 在此注册表中注册一个新的bean定义。必须支持RootBeanDefinition和ChildBeanDefinition。 * @param beanName 要注册的bean实例的名称 * @param beanDefinition 要注册的bean实例的定义 *指定的bean名称，我们不允许覆盖它 * @see GenericBeanDe.
spring-resource:spring resouce code learn(Spring源码学习)
05-14
spring-resourcespring resouce code learn自己学习Spring过程中的一些记录， 太复杂的功能记录大概流程， 一些重要点注释实现细节和补充一些使用的例子spring 源码阅读记录IOCAOPMVCSpringMVC源码分析spring 实战...
spring-security-oauth：刚刚宣布-“学习Spring Security OAuth”：
02-19
我刚刚宣布了一门新课程，专用于探索Spring Security 5中的新OAuth2堆栈-了解Spring Security OAuth： ： 建立项目 mvn clean install 项目/模块 该项目包含许多模块，以下是每个模块包含的内容的简要说明： ...
积分管理系统java源码-SpringCloud-Learning:SpringCloud-Learning
06-06
积分管理系统java源码 Spring Cloud Spring Cloud 简介 Spring Cloud是一个基于Spring Boot实现的微服务架构开发工具。它为微服务架构中涉及的配置管理、服务治理、负载均衡、断路器、智能路由、微代理、控制总线、...
spring-framework-5.3.23 源码
03-05
总的来说，Spring Framework 5.3.23源码的学习将让你深入了解这个强大框架的内部工作原理，帮助你更好地利用其功能来构建高效、可扩展的企业级应用程序。通过研究源码，你可以学习如何实现DI、AOP，以及Spring如何...
java8rt.jar源码-springcloud-config:springcloud-config配置中心
06-04
rt.jar源码 springcloud2020（已完结） 介绍 跟阳哥springcloud教程的个人手敲代码，如有错误，不吝赐教，已完结（2020年3月13日）！ 软件架构 springcloud最新 更新时间 个人接口测试工具直接使用IDEA-->Tools--...
Spring解析及注册BeanDefinition
qq_40708942的博客
05-12 593
上一篇文章介绍了资源文件转为Document文件. 下面接着介绍doLoadBeanDefinitions中最核心的部分.如果说前面两篇文章都是介绍XML解析的准备阶段的话,那么registerBeanDefinitions()里面会进行真正的XML文件的解析. 把代码贴一遍 protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) throws BeanDefinitionStoreExcepti
【Spring】28 ClassPathResource：类路径资源
最新发布
好久不见的流星
03-29 930
类可以通过线程上下文类加载器、指定的类加载器或指定的类来加载资源。它支持将类路径资源解析为，如果类路径资源位于文件系统中，但不支持将位于jar包中且未在文件系统上展开的类路径资源解析为。为了解决这个问题，始终支持将资源解析为。是用于表示类路径资源的类，它可以方便地加载类路径下的资源文件。通过示例和扩展应用，我们了解了如何使用来加载类路径资源，并展示了它在Java开发中的常见用法。
Spring 中 BeanDefinition 的注册
weixin_46144481的博客
07-14 702
本文我们来了解下 spring 中 BeanDefinition 的注册 在 spring 中对 bean 的注册主要有两种方式： 第一种是通过配置来注册我们的bean，对应的方法是 DefaultListableBeanFactory 里的 registerBeanDefinition() 方法 第二种是直接注册一个单例 bean，对应的方法则是 DefaultListableBeanFactory 里的 registerSingleton() 方法 下面我们分别来看看这两个方法 registerBe
spring之BeanDefinitionRegistry分析
wang0907的博客
04-27 1262
1：写在前面 我们定义bean时不管是通过java config方式，还是xml配置文件的方式，最终都会解析成BeanDefinition，而这些BeanDefinition都需要注册到容器中，这个注册的工作是通过接口org.springframework.beans.factory.support.BeanDefinitionRegistry来完成的，该接口也正是我们本文要分析的API，先来看下类图： 其中顶层接口是AliasRegistry，用于bean别名的管理，我们就从这个接口的分析开始。 2：A
spring 注册Bean的好几种方法
www.yiye.tech
08-07 2862
1. @Bean 通过在类级别上用@Configuration注解，方法上用@Bean注解显式注入Bean 。 类似xml配置中通过<beans><bean><bean&am
Spring 解析注册BeanDefinition这一篇就Over
anzy/pine的博客
12-26 625
一、简介： 学习过Spring框架的人一定都会听过Spring的IoC(控制反转) 、DI(依赖注入)这两个概念，对于初学Spring的人来说，总觉得IoC 、DI这两个概...
spring--ImportBeanDefinitionRegistrar
chenkanhuang1267的博客
08-29 261
ImportBeanDefinitionRegistrar是spring对外提供动态注册beanDefinition的接口，spring内部大部分套路也是用该接口进行动态注册beanDefinition的。 ImportBeanDefinitionRegistrar接口不是...
Spring Core Container 源码分析七：注册 Bean Definitions
DGenerationX的专栏
02-12 547
前言原本以为，Spring 通过解析 bean 的配置，生成并注册 bean defintions 的过程不太复杂，比较简单，不用单独开辟一篇博文来讲述；但是当在分析前面两个章节有关 @Autowired、@Component、@Service 注解的注入机制的时候，发现，如果没有对有关 bean defintions 的解析和注册机制彻底弄明白，则很难弄清楚 annotation 在 Sprin...
ClassPathResource使用简介
qq_39459400的博客
12-24 2万+
ClassPathResource使用简介 使用Spring的ClassPathResource来读取maven项目resource下的文件 一般来说，我们项目的配置文件及静态资源都会放置在resources目录下。有时我们在项目中使用到resources目录下的文件，这时我们可以使用Spring下的Resouce接口来读取。具体代码如下 Resource resource = new Clas...
BeanDefinition的注册
保质期已过
11-18 457
上节完成对BeanDefinition的解析分析后，下面继续了解BeanDefinition的注册过程 main方法 public static void main(String[] args) { //1.资源定位 Resource resource = new ClassPathResource("bean.xml"); //2.创建IOC容器,这里使用DefaultListableBeanFactory作为IOC容器 DefaultListableBeanFactory default
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值