Spring源码阅读之PropertySource

2023-10-09 21:20
文章标签 源码 spring 阅读 propertysource

本文主要是介绍Spring源码阅读之PropertySource，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

试问，一篇文章一半的字不认识，你能理解讲了什么故事吗？Spring中大部分的类你都陌生，你能读懂？顶多是死记硬背罢了！

本文带你了解Spring中的存储属性资源的类-PropertySource

最佳打开方式：自己一边手动翻看源码，一边对照阅读。文章中粘出的代码都很容易，慢慢啃，绝对有收获！

一、PropertySource

public abstract class PropertySource<T> {protected final String name;protected final T source;public String getName() {return this.name;}public T getSource() {return this.source;}public boolean containsProperty(String name) {return (getProperty(name) != null);}public abstract Object getProperty(String name);
}

最上层的类PropertySource是一个抽象类，只有2个属性，name和泛型定义的source，而且是final标注的，表明赋值后不可修改。方法也很简单，用来获取属性。

下面是类关系图：

 看着很复杂，但其实仔细看可以发现，以PropertySource为基础，一共能分为2部分：左边的EnumerablePropertySource为一部分，剩下右边的为一部分，接下来，我们来看看这两部分分别是干什么的。

二、右半部分

这部分是直接继承自PropertySource，而且没有子类，如下图中用红框圈出的部分：

2.1 JndiPropertySource

该类的作用是从底层Spring JndLocatorDelegate读取属性，要查找的名称将自动以“java:comp/env/”作为前缀。

public class JndiPropertySource extends PropertySource<JndiLocatorDelegate> {public JndiPropertySource(String name) {this(name, JndiLocatorDelegate.createDefaultResourceRefLocator());}public JndiPropertySource(String name, JndiLocatorDelegate jndiLocator) {super(name, jndiLocator);}public Object getProperty(String name) {if (getSource().isResourceRef() && name.indexOf(':') != -1) {return null;}try {Object value = this.source.lookup(name);if (logger.isDebugEnabled()) {logger.debug("JNDI lookup for name [" + name + "] returned: [" + value + "]");}return value;}catch (NamingException ex) {if (logger.isDebugEnabled()) {logger.debug("JNDI lookup for name [" + name + "] threw NamingException " +"with message: " + ex.getMessage() + ". Returning null.");}return null;}}
}

JNDI即Java Naming and Directory Interface（JAVA命名和目录接口）。为开发人员提供了查找和访问各种命名和目录服务的通用、统一的接口。

2.2 RandomValuePropertySource

该类为任何以"random."开头的属性返回一个随机值，主要代码如下：

public class RandomValuePropertySource extends PropertySource<Random> {public static final String RANDOM_PROPERTY_SOURCE_NAME = "random";private static final String PREFIX = "random.";public RandomValuePropertySource() {this(RANDOM_PROPERTY_SOURCE_NAME);}public RandomValuePropertySource(String name) {super(name, new Random());}@Overridepublic Object getProperty(String name) {if (!name.startsWith(PREFIX)) {return null;}logger.trace(LogMessage.format("Generating random property for '%s'", name));return getRandomValue(name.substring(PREFIX.length()));}private Object getRandomValue(String type) {if (type.equals("int")) {return getSource().nextInt();}if (type.equals("long")) {return getSource().nextLong();}String range = getRange(type, "int");if (range != null) {return getNextIntInRange(Range.of(range, Integer::parseInt));}range = getRange(type, "long");if (range != null) {return getNextLongInRange(Range.of(range, Long::parseLong));}if (type.equals("uuid")) {return UUID.randomUUID().toString();}return getRandomBytes();}

这里举几个例子来说明用法：

class test{public static void main(String[] args) {RandomValuePropertySource random = new RandomValuePropertySource();System.out.println(random.getProperty("random.int"));//生成int随机数System.out.println(random.getProperty("random.int(100,200)"));//指定范围System.out.println(random.getProperty("random.long"));//生成long随机数System.out.println(random.getProperty("random.long(200,300)"));//指定范围System.out.println(random.getProperty("random.uuid"));//生成随机uuid}
}

​

 2.3 AnsiPropertySource

该类的作用是用来获取AnsiStyle形式的属性，使用的地方在SpringBoot的banner中。

代码如下：

public class AnsiPropertySource extends PropertySource<AnsiElement> {private static final Iterable<Mapping> MAPPINGS;static {List<Mapping> mappings = new ArrayList<>();mappings.add(new EnumMapping<>("AnsiStyle.", AnsiStyle.class));mappings.add(new EnumMapping<>("AnsiColor.", AnsiColor.class));mappings.add(new Ansi8BitColorMapping("AnsiColor.", Ansi8BitColor::foreground));mappings.add(new EnumMapping<>("AnsiBackground.", AnsiBackground.class));mappings.add(new Ansi8BitColorMapping("AnsiBackground.", Ansi8BitColor::background));mappings.add(new EnumMapping<>("Ansi.", AnsiStyle.class));mappings.add(new EnumMapping<>("Ansi.", AnsiColor.class));mappings.add(new EnumMapping<>("Ansi.BG_", AnsiBackground.class));MAPPINGS = Collections.unmodifiableList(mappings);}
}

定义了颜色、字体风格、背景等。

使用的时候，在banner.txt中如下：

${AnsiColor.BRIGHT_YELLOW}${AnsiStyle.BOLD}
__  _  ___________  ___
\ \/ \/ /\____ \  \/  /\     / |  |_> >    <\/\_/  |   __/__/\_ \|__|        \/
${AnsiColor.CYAN}${AnsiStyle.BOLD}
::  Java                 ::  (v${java.version})
::  Spring Boot          ::  (v${spring-boot.version})
${Ans

那么启动的时候，解析过程会调用该类，结果如下：

​

3.3 ConfigurationPropertySourcesPropertySource

这个类没有特别的地方，是为了便于这些属性资源可以与PropertySolver一起使用或添加到 Environment中。

这个类后续讲 Environment和PropertySolver会说到。

3.4 FilteredPropertySource

这个类使用来过滤掉一些指定的属性，代码如下：

class FilteredPropertySource extends PropertySource<PropertySource<?>> {private final Set<String> filteredProperties;FilteredPropertySource(PropertySource<?> original, Set<String> filteredProperties) {super(original.getName(), original);this.filteredProperties = filteredProperties;}@Overridepublic Object getProperty(String name) {if (this.filteredProperties.contains(name)) {return null;}return getSource().getProperty(name);}
}

该类支持把别的PropertySource传入，并且指定一个特定的集合，查询的时候，指定集合中的属性返回null。

三、左半部分

右半部分说完，我们来看左半部分，左边都是PropertySource的子类EnumerablePropertySource类的派生类，如下：

​

我们先来看EnumerablePropertySource，这个看名字含义是：可枚举的PropertySource，代码如下：

public abstract class EnumerablePropertySource<T> extends PropertySource<T> {public EnumerablePropertySource(String name, T source) {super(name, source);}protected EnumerablePropertySource(String name) {super(name);}@Overridepublic boolean containsProperty(String name) {return ObjectUtils.containsElement(getPropertyNames(), name);}public abstract String[] getPropertyNames();}

和名字一样，只是比父类多了一个抽象方法，用于获取source中的所有属性名字。

子类都很类似，都是获取属性的一些方法，我们这里主要讲一下MapPropertySource和他的子类。

3.1 MapPropertySource

该类作用和名字意思一样，指定了父类中T source中泛型类型，为map。实现了父类EnumerablePropertySource的方法，获取了map中key的集合。

public class MapPropertySource extends EnumerablePropertySource<Map<String, Object>> {public MapPropertySource(String name, Map<String, Object> source) {super(name, source);}@Override@Nullablepublic Object getProperty(String name) {return this.source.get(name);}@Overridepublic boolean containsProperty(String name) {return this.source.containsKey(name);}@Overridepublic String[] getPropertyNames() {return StringUtils.toStringArray(this.source.keySet());}}

3.2 DefaultPropertiesPropertySource

该类是MapPropertySource的子类，类中与父类与众不同的方法都加了注释：

下面代码中出现的PropertySources和PropertySource不是一回事，和名字意思一样，PropertySources中包含了多个PropertySource。

public class DefaultPropertiesPropertySource extends MapPropertySource {public static final String NAME = "defaultProperties";//入参中的propertySource名字是否和当前类一样public static boolean hasMatchingName(PropertySource<?> propertySource) {return (propertySource != null) && propertySource.getName().equals(NAME);}//参数校验通过后，将入参source带入action中执行public static void ifNotEmpty(Map<String, Object> source, Consumer<DefaultPropertiesPropertySource> action) {if (!CollectionUtils.isEmpty(source) && action != null) {action.accept(new DefaultPropertiesPropertySource(source));}}//将给定的map添加到sources中，或者合sources中的名字为NAME的source合并public static void addOrMerge(Map<String, Object> source, MutablePropertySources sources) {if (!CollectionUtils.isEmpty(source)) {Map<String, Object> resultingSource = new HashMap<>();DefaultPropertiesPropertySource propertySource = new DefaultPropertiesPropertySource(resultingSource);if (sources.contains(NAME)) {mergeIfPossible(source, sources, resultingSource);sources.replace(NAME, propertySource);}else {resultingSource.putAll(source);sources.addLast(propertySource);}}}@SuppressWarnings("unchecked")private static void mergeIfPossible(Map<String, Object> source, MutablePropertySources sources,Map<String, Object> resultingSource) {PropertySource<?> existingSource = sources.get(NAME);if (existingSource != null) {Object underlyingSource = existingSource.getSource();if (underlyingSource instanceof Map) {resultingSource.putAll((Map<String, Object>) underlyingSource);}resultingSource.putAll(source);}}//将propertySources中名字为NAME("defaultProperties")的source移动到最后public static void moveToEnd(MutablePropertySources propertySources) {PropertySource<?> propertySource = propertySources.remove(NAME);if (propertySource != null) {propertySources.addLast(propertySource);}}}

四、总结

通过这么多类的说明，大家应该对PropertySource有了深刻的理解，说白了就是对属性资源的操作类，Spring根据不同的使用场景实现了不同的类。

觉得有帮助的同学不妨点个赞吧！你的支持是我写作的最大动力，谢谢！

这篇关于Spring源码阅读之PropertySource的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/175645。

相关文章

Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
Java ArrayList扩容机制 （源码解读）

Java ArrayList扩容机制 （源码解读）

结论：初始长度为10，若所需长度小于1.5倍原长度，则按照1.5倍扩容。若不够用则按照所需长度扩容。 一. 明确类内部重要变量含义         1：数组默认长度         2:这是一个共享的空数组实例，用于明确创建长度为0时的ArrayList ，比如通过 new ArrayList<>(0)，ArrayList 内部的数组 elementData 会指向这个 EMPTY_EL
阅读更多...
如何在Visual Studio中调试.NET源码

如何在Visual Studio中调试.NET源码

今天偶然在看别人代码时，发现在他的代码里使用了Any判断List<T>是否为空。 我一般的做法是先判断是否为null，再判断Count。 看了一下Count的源码如下： 1 [__DynamicallyInvokable]2 public int Count3 {4 [__DynamicallyInvokable]5 get
阅读更多...
计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者：计算机编程-吉哥 🍊简介：专业从事JavaWeb程序开发，微信小程序开发，定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事，生活就是快乐的。 🍊心愿：点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能
阅读更多...
工厂ERP管理系统实现源码（JAVA）

工厂ERP管理系统实现源码（JAVA）

工厂进销存管理系统是一个集采购管理、仓库管理、生产管理和销售管理于一体的综合解决方案。该系统旨在帮助企业优化流程、提高效率、降低成本，并实时掌握各环节的运营状况。 在采购管理方面，系统能够处理采购订单、供应商管理和采购入库等流程，确保采购过程的透明和高效。仓库管理方面，实现库存的精准管理，包括入库、出库、盘点等操作，确保库存数据的准确性和实时性。 生产管理模块则涵盖了生产计划制定、物料需求计划、
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2