Spring 数据绑定

悠悠 2024-02-17 09:23 28阅读 0赞

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

*   *  快速入门
     *  Spring 数据绑定使用场景
     *  DataBinder
     *  Spring 数据绑定元数据
     *  Spring 数据绑定控制参数
     *   *  DataBinder 绑定控制参数
     *  BeanWrapper 的使用场景
     *  Spring 底层 Java Beans 替换实现
     *  DataBinder 数据校验
     *  问题
     *  参考资料

**Spring 数据绑定(Data Binding)的作用是将用户的输入动态绑定到 JavaBean**。换句话说，Spring 数据绑定机制是将属性值设置到目标对象中。

在 Spring 中，数据绑定功能主要由 `DataBinder` 类实现。此外，`BeanWrapper` 也具有类似的功能，但 `DataBinder` 额外支持字段验证、字段格式化和绑定结果分析。

![b1e4f29b66a6e5499003a3e7927c016b.png][]

### 快速入门 ###

定义一个用于测试的 JavaBean

public class TestBean {
        
    
        private int num;
    
        public int getNum() {
        
            return num;
        }
    
        public void setNum(int num) {
        
            this.num = num;
        }
    
        @Override
        public String toString() {
        
            return "TestBean{" + "num=" + num + '}';
        }
    
    }

数据绑定示例

public class DataBindingDemo {
        
    
        public static void main(String[] args) {
        
    
            MutablePropertyValues mpv = new MutablePropertyValues();
            mpv.add("num", "10");
    
            TestBean testBean = new TestBean();
            DataBinder db = new DataBinder(testBean);
    
            db.bind(mpv);
            System.out.println(testBean);
        }
    
    }

### Spring 数据绑定使用场景 ###

*  Spring `BeanDefinition` 到 Bean 实例创建
 *  Spring 数据绑定（`DataBinder`）
 *  Spring Web 参数绑定（`WebDataBinder`）

### DataBinder ###

在 Spring 中，`DataBinder` 类是数据绑定功能的基类。`WebDataBinder` 是 `DataBinder` 的子类，主要用于 Spring Web 数据绑定，此外，还有一些 `WebDataBinder` 的扩展子类，其类族如下图所示：

![a65fae99c9c3c33823a8fa69115d5d99.png][]

DataBinder 核心属性：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>target</code></td> 
   <td>关联目标 Bean</td> 
  </tr> 
  <tr> 
   <td><code>objectName</code></td> 
   <td>目标 Bean 名称</td> 
  </tr> 
  <tr> 
   <td><code>bindingResult</code></td> 
   <td>属性绑定结果</td> 
  </tr> 
  <tr> 
   <td><code>typeConverter</code></td> 
   <td>类型转换器</td> 
  </tr> 
  <tr> 
   <td><code>conversionService</code></td> 
   <td>类型转换服务</td> 
  </tr> 
  <tr> 
   <td><code>messageCodesResolver</code></td> 
   <td>校验错误文案 Code 处理器</td> 
  </tr> 
  <tr> 
   <td><code>validators</code></td> 
   <td>关联的 Bean Validator 实例集合</td> 
  </tr> 
 </tbody> 
</table>

`DataBinder` 类的核心方法是 `bind(PropertyValues)`：将 PropertyValues Key-Value 内容映射到关联 Bean（target）中的属性上

*  假设 PropertyValues 中包含 name=dunwu 的键值对时, 同时 Bean 对象 User 中存在 name 属性, 当 bind 方法执行时, User 对象中的 name 属性值将被绑定为 dunwu

### Spring 数据绑定元数据 ###

DataBinder 元数据 - PropertyValues

<table> 
 <thead> 
  <tr> 
   <th>特征</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>数据来源</td> 
   <td>BeanDefinition，主要来源 XML 资源配置 BeanDefinition</td> 
  </tr> 
  <tr> 
   <td>数据结构</td> 
   <td>由一个或多个 PropertyValue 组成</td> 
  </tr> 
  <tr> 
   <td>成员结构</td> 
   <td>PropertyValue 包含属性名称，以及属性值（包括原始值、类型转换后的值）</td> 
  </tr> 
  <tr> 
   <td>常见实现</td> 
   <td>MutablePropertyValues</td> 
  </tr> 
  <tr> 
   <td>Web 扩展实现</td> 
   <td>ServletConfigPropertyValues、ServletRequestParameterPropertyValues</td> 
  </tr> 
  <tr> 
   <td>相关生命周期</td> 
   <td>InstantiationAwareBeanPostProcessor#postProcessProperties</td> 
  </tr> 
 </tbody> 
</table>

### Spring 数据绑定控制参数 ###

DataBinder 绑定特殊场景分析

*  当 PropertyValues 中包含名称 x 的 PropertyValue，目标对象 B 不存在 x 属性，当 bind 方法执  
    行时，会发生什么？
 *  当 PropertyValues 中包含名称 x 的 PropertyValue，目标对象 B 中存在 x 属性，当 bind 方法执  
    行时，如何避免 B 属性 x 不被绑定？
 *  当 PropertyValues 中包含名称 x.y 的 PropertyValue，目标对象 B 中存在 x 属性（嵌套 y 属性）  
    ，当 bind 方法执行时，会发生什么？

#### DataBinder 绑定控制参数 ####

<table> 
 <thead> 
  <tr> 
   <th>参数名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ignoreUnknownFields</td> 
   <td>是否忽略未知字段，默认值：true</td> 
  </tr> 
  <tr> 
   <td>ignoreInvalidFields</td> 
   <td>是否忽略非法字段，默认值：false</td> 
  </tr> 
  <tr> 
   <td>autoGrowNestedPaths</td> 
   <td>是否自动增加嵌套路径，默认值：true</td> 
  </tr> 
  <tr> 
   <td>allowedFields</td> 
   <td>绑定字段白名单</td> 
  </tr> 
  <tr> 
   <td>disallowedFields</td> 
   <td>绑定字段黑名单</td> 
  </tr> 
  <tr> 
   <td>requiredFields</td> 
   <td>必须绑定字段</td> 
  </tr> 
 </tbody> 
</table>

### BeanWrapper 的使用场景 ###

*  Spring 底层 JavaBeans 基础设施的中心化接口
 *  通常不会直接使用，间接用于 BeanFactory 和 DataBinder
 *  提供标准 JavaBeans 分析和操作，能够单独或批量存储 Java Bean 的属性（properties）
 *  支持嵌套属性路径（nested path）
 *  实现类 org.springframework.beans.BeanWrapperImpl

### Spring 底层 Java Beans 替换实现 ###

JavaBeans 核心实现 - `java.beans.BeanInfo`

*  属性（Property）
    
     *  `java.beans.PropertyEditor`
 *  方法（Method）
 *  事件（Event）
 *  表达式（Expression）

Spring 替代实现 - `org.springframework.beans.BeanWrapper`

*  属性（Property）
    
     *  `java.beans.PropertyEditor`
 *  嵌套属性路径（nested path）

### DataBinder 数据校验 ###

DataBinder 与 BeanWrapper

*  bind 方法生成 BeanPropertyBindingResult
 *  BeanPropertyBindingResult 关联 BeanWrapper

### 问题 ###

标准 JavaBeans 是如何操作属性的？

<table> 
 <thead> 
  <tr> 
   <th>API</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>java.beans.Introspector</td> 
   <td>Java Beans 内省 API</td> 
  </tr> 
  <tr> 
   <td>java.beans.BeanInfo</td> 
   <td>Java Bean 元信息 API</td> 
  </tr> 
  <tr> 
   <td>java.beans.BeanDescriptor</td> 
   <td>Java Bean 信息描述符</td> 
  </tr> 
  <tr> 
   <td>java.beans.PropertyDescriptor</td> 
   <td>Java Bean 属性描述符</td> 
  </tr> 
  <tr> 
   <td>java.beans.MethodDescriptor</td> 
   <td>Java Bean 方法描述符</td> 
  </tr> 
  <tr> 
   <td>java.beans.EventSetDescriptor</td> 
   <td>Java Bean 事件集合描述符</td> 
  </tr> 
 </tbody> 
</table>

### 参考资料 ###

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

[b1e4f29b66a6e5499003a3e7927c016b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/720b786939f04a22a192c2e9afda1bb6.png
[a65fae99c9c3c33823a8fa69115d5d99.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/06/66e54289f4664a61af45665511eb29b6.png
[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