Spring之PropertyEditor

概述PropertyEditor简介内置PropertyEditor自定义PropertyEditorCustomEditorConfigurerDate属性编辑自定义属性编辑器参考文献

概述

在 Spring 配置文件里，我们往往通过字面值为 Bean 各种类型的属性提供设置值：不管是 double 类型还是 int 类型，在配置文件中都应字符串类型的字面值。BeanWrapper 填充 Bean 属性时如何将这个字面值转换为对应的 double 或 int 等内部类型呢 ？我们可以隐约地感觉到一定有一个转换器在其中起作用，这个转换器就是属性编辑器。

“属性编辑器”这个名字可能 会让人误以为是一个带用户界面的输入器，其实属性编辑器不一定非得有用户界面，任何实现 java.beans.PropertyEditor 接口的类都是属性编辑器。属性编辑器的主要功能就是将外部的设置值转换为 JVM 内部的对应类型，所以属性编辑器其实就是一个类型转换器。

转回刚才说到的问题：BeanWrapper 填充属性时是如何进行属性编辑的？刚好上节 Spring IoC之BeanWrapper 讲述了关于 BeanWrapper 设置属性的过程，在最后设置属性值的时候，在 AbstractNestablePropertyAccessor 类中有这么一段代码：

valueToApply = 

该段代码就是获取 xml 文件中属性的设置值，继续往下看。

在 convertIfNecessary()方法中执行时会跳转到 TypeConverterDelegate 类中的 convertIfNecessary()方法，其中会涉及到 PropertyEditor 接口的实现类。关于 TypeConverterDelegate 类在 BeanWrapper 的构造方法中有提及到，那个时候就已经构建了关于当前 bean 对象的属性编辑器。关于 TypeConverterDelegate 类想要了解更多可以参看：SpringMVC类型转换器、属性编辑器PropertiesEditor源码分析CustomDateEditor源码分析TypeConverterDelegate源码分析

PropertyEditor简介

PropertyEditor 是属性编辑器的接口，它规定了将外部设置值转换为内部 JavaBean 属性值的转换接口方法。PropertyEditor 主要的接口方法说明如下：

• Object getValue() ：返回属性的当前值。基本类型被封装成对应的封装类实例；
• void setValue(Object newValue) ：设置属性的值，基本类型以封装类传入；
• String getAsText() ：将属性对象用一个字符串表示，以便外部的属性编辑器能以可视化的方式显示。缺省返回 null，表示该属性不能以字符串表示；
• void setAsText(String text) ：用一个字符串去更新属性的内部值，这个字符串一般从外部属性编辑器传入；
• String[] getTags() ：返回表示有效属性值的字符串数组（如boolean属性对应的有效Tag为true和false），以便属性编辑器能以下拉框的方式显示出来。缺省返回null，表示属性没有匹配的字符值有限集合；
• String getJavaInitializationString() ：为属性提供一个表示初始值的字符串，属性编辑器以此值作为属性的默认值。
• void paintValue(Graphics gfx,Rectangle box)：将值的表示形式绘制到屏幕空间的给定区域中。请注意，propertyEditor 负责自己进行剪切，以使其适合给定的矩形。如果 PropertyEditor 不接受绘画请求（请参见isPaintable），则此方法应为静默noop。给定的 Graphics 对象将具有父容器的默认字体，颜色等。PropertyEditor 可以更改图形属性，例如字体和颜色，并且不需要还原旧值。
• Component getCustomEditor()： PropertyEditor可以选择提供可编辑其属性值的完整自定义组件。PropertyEditor的责任是将自身连接到其编辑器Component本身，并通过触发PropertyChange事件来报告属性值更改。

可以看出 PropertyEditor 接口方法是内部属性值和外部设置值的沟通桥梁。此外，我们可以很容易地发现该接口的很多方法是专为 IDE 中的可视化属性编辑器提供的：如 getTags()、getJavaInitializationString()、paintValue()等。

简单的 PropertyEditor 可能仅支持 getAsText 和 setAsText 方法，而无需支持（例如）paintValue 或 getCustomEditor。更复杂的类型可能无法支持 getAsText 和 setAsText，但将支持 paintValue 和 getCustomEditor。

Java 为 PropertyEditor 提供了一个方便类：PropertyEditorSupport，该类实现了 PropertyEditor 接口并提供默认实现，一般情况下，用户可以通过扩展这个方便类设计自己的属性编辑器。

内置PropertyEditor

在 Spring IoC之BeanWrapper 一文中有提到关于 BeanWrapper 的使用场景，我们看一下当时构建 BeanWrapper 对象的方法。

最开始执行了 initBeanWrapper()方法，该方法用来配置一些必要数据，继续往下看。该方法具体实现在 AbstractBeanFactory 类中，定义如下：

该方法的功能是把容器中默认的 PropertyEditor 和注册到容器中的自定义 PropertyEditor 复制到 BeanWrapper中，来辅助构造子注入时的值转换操作以及为后面其它属性的注入值转换做准备，为什么要把这些 PropertyEditor复制到各个BeanWrapper中？因为 PropertyEditor 是单例模式，非线程安全的接口，每个 BeanWrapper 复制一份可以消除高并发下的状态同步开销。

关于那些内置 PropertyEditor 在哪里添加进去的，这里需要关注一下 PropertyEditorRegistrySupport 类，在该类中有一个 createDefaultEditors()方法，它会将一些必要的 PropertyEditor 提前加进去。

此外还内置了 一些 Resource 相关的 PropertyEditor，代码在 ResourceEditorRegistrar 类的registerCustomEditors 方法中：

PropertyEditorRegistrar registrar = (PropertyEditorRegistrar)var3.

具体实现在 ResourceEditorRegistrar 类中：

ResourceEditorRegistrar 是框架内置的一个 PropertyEditor 注册器，它是一个 BFPP，在ClasspathXmlApplicationContext 启动时就会把它添加到容器中。

在内置的 PropertyEditor 中有这么一个类 URLEditor，实际使用代码如下：

简单来说就是字符串和其他对象的类型转换器，通过 setAsText ()设置，再通过 getValue()获取转换值。

自定义PropertyEditor

当 Spring 内置的 PropertyEditor 无法满足我们的要求的时候，我们可以根据 Spring 提供的扩展机制来自定义 PropertyEditor，下面通过一个例子来介绍如何实现自定义的 PropertyEditor，这个 PropertyEditor 是一个时间相关的 Editor，它可以一个满足特定时间格式的字符串转换成日期对象。

CustomEditorConfigurer

在讲述案例前我们需要了解一下 org.springframework.beans.factory.config.CustomEditorConfigurer类， 通常，在使用容器之前在容器中注册一个属性编辑器。CustomEditorConfigurer类被实现为内置的 bean工厂后处理器，供您在实例化任何 bean 之前注册自定义属性编辑器。

该类有两种使用方式：

1、从Spring 2.0开始，推荐的用法是使用自定义 PropertyEditorRegistrar实现，这些实现又将给定的注册任何所需的编辑器实例 registry。每个 PropertyEditorRegistrar 可以注册任意数量的自定义编辑器。

2、通过 customEditors 属性注册 PropertyEditor 类， Spring 将为每次编辑尝试创建它们的新实例，例如：

注意：现在不鼓励通过 customEditors 属性注册 PropertyEditor Bean 实例，因为 PropertyEditor 是非线程安全的，因此对于每次编辑尝试，实例都必须同步。 这意味着在在高并发坏境下这里的同步会对应用的性能造成比较大的影响。所以这种方式是不推荐的，事实上这种方式已经被 Spring 打上 deprecated 标签了。如果您需要控制 PropertyEditor 的实例化过程，请使用 PropertyEditorRegistrar 进行注册。

Date属性编辑

首先定义一个 Boy 类，其中包含时间格式的属性：

定义一个 PropertyEditor，框架中提供了一个 PropertyEditor 基类 PropertyEditorSupport，直接继承这个类可以省去一部分代码，代码如下：

还需要定义一个 PropertyEditorRegistrar 实现类，它的职责是用来注册 PropertyEditor，而且可以注册任意数量的 PropertyEditor。

在注册器的 registerCustomEditors 方法中把 DateEditor 注册到容器中并且和 Date 类型绑定，要确保 DateEditor 对象时临时创建的对象而不是一个全局对象，否则一样可能会引发性能问题。把日期格式通过dateFormat 字段注入，需要注意的是先将注入的字符串转换为 DateEditor 中定义的 DateFormat 类型。

接着就需要配置 XML 文件，定义如下：

这种方式下，每个 BeanWrapper 都会注册不同的 PropertyEditor，不会有高并发下的性能问题，而且用法也比较灵活，所以 Spring 的推荐是通过 propertyEditorRegistrars 注入来完成 PropertyEditor 的自定义。

测试代码如下：

执行结果为：

Boy{name=

看到注入的属性被转换为 Date 类型填充到 Boy 对象中，也得到正确的输出结果，但是想了一个问题：如果我们要获取原值该怎么获取？只有通过 DateEditor 类中的 getAsText()方法才能获取到属性转换前的值，但是问题是获取不到 DateEditor 的实例对象。一番查看在 beanFactory 中看到一点有用信息，但是无法后续处理。

查了一些资料，发现通过 BeanWrapper 和 PropertyEditor 结合使用也能对属性进行转换，不过这已经不涉及到 XML 文件的使用。代码如下：

执行结果为：

Wed Jan 

如果有大佬了解上述提到的问题，请不吝赐教。

自定义属性编辑器

在 Spring bean之间的关系 一文中讲述了 bean 之间的几种关系，其中介绍的案例中的 Person 类中有个 Car 对象属性，在依赖和引用关系中都可以实现，接下来我们再介绍一种实现方式。

为 Car 类提供一个自定义的属性编辑器，然后通过字面值为 Person 的 car 属性提供配置值。

现在，我们来为 Car 编写一个自定义的属性编辑器，其代码如下所示：

CustomCarEditor 很简单，它仅覆盖 PropertyEditorSupport 类的 setAsText(String text) 方法，该方法负责将配置文件以字符串提供的字面值转换为 Car 对象。字面值采用逗号分隔的格式同时为 brand、maxSpeed、price 和 color属性值提供设置值，setAsText()方法解析这个字面值并生成对应的 Car 对象。由于我们并不需要将 Person 内部的 car 属性反显到属性编辑器中，因此不需要覆盖 getAsText()方法。

定义 XML 文件：

在①处，我们定义了用于注册自定义属性编辑器的 CustomEditorConfigurer，Spring 容器将通过反射机制自动调用这个 Bean。CustomEditorConfigurer 通过一个 Map 属性定义需要自动注册的自定义属性编辑器。在②处，我们为 Car 类型指定了对应属性编辑器 CustomCarEditor，注意键是属性类型，而值是对应的属性编辑器Bean，而不是属性编辑器的类名。

最精彩的部分当然是③处的配置，我们原来通过一个元素标签配置好 car Bean，然后在 person 的中通过 ref 引用 car Bean，但是现在我们直接通过 value 为 car 属性提供配置。BeanWrapper 在设置person 的car属性时，它将检索自定义属性编辑器的注册表，当发现 Car 属性类型拥有对应的属性编辑器 CustomCarEditor 时，它就会利用 CustomCarEditor 将"东风,299,5400,银色"转换为 Car 对象。

测试代码如下：

执行结果为：

调用Car类的无参构造函数
Person{name=

参考文献

https://www.cnblogs.com/Tony-Mu/articles/2565527.html

https://blog.csdn.net/pentiumchen/article/details/44026575

https://www.jianshu.com/p/aeb97395d9c5