浅谈Spring的属性编辑器的使用

在 spring 配置文件中，我们往往通过字面值设置 bean 各种类型的属性值 ，这个功能是通过属性编辑器实现的。

任何实现了 java.beans.propertyeditor 接口的类都是属性编辑器 。 它可以将外部需要设置的值转换为 jvm 内部的对应类型，所以属性编辑器其实就是一个类型转换器 。

1 javabean 编辑器

sun 所制定的 javabean 编辑器，很大程度上是为 ide 准备的。它让 ide 能够以可视化的方式来设置 javabean 的属性 。

java 通过 java.beans.propertyeditor 定义了设置 javabean 属性的方法，通过 beaninfo 描述了 javabean 哪些属性是可定制的，此外还描述了可定制属性与 propertyeditor 之间的对应关系 。

beaninfo 与 javabean 之间的对应关系，通过两者之间规范的命名确立，对应 javabean 的 beaninfo 采用如下命名规范：<bean>beaninfo。 如 bookbean 对应的 beaninfo 为 bookbeanbeaninfo。 当 javabean 连同其属性编辑器注册到 ide 后，当在开发界面中对 javabean 进行定制时， ide 就会根据 javabean 规范找到对应的 beaninfo ，然后再根据 beaninfo 中的描述信息找到 javabean 属性描述（使用哪个属性编辑器等），进而为 javabean 生成特定开发编辑界面 。

java 提供了一个用于管理默认属性编辑器的管理器： propertyeditormanager ，它保存着一些常见类型的属性编辑器，如果某个 javabean 的常见类型属性没有通过 beaninfo 显式指定它的属性编辑器， 那么 ide 将自动使用 propertyeditormanager 中注册的对应属性的默认编辑器 。

1.1 属性编辑器（propertyeditor）
propertyeditor 是属性编辑器接口，它定义了将外部设置值转换为内部 javabean 属性值的接口方法 。主要接口方法说明如下：

方法	说明
object getvalue()	返回属性的当前值 ，基本类型被封装成对应的包装类型
void setvalue(object newvalue)	设置属性的值，基本类型以包装类型传入
string getastext()	用字符串来表示属性对象，以便外部的属性编辑器能够以可视化的方式显示 。 默认返回 null ，表示该属性不能以字符串表示。
void setastext(string text)	用一个字符串去更新属性的内部值，它一般从外部属性编辑器传入的。
string[] gettags()	返回表示有效属性值的字符串数组，以便属性编辑器能够以下拉框的方式进行展示 。 默认返回 null。
string getjavainitializationstring()	为属性提供初始值，属性编辑器以此值作为属性的默认值 。

propertyeditor 接口是内部属性值和外部设置值的沟通桥梁 。

java 为 propertyeditor 提供了一个方便的实现类： propertyeditorsupport ，该类实现了 propertyeditor 接口，我们可以通过扩展这个类来设计自己的属性编辑器 。

1.2 bean 属性描述（beaninfo）

beaninfo 描述了 javabean 中的可编辑属性以及对应的属性编辑器，每一个属性对应一个属性描述器 propertydescriptor。

propertydescriptor 的构造函数有两个入参： propertydescriptor(string propertyname, class beanclass) ，其中 propertyname 为属性名； beanclass 是 javabean 所对应的 class。

propertydescriptor 还有一个 setpropertyeditorclass(class propertyeditorclass) 方法，它可以为 javabean 属性指定编辑器 。

beaninfo 接口中最重要的方法是：propertydescriptor[] getpropertydescriptors() ，它会返回 javabean 的属性描述器数组 。

beaninfo 接口的一个常用的实现类是 simplebeaninfo ，我们可以通过扩展这个类来实现自定义的功能 。

2 spring 默认属性编辑器

spring 的属性编辑器与传统的用于 ide 开发的属性编辑器不同，它没有 ui 界面，只是将配置文件中的文本配置值转换为 bean 属性的对应值 。

spring 在 propertyeditorregistrysupport 中为常见的属性类型提供了默认属性编辑器，分为 3 大类，共有 32 个：

类型	说明
基础数据类型	【1】基本数据类型，如： boolean、int 等； 【2】基本数据类型封装类，如： boolean、integer 等； 【3】基本数据类型数组： char[] 和 byte[] ； 【4】大数： bigdecimal 和 biginteger 。
集合类	collection、set、sortedset、list 和 sortedmap。
资源类	class、class[]、file、inputstream、locale、properties、resource[] 和 url。

propertyeditorregistrysupport 中有两个用于保存属性编辑器的 map 类型变量：

变量名	说明
defaulteditors	保存默认属性类型的编辑器，元素的键为属性类型，值为对应的属性编辑器实例。
customeditors	保存用户自定义的属性编辑器，元素的键值和 defaulteditors 相同 。

3 自定义 spring 属性编辑器

如果我们的应用定义了特殊类型的属性，并且希望在配置文件中以字面值方式来配置属性值，那么就可以编写自定义属性编辑器并注册到 spring 容器的方式来实现。

spring 默认的属性编辑器大都扩展自 java.beans.propertyeditorsupport，我们可以通过扩展 propertyeditorsupport 来自定义属性编辑器 。在spring 环境下仅需要将配置文件中字面值转换为属性类型的对象即可，并不需要提供 ui 界面，所以仅需要覆盖 propertyeditorsupport 的 setastext() 方法就可以啦 (∩_∩)o哈哈~。

假设我们有两个实体 book 和 author，希望在配置 book 时，可以直接设置 author 的名字。

book.java

public class book {
 /**
  * 作者
  */
 private author author;
 /**
  * 书名
  */
 private string name;
 //省略 get/setter 方法
}

author.java

public class author {
 private string name;
 //省略 get/setter 方法
}

首先，自定义 author 的属性编辑器：

public class custompropertyeditor extends propertyeditorsupport {
 @override
 public void setastext(string text) throws illegalargumentexception {
  if(text==null||text.length()==0){
   throw new illegalargumentexception("格式错误");
  }
  author author=new author();
  author.setname(text);
  //调用父类的方法，来设置属性对象
  setvalue(author);
 }
}

如果使用 beanfactory ，则需要手工调用 registercustomeditor(class requiredtype, propertyeditor propertyeditor) 方法注册自定义属性编辑器；如果使用的是 applicationcontext ，那么只需要在配置文件中注册 customeditorconfigurer 即可 。customeditorconfigurer 实现了beanfactorypostprocessor 接口，所以它是一个 bean 的工厂后处理器 。

现在注册自定义的属性编辑器：

<!-- 注册自定义的属性编辑器-->
<bean class="org.springframework.beans.factory.config.customeditorconfigurer">
 <property name="customeditors">
  <map>
   <!-- key：属性类型；value：属性编辑器-->
   <entry key="net.deniro.spring4.editor.author"
     value="net.deniro.spring4.editor.custompropertyeditor"
     />
  </map>
 </property>
</bean>

<bean id="book" class="net.deniro.spring4.editor.book">
 <property name="name" value="海边的卡夫卡"/>
 <!-- 使用之前定义的编辑器注入该属性-->
 <property name="author" value="村上春树"/>
</bean>

beanwrapper 在设置 book 的 author 属性时，将检索自定义属性编辑器注册表，当发现 author 属性类型所对应的属性编辑器 custompropertyeditor 时，它就会这个定制的属性编辑器把 "村上春树" 转换为 author 对象 。

按照规范， java 会在 javabean 的相同类包下查找是否存在 <javabean>editor 的类；如果存在，就会自动使用 <javabean>editor作为该 javabean 的属性编辑器 。spring 也支持这个规范。

所以如果在类包下有一个名为 authoreditor 属性编辑器类，那么就无须在配置文件中注册自定义的属性编辑器啦o(∩_∩)o哈哈~

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。