Spring 配置元数据

深碍√TFBOYSˉ_ 2024-02-17 09:11 50阅读 0赞

#### 目录标题 ####

*   *  Spring 配置元信息
     *  Spring Bean 配置元信息
     *  Spring Bean 属性元信息
     *  Spring 容器配置元信息
     *  基于 XML 文件装载 Spring Bean 配置元信息
     *  基于 Properties 文件装载 Spring Bean 配置元信息
     *  基于 Java 注解装载 Spring Bean 配置元信息
     *  Spring Bean 配置元信息底层实现
     *   *  Spring XML 资源 BeanDefinition 解析与注册
         *  Spring Properties 资源 BeanDefinition 解析与注册
         *  Spring Java 注册 BeanDefinition 解析与注册
     *  基于 XML 文件装载 Spring IoC 容器配置元信息
     *  基于 Java 注解装载 Spring IoC 容器配置元信息
     *  基于 Extensible XML authoring 扩展 SpringXML 元素
     *  Extensible XML authoring 扩展原理
     *   *  触发时机
         *  核心流程
     *  基于 Properties 文件装载外部化配置
     *  基于 YAML 文件装载外部化配置
     *  问题
     *  参考资料

### Spring 配置元信息 ###

*  Spring Bean 配置元信息 - BeanDefinition
 *  Spring Bean 属性元信息 - PropertyValues
 *  Spring 容器配置元信息
 *  Spring 外部化配置元信息 - PropertySource
 *  Spring Profile 元信息 - @Profile

### Spring Bean 配置元信息 ###

Bean 配置元信息 - BeanDefinition

*  GenericBeanDefinition：通用型 BeanDefinition
 *  RootBeanDefinition：无 Parent 的 BeanDefinition 或者合并后 BeanDefinition
 *  AnnotatedBeanDefinition：注解标注的 BeanDefinition

### Spring Bean 属性元信息 ###

*  Bean 属性元信息 - PropertyValues
    
     *  可修改实现 - MutablePropertyValues
     *  元素成员 - PropertyValue
 *  Bean 属性上下文存储 - AttributeAccessor
 *  Bean 元信息元素 - BeanMetadataElement

### Spring 容器配置元信息 ###

Spring XML 配置元信息 - beans 元素相关

<table> 
 <thead> 
  <tr> 
   <th>beans 元素属性</th> 
   <th>默认值</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>profile</td> 
   <td>null（留空）</td> 
   <td>Spring Profiles 配置值</td> 
  </tr> 
  <tr> 
   <td>default-lazy-init</td> 
   <td>default</td> 
   <td>当 outter beans “default-lazy-init” 属性存在时，继承该值，否则为“false”</td> 
  </tr> 
  <tr> 
   <td>default-merge</td> 
   <td>default</td> 
   <td>当 outter beans “default-merge” 属性存在时，继承该值，否则为“false”</td> 
  </tr> 
  <tr> 
   <td>default-autowire</td> 
   <td>default</td> 
   <td>当 outter beans “default-autowire” 属性存在时，继承该值，否则为“no”</td> 
  </tr> 
  <tr> 
   <td>default-autowire-candidates</td> 
   <td>null（留空）</td> 
   <td>默认 Spring Beans 名称 pattern</td> 
  </tr> 
  <tr> 
   <td>default-init-method</td> 
   <td>null（留空）</td> 
   <td>默认 Spring Beans 自定义初始化方法</td> 
  </tr> 
  <tr> 
   <td>default-destroy-method</td> 
   <td>null（留空）</td> 
   <td>默认 Spring Beans 自定义销毁方法</td> 
  </tr> 
 </tbody> 
</table>

Spring XML 配置元信息 - 应用上下文相关

<table> 
 <thead> 
  <tr> 
   <th>XML 元素</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>&lt;context:annotation-config /&gt;</code></td> 
   <td>激活 Spring 注解驱动</td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:component-scan /&gt;</code></td> 
   <td>Spring <a rel="nofollow">@Component </a></td> 
  </tr> 
  <tr> 
   <td>以及自定义注解扫描</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:load-time-weaver /&gt;</code></td> 
   <td>激活 Spring LoadTimeWeaver</td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:mbean-export /&gt;</code></td> 
   <td>暴露 Spring Beans 作为 JMX Beans</td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:mbean-server /&gt;</code></td> 
   <td>将当前平台作为 MBeanServer</td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:property-placeholder /&gt;</code></td> 
   <td>加载外部化配置资源作为 Spring 属性配</td> 
  </tr> 
  <tr> 
   <td><code>&lt;context:property-override /&gt;</code></td> 
   <td>利用外部化配置资源覆盖 Spring 属</td> 
  </tr> 
 </tbody> 
</table>

### 基于 XML 文件装载 Spring Bean 配置元信息 ###

底层实现 - XmlBeanDefinitionReader

<table> 
 <thead> 
  <tr> 
   <th>XML 元素</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>&lt;beans:beans /&gt;</code></td> 
   <td>单 XML 资源下的多个 Spring Beans 配置</td> 
  </tr> 
  <tr> 
   <td><code>&lt;beans:bean /&gt;</code></td> 
   <td>单个 Spring Bean 定义（BeanDefinition）配置</td> 
  </tr> 
  <tr> 
   <td><code>&lt;beans:alias /&gt;</code></td> 
   <td>为 Spring Bean 定义（BeanDefinition）映射别名</td> 
  </tr> 
  <tr> 
   <td><code>&lt;beans:import /&gt;</code></td> 
   <td>加载外部 Spring XML 配置资源</td> 
  </tr> 
 </tbody> 
</table>

### 基于 Properties 文件装载 Spring Bean 配置元信息 ###

底层实现 - PropertiesBeanDefinitionReader

<table> 
 <thead> 
  <tr> 
   <th>Properties 属性名</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>class</code></td> 
   <td>Bean 类全称限定名</td> 
  </tr> 
  <tr> 
   <td><code>abstract</code></td> 
   <td>是否为抽象的 BeanDefinition</td> 
  </tr> 
  <tr> 
   <td><code>parent</code></td> 
   <td>指定 parent BeanDefinition 名称</td> 
  </tr> 
  <tr> 
   <td><code>lazy-init</code></td> 
   <td>是否为延迟初始化</td> 
  </tr> 
  <tr> 
   <td><code>ref</code></td> 
   <td>引用其他 Bean 的名称</td> 
  </tr> 
  <tr> 
   <td><code>scope</code></td> 
   <td>设置 Bean 的 scope 属性</td> 
  </tr> 
  <tr> 
   <td>${n}</td> 
   <td>n 表示第 n+1 个构造器参数</td> 
  </tr> 
 </tbody> 
</table>

### 基于 Java 注解装载 Spring Bean 配置元信息 ###

Spring 模式注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>@Repository</code></td> 
   <td>数据仓储模式注解</td> 
   <td>2.0</td> 
  </tr> 
  <tr> 
   <td><code>@Component</code></td> 
   <td>通用组件模式注解</td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><code>@Service</code></td> 
   <td>服务模式注解</td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><code>@Controller</code></td> 
   <td>Web 控制器模式注解</td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><code>@Configuration</code></td> 
   <td>配置类模式注解</td> 
   <td>3.0</td> 
  </tr> 
 </tbody> 
</table>

Spring Bean 定义注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>@Bean</code></td> 
   <td>替换 XML 元素 <code>&lt;bean&gt;</code></td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><code>@DependsOn</code></td> 
   <td>替代 XML 属性 <code>&lt;bean depends-on="..."/&gt;</code></td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><code>@Lazy</code></td> 
   <td>替代 XML 属性 <code>&lt;bean lazy-init="true &amp;#124; falses" /&gt;</code></td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><code>@Primary</code></td> 
   <td>替换 XML 元素 <code>&lt;bean primary="true &amp;#124; false" /&gt;</code></td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><code>@Role</code></td> 
   <td>替换 XML 元素 <code>&lt;bean role="..." /&gt;</code></td> 
   <td>3.1</td> 
  </tr> 
  <tr> 
   <td><code>@Lookup</code></td> 
   <td>替代 XML 属性 <code>&lt;bean lookup-method="..."&gt;</code></td> 
   <td>4.1</td> 
  </tr> 
 </tbody> 
</table>

Spring Bean 依赖注入注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>@Autowired</code></td> 
   <td>Bean 依赖注入，支持多种依赖查找方式</td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><code>@Qualifier</code></td> 
   <td>细粒度的 <a rel="nofollow">@Autowired </a></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>依赖查找</td> 
   <td>2.5</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
  <tr> 
   <th>Java 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@Resource </a></td> 
   <td>类似于 <a rel="nofollow">@Autowired </a></td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@Inject </a></td> 
   <td>类似于 <a rel="nofollow">@Autowired </a></td> 
   <td>2.5</td> 
  </tr> 
 </tbody> 
</table>

Spring Bean 条件装配注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@Profile </a></td> 
   <td>配置化条件装配</td> 
   <td>3.1</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@Conditional </a></td> 
   <td>编程条件装配</td> 
   <td>4.0</td> 
  </tr> 
 </tbody> 
</table>

Spring Bean 生命周期回调注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@PostConstruct </a></td> 
   <td>替换 XML 元素 或 InitializingBean</td> 
   <td>2.5</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@PreDestroy </a></td> 
   <td>替换 XML 元素 或 DisposableBean</td> 
   <td>2.5</td> 
  </tr> 
 </tbody> 
</table>

Spring BeanDefinition 解析与注册

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>XML 资源</td> 
   <td>XmlBeanDefinitionReader</td> 
   <td>1.0</td> 
  </tr> 
  <tr> 
   <td>Properties 资源</td> 
   <td>PropertiesBeanDefinitionReader</td> 
   <td>1.0</td> 
  </tr> 
  <tr> 
   <td>Java 注解</td> 
   <td>AnnotatedBeanDefinitionReader</td> 
   <td>3.0</td> 
  </tr> 
 </tbody> 
</table>

### Spring Bean 配置元信息底层实现 ###

#### Spring XML 资源 BeanDefinition 解析与注册 ####

核心 API - XmlBeanDefinitionReader

*  资源 - Resource
 *  底层 - BeanDefinitionDocumentReader
    
     *  XML 解析 - Java DOM Level 3 API
     *  BeanDefinition 解析 - BeanDefinitionParserDelegate
     *  BeanDefinition 注册 - BeanDefinitionRegistry

#### Spring Properties 资源 BeanDefinition 解析与注册 ####

核心 API - PropertiesBeanDefinitionReader

*  资源
    
     *  字节流 - Resource
     *  字符流 - EncodedResouce
 *  底层
    
     *  存储 - java.util.Properties
     *  BeanDefinition 解析 - API 内部实现
     *  BeanDefinition 注册 - BeanDefinitionRegistry

#### Spring Java 注册 BeanDefinition 解析与注册 ####

核心 API - AnnotatedBeanDefinitionReader

*  资源
    
     *  类对象 - java.lang.Class
 *  底层
    
     *  条件评估 - ConditionEvaluator
     *  Bean 范围解析 - ScopeMetadataResolver
     *  BeanDefinition 解析 - 内部 API 实现
     *  BeanDefinition 处理 - AnnotationConfigUtils.processCommonDefinitionAnnotations
     *  BeanDefinition 注册 - BeanDefinitionRegistry

### 基于 XML 文件装载 Spring IoC 容器配置元信息 ###

Spring IoC 容器相关 XML 配置

<table> 
 <thead> 
  <tr> 
   <th>命名空间</th> 
   <th>所属模块</th> 
   <th>Schema 资源 URL</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>beans</td> 
   <td>spring-beans</td> 
   <td><a href="https://www.springframework.org/schema/beans/spring-beans.xsd" rel="nofollow">https://www.springframework.org/schema/beans/spring-beans.xsd</a></td> 
  </tr> 
  <tr> 
   <td>context</td> 
   <td>spring-context</td> 
   <td><a href="https://www.springframework.org/schema/context/spring-context.xsd" rel="nofollow">https://www.springframework.org/schema/context/spring-context.xsd</a></td> 
  </tr> 
  <tr> 
   <td>aop</td> 
   <td>spring-aop</td> 
   <td><a href="https://www.springframework.org/schema/aop/spring-aop.xsd" rel="nofollow">https://www.springframework.org/schema/aop/spring-aop.xsd</a></td> 
  </tr> 
  <tr> 
   <td>tx</td> 
   <td>spring-tx</td> 
   <td><a href="https://www.springframework.org/schema/tx/spring-tx.xsd" rel="nofollow">https://www.springframework.org/schema/tx/spring-tx.xsd</a></td> 
  </tr> 
  <tr> 
   <td>util</td> 
   <td>spring-beans</td> 
   <td>beans <a href="https://www.springframework.org/schema/util/spring-util.xsd" rel="nofollow">https://www.springframework.org/schema/util/spring-util.xsd</a></td> 
  </tr> 
  <tr> 
   <td>tool</td> 
   <td>spring-beans</td> 
   <td><a href="https://www.springframework.org/schema/tool/spring-tool.xsd" rel="nofollow">https://www.springframework.org/schema/tool/spring-tool.xsd</a></td> 
  </tr> 
 </tbody> 
</table>

### 基于 Java 注解装载 Spring IoC 容器配置元信息 ###

Spring IoC 容器装配注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@ImportResource </a></td> 
   <td>替换 XML 元素 <code>&lt;import&gt;</code></td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@Import </a></td> 
   <td>导入 Configuration Class</td> 
   <td>3.0</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@ComponentScan </a></td> 
   <td>扫描指定 package 下标注 Spring 模式注解的类</td> 
   <td>3.1</td> 
  </tr> 
 </tbody> 
</table>

Spring IoC 配属属性注解

<table> 
 <thead> 
  <tr> 
   <th>Spring 注解</th> 
   <th>场景说明</th> 
   <th>起始版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a rel="nofollow">@PropertySource </a></td> 
   <td>配置属性抽象 PropertySource 注解</td> 
   <td>3.1</td> 
  </tr> 
  <tr> 
   <td><a rel="nofollow">@PropertySources </a></td> 
   <td><a rel="nofollow">@PropertySource </a></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>集合注解</td> 
   <td>4.0</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

### 基于 Extensible XML authoring 扩展 SpringXML 元素 ###

Spring XML 扩展

*  编写 XML Schema 文件：定义 XML 结构
 *  自定义 NamespaceHandler 实现：命名空间绑定
 *  自定义 BeanDefinitionParser 实现：XML 元素与 BeanDefinition 解析
 *  注册 XML 扩展：命名空间与 XML Schema 映射

### Extensible XML authoring 扩展原理 ###

#### 触发时机 ####

*  AbstractApplicationContext\#obtainFreshBeanFactory
    
     *  AbstractRefreshableApplicationContext\#refreshBeanFactory
        
         *  AbstractXmlApplicationContext\#loadBeanDefinitions
            
             *  …
                
                 *  XmlBeanDefinitionReader\#doLoadBeanDefinitions
                    
                     *  …
                        
                         *  BeanDefinitionParserDelegate\#parseCustomElement

#### 核心流程 ####

BeanDefinitionParserDelegate\#parseCustomElement(org.w3c.dom.Element, BeanDefinition)

*  获取 namespace
 *  通过 namespace 解析 NamespaceHandler
 *  构造 ParserContext
 *  解析元素，获取 BeanDefinintion

### 基于 Properties 文件装载外部化配置 ###

注解驱动

*  @org.springframework.context.annotation.PropertySource
 *  @org.springframework.context.annotation.PropertySources

API 编程

*  org.springframework.core.env.PropertySource
 *  org.springframework.core.env.PropertySources

### 基于 YAML 文件装载外部化配置 ###

API 编程

*  org.springframework.beans.factory.config.YamlProcessor
    
     *  org.springframework.beans.factory.config.YamlMapFactoryBean
     *  org.springframework.beans.factory.config.YamlPropertiesFactoryBean

### 问题 ###

**Spring 內建 XML Schema 常见有哪些**？

**Spring 配置元信息具体有哪些**？

*  Bean 配置元信息：通过媒介（如 XML、Proeprties 等），解析 BeanDefinition
 *  IoC 容器配置元信息：通过媒介（如 XML、Proeprties 等），控制 IoC 容器行为，比如注解驱动、AOP 等
 *  外部化配置：通过资源抽象（如 Proeprties、YAML 等），控制 PropertySource
 *  Spring Profile：通过外部化配置，提供条件分支流程

**Extensible XML authoring 的缺点**？

*  高复杂度：开发人员需要熟悉 XML Schema，spring.handlers，spring.schemas 以及 Spring API
 *  嵌套元素支持较弱：通常需要使用方法递归或者其嵌套解析的方式处理嵌套（子）元素
 *  XML 处理性能较差：Spring XML 基于 DOM Level 3 API 实现，该 API 便于理解，然而性能较差
 *  XML 框架移植性差：很难适配高性能和便利性的 XML 框架，如 JAXB

### 参考资料 ###

*  [Spring 官方文档之 Core Technologies][Spring _ Core Technologies]
 *  [《小马哥讲 Spring 核心编程思想》][Spring]

[Spring _ Core Technologies]: https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans
[Spring]: https://time.geekbang.org/course/intro/265