【小家Spring】聊聊Spring中的数据绑定 --- DataBinder本尊（源码分析）
每篇一句
惟有热爱和坚持，才能让你在程序人生中屹立不倒，切忌跟风什么语言或就学什么去~java
相关阅读
【小家Spring】聊聊Spring中的数据绑定 --- 属性访问器PropertyAccessor和实现类DirectFieldAccessor的使用【小家Spring】聊聊Spring中的数据绑定 --- BeanWrapper以及Java内省Introspector和PropertyDescriptorweb
Java高工、架构师3群（文末有二维码）
前言
数据绑定 这个概念在任何一个成型的框架中都是特别重要的（尤为是web框架），它能让框架更多的自动化，更好容错性以及更高的编码效率。它提供的能力是：把字符串形式的参数转换成服务端真正须要的类型的转换（固然可能还包含校验）。spring
对Spring中的数据绑定场景，小伙伴们就再熟悉不过了。好比咱们Controller中只须要使用Model对象就能完成request到Model对象的自动数据自动绑定，使用起来着实很是方便~（彻底屏蔽了Servlet的API）架构
既然数据绑定这么重要，可是为什么鲜有人提起呢？我也上网搜了搜关于DataBinder的相关资料，相对来讲仍是寥寥无几的~咱们不提起并不表明它不重要，这些都是Spring它帮咱们默默的干了。这也印证了那句名言嘛：咱们的安好是由于有人替咱们负重前行app
查到网上的资料，大都停留在如何使用WebDataBinder的说明上，而且几乎没有文章是专门分析核心部件DataBinder的，本文做为此方面的一股清流，在此把我结合官方文档、源码的所获分享给你们~框架
DataBinder
注意，此类所在的包是org.springframework.validation，因此可想而知，它不只仅完成数据的绑定，还会和数据校验有关~编辑器
注意：我看到有的文章说
DataBinder在绑定的时候还会进行数据校验Validation，其实这个是不许确的，容易误导人（校验动做不发生在DataBinder本类）ide还有说
DataBinder数据绑定最终依赖的是BeanWrapper，其实这个也是不许确的，实际上依赖的是PropertyAccessor。源码分析
DataBinder使用Demo
先看一个简单Demo，体验一把直接使用DataBinder进行数据绑定吧：ui
public static void main(String[] args) throws BindException {
Person person = new Person();
DataBinder binder = new DataBinder(person, "person");
MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("name", "fsx");
pvs.add("age", 18);
binder.bind(pvs);
Map<?, ?> close = binder.close();
System.out.println(person);
System.out.println(close);
}复制代码
输出：
Person{name='fsx', age=18}
{person=Person{name='fsx', age=18}, org.springframework.validation.BindingResult.person=org.springframework.validation.BeanPropertyBindingResult: 0 errors}复制代码
其实Spring一直是在弱化数据绑定对使用者的接触（这就是为什么鲜有人提起的缘由），因此以前博文也说到Spring并不推荐直接使用BeanWrapper去本身绑定数据（而是都让框架本身来完成吧~）。
BeanWrapper不推荐直接使用，可是DataBinder是一个更为成熟、完整些的数据绑定器，若实在有需求使用它是比使用BeanWrapper是个更好的选择~
其实直接使用顶层的
DataBinder也是通常不会的，而是使用它的子类。好比web包下大名鼎鼎的WebDataBinder~
源码分析
DataBinder的源码相对来讲仍是颇为复杂的，它提供的能力很是强大，也注定了它的方法很是多、属性也很是多。首先看看类声明：
public class DataBinder implements PropertyEditorRegistry, TypeConverter {}复制代码
它是个实现类，直接实现了PropertyEditorRegistry和TypeConverter 这两个接口，所以它能够注册java.beans.PropertyEditor，而且能完成类型转换（TypeConverter）。
关于数据转换这块内容，有兴趣的可参见：【小家Spring】聊聊Spring中的数据转换：Converter、ConversionService、TypeConverter、PropertyEditor
接下里分析具体源码（须要解释说明都写在源码处了）：
public class DataBinder implements PropertyEditorRegistry, TypeConverter {
/** Default object name used for binding: "target". */
public static final String DEFAULT_OBJECT_NAME = "target";
/** Default limit for array and collection growing: 256. */
public static final int DEFAULT_AUTO_GROW_COLLECTION_LIMIT = 256;
@Nullable
private final Object target;
private final String objectName; // 默认值是target
// BindingResult：绑定错误、失败的时候会放进这里来~
@Nullable
private AbstractPropertyBindingResult bindingResult;
//类型转换器，会注册最为经常使用的那么多类型转换Map<Class<?>, PropertyEditor> defaultEditors
@Nullable
private SimpleTypeConverter typeConverter;
// 默认忽略不能识别的字段~
private boolean ignoreUnknownFields = true;
// 不能忽略非法的字段（好比我要Integer，你给传aaa，那确定就不让绑定了，抛错）
private boolean ignoreInvalidFields = false;
// 默认是支持级联的~~~
private boolean autoGrowNestedPaths = true;
private int autoGrowCollectionLimit = DEFAULT_AUTO_GROW_COLLECTION_LIMIT;
// 这三个参数 均可以本身指定~~ 容许的字段、不容许的、必须的
@Nullable
private String[] allowedFields;
@Nullable
private String[] disallowedFields;
@Nullable
private String[] requiredFields;
// 转换器ConversionService
@Nullable
private ConversionService conversionService;
// 状态码处理器~
@Nullable
private MessageCodesResolver messageCodesResolver;
// 绑定出现错误的处理器~
private BindingErrorProcessor bindingErrorProcessor = new DefaultBindingErrorProcessor();
// 校验器（这个很是重要）
private final List<Validator> validators = new ArrayList<>();
// objectName没有指定，就用默认的
public DataBinder(@Nullable Object target) {
this(target, DEFAULT_OBJECT_NAME);
}
public DataBinder(@Nullable Object target, String objectName) {
this.target = ObjectUtils.unwrapOptional(target);
this.objectName = objectName;
}
... // 省略全部属性的get/set方法
// 提供一些列的初始化方法，供给子类使用 或者外部使用 下面两个初始化方法是互斥的
public void initBeanPropertyAccess() {
Assert.state(this.bindingResult == null, "DataBinder is already initialized - call initBeanPropertyAccess before other configuration methods");
this.bindingResult = createBeanPropertyBindingResult();
}
protected AbstractPropertyBindingResult createBeanPropertyBindingResult() {
BeanPropertyBindingResult result = new BeanPropertyBindingResult(getTarget(), getObjectName(), isAutoGrowNestedPaths(), getAutoGrowCollectionLimit());
if (this.conversionService != null) {
result.initConversion(this.conversionService);
}
if (this.messageCodesResolver != null) {
result.setMessageCodesResolver(this.messageCodesResolver);
}
return result;
}
// 你会发现，初始化DirectFieldAccess的时候，校验的也是bindingResult ~~~~
public void initDirectFieldAccess() {
Assert.state(this.bindingResult == null, "DataBinder is already initialized - call initDirectFieldAccess before other configuration methods");
this.bindingResult = createDirectFieldBindingResult();
}
protected AbstractPropertyBindingResult createDirectFieldBindingResult() {
DirectFieldBindingResult result = new DirectFieldBindingResult(getTarget(), getObjectName(), isAutoGrowNestedPaths());
if (this.conversionService != null) {
result.initConversion(this.conversionService);
}
if (this.messageCodesResolver != null) {
result.setMessageCodesResolver(this.messageCodesResolver);
}
return result;
}
...
// 把属性访问器返回，PropertyAccessor(默认直接从结果里拿)，子类MapDataBinder有复写
protected ConfigurablePropertyAccessor getPropertyAccessor() {
return getInternalBindingResult().getPropertyAccessor();
}
// 能够看到简单的转换器也是使用到了conversionService的，可见conversionService它的效用
protected SimpleTypeConverter getSimpleTypeConverter() {
if (this.typeConverter == null) {
this.typeConverter = new SimpleTypeConverter();
if (this.conversionService != null) {
this.typeConverter.setConversionService(this.conversionService);
}
}
return this.typeConverter;
}
... // 省略众多get方法
// 设置指定的能够绑定的字段，默认是全部字段~~~
// 例如，在绑定HTTP请求参数时，限制这一点以免恶意用户进行没必要要的修改。
// 简单的说：我能够控制只有指定的一些属性才容许你修改~~~~
// 注意：它支持xxx*,*xxx,*xxx*这样的通配符 支持[]这样子来写~
public void setAllowedFields(@Nullable String... allowedFields) {
this.allowedFields = PropertyAccessorUtils.canonicalPropertyNames(allowedFields);
}
public void setDisallowedFields(@Nullable String... disallowedFields) {
this.disallowedFields = PropertyAccessorUtils.canonicalPropertyNames(disallowedFields);
}
// 注册每一个绑定进程所必须的字段。
public void setRequiredFields(@Nullable String... requiredFields) {
this.requiredFields = PropertyAccessorUtils.canonicalPropertyNames(requiredFields);
if (logger.isDebugEnabled()) {
logger.debug("DataBinder requires binding of required fields [" + StringUtils.arrayToCommaDelimitedString(requiredFields) + "]");
}
}
...
// 注意：这个是set方法，后面是有add方法的~
// 注意：虽然是set，可是引用是木有变的~~~~
public void setValidator(@Nullable Validator validator) {
// 判断逻辑在下面：你的validator至少得支持这种类型呀 哈哈
assertValidators(validator);
// 由于本身手动设置了，因此先清空 再加进来~~~
// 这步你会发现，即便validator是null，也是会clear的哦~ 符合语意
this.validators.clear();
if (validator != null) {
this.validators.add(validator);
}
}
private void assertValidators(Validator... validators) {
Object target = getTarget();
for (Validator validator : validators) {
if (validator != null && (target != null && !validator.supports(target.getClass()))) {
throw new IllegalStateException("Invalid target for Validator [" + validator + "]: " + target);
}
}
}
public void addValidators(Validator... validators) {
assertValidators(validators);
this.validators.addAll(Arrays.asList(validators));
}
// 效果同set
public void replaceValidators(Validator... validators) {
assertValidators(validators);
this.validators.clear();
this.validators.addAll(Arrays.asList(validators));
}
// 返回一个，也就是primary默认的校验器
@Nullable
public Validator getValidator() {
return (!this.validators.isEmpty() ? this.validators.get(0) : null);
}
// 只读视图
public List<Validator> getValidators() {
return Collections.unmodifiableList(this.validators);
}
// since Spring 3.0
public void setConversionService(@Nullable ConversionService conversionService) {
Assert.state(this.conversionService == null, "DataBinder is already initialized with ConversionService");
this.conversionService = conversionService;
if (this.bindingResult != null && conversionService != null) {
this.bindingResult.initConversion(conversionService);
}
}
// =============下面它提供了很是多的addCustomFormatter()方法 注册进PropertyEditorRegistry里=====================
public void addCustomFormatter(Formatter<?> formatter);
public void addCustomFormatter(Formatter<?> formatter, String... fields);
public void addCustomFormatter(Formatter<?> formatter, Class<?>... fieldTypes);
// 实现接口方法
public void registerCustomEditor(Class<?> requiredType, PropertyEditor propertyEditor);
public void registerCustomEditor(@Nullable Class<?> requiredType, @Nullable String field, PropertyEditor propertyEditor);
...
// 实现接口方法
// 统一委托给持有的TypeConverter~~或者是getInternalBindingResult().getPropertyAccessor();这里面的
@Override
@Nullable
public <T> T convertIfNecessary(@Nullable Object value, @Nullable Class<T> requiredType,
@Nullable MethodParameter methodParam) throws TypeMismatchException {
return getTypeConverter().convertIfNecessary(value, requiredType, methodParam);
}
// ===========上面的方法都是开胃小菜，下面才是本类最重要的方法==============
// 该方法就是把提供的属性值们，绑定到目标对象target里去~~~
public void bind(PropertyValues pvs) {
MutablePropertyValues mpvs = (pvs instanceof MutablePropertyValues ? (MutablePropertyValues) pvs : new MutablePropertyValues(pvs));
doBind(mpvs);
}
// 此方法是protected的，子类WebDataBinder有复写~~~增强了一下
protected void doBind(MutablePropertyValues mpvs) {
// 前面两个check就不解释了，重点看看applyPropertyValues(mpvs)这个方法~
checkAllowedFields(mpvs);
checkRequiredFields(mpvs);
applyPropertyValues(mpvs);
}
// allowe容许的 而且仍是没有在disallowed里面的 这个字段就是被容许的
protected boolean isAllowed(String field) {
String[] allowed = getAllowedFields();
String[] disallowed = getDisallowedFields();
return ((ObjectUtils.isEmpty(allowed) || PatternMatchUtils.simpleMatch(allowed, field)) &&
(ObjectUtils.isEmpty(disallowed) || !PatternMatchUtils.simpleMatch(disallowed, field)));
}
...
// protected 方法，给target赋值~~~~
protected void applyPropertyValues(MutablePropertyValues mpvs) {
try {
// 能够看到最终赋值 是委托给PropertyAccessor去完成的
getPropertyAccessor().setPropertyValues(mpvs, isIgnoreUnknownFields(), isIgnoreInvalidFields());
// 抛出异常，交给BindingErrorProcessor一个个处理~~~
} catch (PropertyBatchUpdateException ex) {
for (PropertyAccessException pae : ex.getPropertyAccessExceptions()) {
getBindingErrorProcessor().processPropertyAccessException(pae, getInternalBindingResult());
}
}
}
// 执行校验，此处就和BindingResult 关联上了，校验失败的消息都会放进去（不是直接抛出异常哦~ ）
public void validate() {
Object target = getTarget();
Assert.state(target != null, "No target to validate");
BindingResult bindingResult = getBindingResult();
// 每一个Validator都会执行~~~~
for (Validator validator : getValidators()) {
validator.validate(target, bindingResult);
}
}
// 带有校验提示的校验器。SmartValidator
// @since 3.1
public void validate(Object... validationHints) { ... }
// 这一步也挺有意思：实际上就是如有错误，就抛出异常
// 若没错误 就把绑定的Model返回~~~(能够看到BindingResult里也能拿到最终值哦~~~)
// 此方法能够调用，但通常较少使用~
public Map<?, ?> close() throws BindException {
if (getBindingResult().hasErrors()) {
throw new BindException(getBindingResult());
}
return getBindingResult().getModel();
}
}复制代码
从源源码的分析中，大概能总结到DataBinder它提供了以下能力：
- 把属性值
PropertyValues绑定到target上（bind()方法，依赖于PropertyAccessor实现~） - 提供校验的能力：提供了public方法
validate()对各个属性使用Validator执行校验~ - 提供了注册属性编辑器（
PropertyEditor）和对类型进行转换的能力（TypeConverter）
总结
本文介绍了Spring用于数据绑定的最直接类DataBinder，它位于spring-context这个工程的org.springframework.validation包内，因此须要再次明确的是：它是Spring提供的能力而非web提供的~
虽然咱们DataBinder是Spring提供，但其实把它发扬光大是发生在Web环境，也就是大名鼎鼎的WebDataBinder，毕竟咱们知道通常只有进行web交互的时候，才会涉及到字符串 -> Java类型/对象的转换，这就是下个章节讲述的重中之重~
知识交流
若文章格式混乱，可点击：原文连接-原文连接-原文连接-原文连接-原文连接
==The last：若是以为本文对你有帮助，不妨点个赞呗。固然分享到你的朋友圈让更多小伙伴看到也是被做者本人许可的~==
**若对技术内容感兴趣能够加入wx群交流：`Java高工、架构师3群`。若群二维码失效，请加wx号：fsx641385712（或者扫描下方wx二维码）。而且备注："java入群" 字样，会手动邀请入群**
相关文章
- 1. 【小家Spring】聊聊Spring中的数据绑定 --- DataBinder本尊（源码分析）
- 2. 【小家Spring】聊聊Spring中的数据绑定 --- BeanWrapper以及内省Introspector和PropertyDescriptor
- 3. 聊聊spring boot tomcat jdbc pool的属性绑定
- 4. 聊聊Spring中的ConfigurationClassPostProcessor
- 5. b spring之数据绑定--Converter SPI & Filed Formatting & DataBinder
- 6. Spring MVC数据绑定(简单数据绑定)
- 7. Spring MVC 数据绑定流程分析
- 8. 聊聊spring security的帐户锁定
- 9. 【Spring】聊聊Spring的bean覆盖
- 10. 聊聊Spring家族中的那几百个注解
- 更多相关文章...
- • Spring中Bean的作用域 - Spring教程
- • ASP.NET Web Forms - 数据绑定 - ASP.NET 教程
- • Flink 数据传输及反压详解
- • 互联网组织的未来：剖析GitHub员工的任性之源
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
欢迎关注本站公众号,获取更多信息
相关文章
- 1. 【小家Spring】聊聊Spring中的数据绑定 --- DataBinder本尊（源码分析）
- 2. 【小家Spring】聊聊Spring中的数据绑定 --- BeanWrapper以及内省Introspector和PropertyDescriptor
- 3. 聊聊spring boot tomcat jdbc pool的属性绑定
- 4. 聊聊Spring中的ConfigurationClassPostProcessor
- 5. b spring之数据绑定--Converter SPI & Filed Formatting & DataBinder
- 6. Spring MVC数据绑定(简单数据绑定)
- 7. Spring MVC 数据绑定流程分析
- 8. 聊聊spring security的帐户锁定
- 9. 【Spring】聊聊Spring的bean覆盖
- 10. 聊聊Spring家族中的那几百个注解