夯实Spring系列|第十九章：Spring 数据绑定（Data Binding）

最新推荐文章于 2021-10-11 23:07:14 发布
最新推荐文章于 2021-10-11 23:07:14 发布
阅读量1.3k 收藏 9
点赞数 1
分类专栏： Spring系列 文章标签： spring 数据绑定 Data Binding
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiewenfeng520/article/details/106979296
版权

文章目录

夯实Spring系列|第十九章：Spring 数据绑定（Data Binding）

1.项目环境

2.Spring 数据绑定使用场景

Spring BeanDefinition 到 Bean 实例创建

Spring 数据绑定（DataBinder）

Spring Web 参数绑定（WebDataBinder）

3.Spring 数据绑定组件

标准组件

  • org.springframework.validation.DataBinder

Web 组件

  • org.springframework.web.bind.ServletRequestDataBinder
  • org.springframework.web.bind.WebDataBinder
  • org.springframework.web.bind.support.WebExchangeDataBinder - @since 5.0
  • org.springframework.web.bind.support.WebRequestDataBinder

DataBinder 核心属性

属性说明
target关联目标 Bean
objectName目标 Bean 名称
bindingResult属性绑定结果
typeConverter类型转换器
conversionService类型转换服务
messageCodesResolver效验错误文案 Code 处理器
validators关联的 Bean Validator 实例集合

DataBinder 绑定方法

  • bind(PropertyValues)：将 PropertyValue Key-Value 内容映射到关联的 Bean（target）中的属性上
    • 假设 PropertyValues 中包含 name = 小马哥 的键值对，同时 User 对象中存在 name 属性，当 bind 方法执行时，User 对象中的 name 属性值将被绑定为 小马哥。

4.Spring 数据绑定元数据

DataBinder 元数据 - PropertyValues

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

4.1 PropertyValues 来源

通常来源于 XML 资源配置 BeanDefinition，因为 @Bean 或者其他编程方式，属性值可以直接使用，并不需要使用 PropertyValues 来进行转换。

通过 org.springframework.beans.factory.config.BeanDefinition#getPropertyValues 来获取。

5.Spring 数据绑定控制参数

5.1 DataBinder 绑定特殊场景分析

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

示例

/**
 * {@link DataBinder} 示例
 *
 * @see DataBinder
 */
public class DataBinderDemo {
    public static void main(String[] args) {
        User user = new User();
        DataBinder dataBinder = new DataBinder(user, "user");

        MutablePropertyValues mpvs = new MutablePropertyValues();

        mpvs.add("id", "1")
                .add("name", "xwf")
                // 添加一个不存在的属性值
                // DataBinder 忽略未知属性
                .add("otherName", "xwf")
                // 嵌套属性
                .add("company.name", "阿里");

        dataBinder.bind(mpvs);
        System.out.println(user);
    }
}

新增 Company 类

public class Company {

    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Company{" +
                "name='" + name + '\'' +
                '}';
    }
}

将属性增加到 User 类中，并新增 setter/getter 方法，重写 toString 方法。

执行结果：

User{id=1, name='xwf', age=null, configFileReource=null, city=null, cities=null, lifeCities=null, company=Company{name='阿里'}}

由结果可以得到两个结论

1.添加一个不存在的属性值，DataBinder 忽略未知属性

2.DataBinder 支持嵌套属性

5.2 DataBinder 绑定控制参数

参数名称说明
ignoreUnknownFields是否忽略未知字段，默认值：true
ignoreInvalidFields是否忽略非法字段，默认值：false
autoGrowNestedPaths是否自动增加嵌套路径，默认值：true
allowedFields绑定字段白名单
disallowedFields绑定字段黑名单
requiredFields必须绑定字段
5.2.1 ignoreUnknownFields
public class DataBinderDemo {
    public static void main(String[] args) {
        User user = new User();
        DataBinder dataBinder = new DataBinder(user, "user");

        MutablePropertyValues mpvs = new MutablePropertyValues();

        mpvs.add("id", "1")
                .add("name", "xwf")
                // 添加一个不存在的属性值
                // DataBinder 忽略未知属性
                .add("otherName", "xwf")
                // 嵌套属性
                .add("company.name", "阿里");

        // 1.ignoreUnknownFields true(默认) -> false
        dataBinder.setIgnoreUnknownFields(false);

        dataBinder.bind(mpvs);
        // 输出
        System.out.println(user);
    }
}

执行结果：

Exception in thread "main" org.springframework.beans.NotWritablePropertyException: Invalid property 'otherName' of bean class [com.huajie.thinking.in.spring.ioc.overview.domain.User]: Bean property 'otherName' is not writable or has an invalid setter method. Does the parameter type of the setter match the return type of the getter?

结论：如果设置 ignoreUnknownFields 为false，绑定的字段不存在，抛出异常 NotWritablePropertyException

5.2.2 autoGrowNestedPaths
public class DataBinderDemo {
    public static void main(String[] args) {
        User user = new User();
        DataBinder dataBinder = new DataBinder(user, "user");

        MutablePropertyValues mpvs = new MutablePropertyValues();

        mpvs.add("id", "1")
                .add("name", "xwf")
                // 添加一个不存在的属性值
                // DataBinder 忽略未知属性
                .add("otherName", "xwf")
                // 嵌套属性
                .add("company.name", "阿里");

        // 1.ignoreUnknownFields true(默认) -> false
//        dataBinder.setIgnoreUnknownFields(false);

        // 2.autoGrowNestedPaths true(默认) -> false
        dataBinder.setAutoGrowNestedPaths(false);
        
        dataBinder.bind(mpvs);
        // 输出
        System.out.println(user);
    }
}

执行结果：

Exception in thread "main" org.springframework.beans.NullValueInNestedPathException: Invalid property 'company' of bean class [com.huajie.thinking.in.spring.ioc.overview.domain.User]: Value of nested property 'company' is null

设置 autoGrowNestedPaths 为 false 不支持嵌套属性。

5.2.3 ignoreInvalidFields

ignoreInvalidFields 属性设置为 true，可以忽略 5.2.2 中的错误，但是相应出错的属性也不会设置

public class DataBinderDemo {
    public static void main(String[] args) {
        User user = new User();
        DataBinder dataBinder = new DataBinder(user, "user");

        MutablePropertyValues mpvs = new MutablePropertyValues();

        mpvs.add("id", "1")
                .add("name", "xwf")
                // 添加一个不存在的属性值
                // DataBinder 忽略未知属性
                .add("otherName", "xwf")
                // 嵌套属性
                .add("company.name", "阿里");

        // 1.ignoreUnknownFields true(默认) -> false
//        dataBinder.setIgnoreUnknownFields(false);

        // 2.autoGrowNestedPaths true(默认) -> false
        dataBinder.setAutoGrowNestedPaths(false);

        // 3.ignoreInvalidFields false(默认) -> true
        dataBinder.setIgnoreInvalidFields(true);

        dataBinder.bind(mpvs);
        // 输出
        System.out.println(user);
    }
}

执行结果：

User{id=1, name='xwf', age=null, configFileReource=null, city=null, cities=null, lifeCities=null, company=null}
5.2.4 requiredFields
  • 错误信息需要通过 dataBinder.getBindingResult(); 获取，不会报错
public class DataBinderDemo {
    public static void main(String[] args) {
        User user = new User();
        DataBinder dataBinder = new DataBinder(user, "user");

        MutablePropertyValues mpvs = new MutablePropertyValues();

        mpvs.add("id", "1")
                .add("name", "xwf")
                // 添加一个不存在的属性值
                // DataBinder 忽略未知属性
                .add("otherName", "xwf")
                // 嵌套属性
                .add("company.name", "阿里");

        // 1.ignoreUnknownFields true(默认) -> false
//        dataBinder.setIgnoreUnknownFields(false);

        // 2.autoGrowNestedPaths true(默认) -> false
        dataBinder.setAutoGrowNestedPaths(false);

        // 3.ignoreInvalidFields false(默认) -> true
        dataBinder.setIgnoreInvalidFields(true);

        // 4.requiredFields 设置不能为空的字段
        dataBinder.setRequiredFields("id","name","age");

        dataBinder.bind(mpvs);
        // 输出
        System.out.println(user);
        // 绑定结果(结果包含了错误文案信息，但是不会报错)
        BindingResult bindingResult = dataBinder.getBindingResult();
        System.out.println(bindingResult);

    }
}

执行结果：

User{id=1, name='xwf', age=null, configFileReource=null, city=null, cities=null, lifeCities=null, company=null}
org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'user' on field 'age': rejected value []; codes [required.user.age,required.age,required.java.lang.Integer,required]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age]]; default message [Field 'age' is required]
5.2.5 allowedFields

相关设置

dataBinder.setAllowedFields("id");//表示只允许 id 字段进行绑定

执行结果：

User{id=1, name='null', age=null, configFileReource=null, city=null, cities=null, lifeCities=null, company=null}
5.2.6 disallowedFields

相关设置

dataBinder.setDisallowedFields("id");//表示不允许 id 字段进行绑定

执行结果：

User{id=null, name='xwf', age=null, configFileReource=null, city=null, cities=null, lifeCities=null, company=null}

6.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）

7.BeanWrapper 的使用场景

BeanWrapper

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

BeanWrapper 接口源码中相关的方法

  • setAutoGrowCollectionLimit

    • org.springframework.beans.AbstractNestablePropertyAccessor 中

      private int autoGrowCollectionLimit = Integer.MAX_VALUE;

      默认实现中这个值是无限制的，表示支持无线的嵌套路径

  • getWrappedInstance 获取 Bean 的实例，在 IoC 场景下的 BeanWrapper 是和 Bean 关联的

  • getWrappedClass 获取 Bean 的 Class

  • getPropertyDescriptors 获取所有属性的描述信息

  • getPropertyDescriptor 获取单个属性的描述信息

8.JavaBeans

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

API说明
java.beans.IntrospectorJava Beans 内省 API
java.beans.BeanInfoJava Bean 元信息 API
java.beans.BeanDescriptorJava Bean 信息描述符
java.beans.PropertyDescriptorJava Bean 属性描述符
java.beans.MethodDescriptorJava Bean 方法描述符
java.beans.EventSetDescriptorJava Bean 事件集合描述符

简单示例

/**
 * JavaBeans 示例
 */
public class JavaBeansDemo {
    public static void main(String[] args) throws IntrospectionException {
        // stopClass 排除类
        BeanInfo beanInfo = Introspector.getBeanInfo(User.class,Object.class);

        Stream.of(beanInfo.getPropertyDescriptors()).forEach(propertyDescriptor -> {
            System.out.println(propertyDescriptor);
        });

        Stream.of(beanInfo.getMethodDescriptors()).forEach(System.out::println);
    }
}

9.DataBinder 与 BeanWrapper 关系

  • bind 方法生成 BeanPropertyBindingResult
  • BeanPropertyBindingResult 关联 BeanWrappper

源码调用链路

org.springframework.validation.DataBinder#bind

  • org.springframework.validation.DataBinder#doBind
    • org.springframework.validation.DataBinder#applyPropertyValues
      • org.springframework.validation.DataBinder#getPropertyAccessor
        • org.springframework.validation.BeanPropertyBindingResult#getPropertyAccessor
          • org.springframework.validation.BeanPropertyBindingResult#createBeanWrapper

由上面调用链路可以知道当调用 DataBinder#bind 方法时，默认会创建 BeanWrapper 对象，此对象和 BeanPropertyBindingResult 进行关联。

10.面试

10.1 Spring 数据绑定 API 是什么？

  • org.springframework.validation.DataBinder

  • org.springframework.validation.BeanPropertyBindingResult

10.2 BeanWrapper 与 JavaBeans 之间关系是？

  • Spring 底层 JavaBeans 基础设施的中心化接口
  • BeanWrapper 有且仅有一个实现类 BeanWrapperImpl，BeanWrapperImpl 底层的一些实现是基于 JavaBeans 进行的二次封装

11.参考

  • 极客时间-小马哥《小马哥讲Spring核心编程思想》
不懂的浪漫
关注
  • 1
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring MVC 学习笔记 十一 data binding
03-24
工程文件 博文链接：https://starscream.iteye.com/blog/1072179
android-recyclerview-binding:RecyclerView +数据绑定+ LiveData示例
04-28
RecyclerView +数据绑定示例简单样本直接将LiveData与数据绑定一起使用<? xml version = " 1.0 " encoding = " utf-8 " ?>< layout xss=removed xss=removed> < data> < variable xss=removed xss=removed> &...
Spring MVC 学习笔记 data binding
weixin_30663471的博客
02-18 95
Spring MVC 学习笔记 data binding Servlet中的输入参数为都是string类型，而spring mvc通过data bind机制将这些string 类型的输入参数转换为相应的command object（根据view和controller之间传输数据的具体逻辑，也可称为model attributes, domai...
springmvc 中的data bind机制
weixin_33843947的博客
11-19 280
为什么80%的码农都做不了架构师？>>> ...
Spring --- Data Binding
htht1的博客
12-10 107
[b]一） BeanWrapper[/b] BeanWrapper这个类一般不会被Spring的使用者直接调用，而是使用DataBinder和BeanFactory这两个类是间接被调用的。但是知道BeanWrapper的使用方式对于理解Spring的数据绑定机制还是十分用益的。下面我们就来看个BeanWrapper被直接调用的例子： [code="java"]//首先是两个对象类Compa...
Spring数据绑定
weixin_45968443的博客
06-04 509
数据绑定 文章目录数据绑定2 # 学习目标 ![在这里插入图片描述](https://img-blog.csdnimg.cn/20210602140605419.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTk2ODQ0Mw==,size_16,color_FFFFFF,t_70) 2 ...
Spring MVC数据绑定概述及原理详解
08-18
以下是对Spring MVC数据绑定的深入解释： **数据绑定概述** 在Spring MVC中，数据绑定是通过`DataBinder`组件实现的。当一个HTTP请求到达控制器方法时，Spring MVC会自动创建一个`DataBinder`实例，并使用`...
Android Data Binding数据绑定详解
09-01
Android Data Binding是Google推出的一种强大的数据绑定框架，它旨在简化Android应用中的UI逻辑，通过将数据绑定到XML布局文件中，极大地减少了Java代码中的 findViewById 和手动设置视图内容的步骤，降低了代码的...
zepto-data-binding:提供 Javascript 数据绑定的 Zepto.js 插件
07-11
用于数据绑定的 Zepto 插件请注意，此库从未经过适当测试，并且确实包含错误。 随意修复和提交拉取请求，或者提交它们，我会在有时间时修复。 插件，提供 DOM 元素和 Javascript 对象之间的 Javascript 数据绑定。 ...
data-binding:javascript 数据绑定
07-17
nanoplex 数据绑定 #expressions 将变量、函数和对象绑定到属性和内部元素 用法 attr="{{var}}" {{var}} {{func(var)}} {{object.path.string}} 例子 {{function(var, var1)}} {{object.string}} #events 将函数...
SpringMVC之DataBinding和Validation--Validator,PropertyEditor,Converter,Formatter
04-12
NULL 博文链接：https://b-l-east.iteye.com/blog/1705872
Data-Binding:Android数据绑定演示示例
05-01
在Android开发中，数据绑定（Data Binding）是一个强大的框架，它允许开发者更加直观地将UI组件与数据模型关联起来，从而实现视图和数据模型之间的双向绑定。这个框架简化了事件处理，减少了样板代码，并提高了代码...
data-binding-samples:谷歌新数据绑定示例
06-02
数据绑定示例 谷歌新数据绑定库的示例### 简单数据绑定 < data> </ data> < TextView android : text = " @{Strin
Android数据绑定Data Binding
12-23
在Android开发中，数据绑定（Data Binding）是一个强大的框架，它允许开发者更加直观地将UI组件与业务数据关联起来，从而简化代码并提高可维护性。这个Demo程序旨在展示数据绑定和事件绑定的基本用法，帮助开发者...
data-dom-binding:数据到 DOM 绑定，使用 Muxjs
06-28
数据到DOM绑定是一种编程技术，它允许我们动态地更新用户界面（UI）以反映应用程序的数据模型的变化，反之亦然。这种技术在现代Web开发中至关重要，因为它极大地简化了UI与后端数据之间的交互。Muxjs是一个...
Spring(十一)--Spring数据绑定
Xjzzon的博客
10-11 365
Spring数据绑定使用场景 Spring BeanDefinition到Bean实例创建 Spring数据绑定 SpringWeb参数绑定 Spring数据绑定组件 标准组件: org.springframework.validation.DataBinder Web组件 1.org.springframework.web.bind.WebDataBinder 2.org.springframework.web.bindServletRequestDataBinder 3.org.springfr
Spring MVC Data Binding
路漫漫其修远兮，吾将上下而求索！
10-18 2081
在执行程序时，Spring MVC 会根据客户端请求参数的不同，将请求消息中的信息以一定的方式转换并绑定到控制器类的方法参数中。这种将请求数据与后台方法参数建立连接的过程就是 Spring MVC 中的数据绑定。在数据绑定中，Spring MVC 会通过数据绑定组件（DataBinder）将请求参数串的内容进行类型转换，然后将转换后的值赋值给控制器类中方法的形参。
Spring MVC 3.0实战：数据绑定与转换校验机制解析
"本资源是关于Spring MVC 3.0实战的指南，涵盖了数据绑定机制、ConversionService、Validator、BindingResult、ServletRequest等关键概念，并讨论了处理方法的签名、数据类型转换/格式化以及数据校验。" 在Spring ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值