假如这个世界上只剩下你一个人，当你正坐在屋子里的时候，这时突然响起了敲门声...

在Spring2.5中定制自己的属性编辑器

上一篇 / 下一篇 2008-05-07 14:00:48

查看( 81 ) / 评论( 0 )

本文为原创，如需转载，请注明作者和出处，谢谢！

装配Bean是Spring的一个非常重要的功能。我们可以通过Spring在XML文件中配置Java Bean，然后通过ApplicationContext来获得Bean的对象实例。在配置Bean时，需要对构造方法的参数，属性进行初始化。对于Java简单类型或简单类型的List、Map等数据类型初始化非常简单，如下面就是一个对简单类型属性和构造方法参数进行初始化的配置代码：

<bean id="my" class="bean.MyClass" scope="prototype">
<constructor-arg>
      <value>my value1</value>
</constructor-arg>
<property name="name">
<value>皮球</value>
</property>
<property name="myList">
      <list>
      <value>value1</value>
      <value>value2</value>
</list>
</property>
</bean>

但对于复杂类型的属性或参数，如一个属性的类型是另外一个Java Class，这样就必须在配置文件中再声明这个Java Class，如果这种情况很多时，或是我们做的类要release时，就会给开发人员增加很多工作量。让我们先来举个例子。假设有两个类：Contact和PhoneNumber，Contact的phoneNumber属性的类型是PhoneNumber，代码如下：

Contact类

package bean;

public class Contact
{
private PhoneNumber phoneNumber;
public PhoneNumber getPhoneNumber()
{
return phoneNumber;
}
public void setPhoneNumber(PhoneNumber phoneNumber)
{
this.phoneNumber = phoneNumber;
}
}

PhoneNumber类

package bean;

public class PhoneNumber
{
private String number;
public PhoneNumber(String s)
{
this.number = s;
}
public String getNumber()
{
return number;
}
}

如果直接在XML配置文件中装配Contact类，就需要先装配PhoneNumber类，代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.0.xsd">

<bean id="contact" class="bean.Contact">
<property name="phoneNumber">
<ref bean="phoneNumber"/>
</property>
</bean>
<bean id="phoneNumber" class="bean.PhoneNumber">
<constructor-arg>
<value>12345678</value>
</constructor-arg>
</bean>
</beans>

从上面的代码中可以看到，装载Contact的同时，也装载了PhoneNumber。但如果使用了属性编辑器，就可以无需装载PhoneNumber就可以装载Contact了。
编写自己的属性编辑器的步骤很简单，属性编辑器类需要从java.beans.PropertyEditorSupport类继承，在这个类中有一个setAsText方法，这个方法有一个String类型的参数，通过这个方法，可以将String类型的参数值转换成其他类型的属性。在这个方法中我们还需要使用一个setValue方法，就来指定转换后的对象实例。好，现在我们来实现这个简单的编辑器类，代码如下：

package editor;

public class PhoneEditor extends java.beans.PropertyEditorSupport
{
@Override
public void setAsText(String text) throws IllegalArgumentException
{
setValue(new bean.PhoneNumber(text));
}
}

这个类的代码非常简单，在setAsText方法中只有一行代码，实际上只是建立一个PhoneNumber对象实例，并将text属性值作为参数值传入PhoneNumber的构造方法。接下来我们在配置文件中安装这个属性编辑器（实际上是装配org.springframework.beans.factory.config.CustomEditorConfigurer类），代码如下：

<bean id="customerEditor"
class="org.springframework.beans.factory.config.CustomEditorConfigurer">
<property name="customEditors">
<map>
<entry key="bean.PhoneNumber">
<bean id="phoneEditor" class="editor.PhoneEditor"/>
</entry>
</map>
</property>
</bean>

从上面的代码可以看出，属性编辑器是使用了CustomEditorConfigurer的customEditors属性进行安装的。这是一个Map类型的属性。key的值必须是属性编辑器最终转换后的类型名，如在本例中，要将文本的参数值转换成bean.PhoneNumber类型的值，因此，key必须为bean.PhoneNumber。  下面我们来使用PhoneEditor属性编辑器类来装配Contact类，代码如下：

<bean id="contact" class="bean.Contact">
<property name="phoneNumber">
<value>87654321</value>
</property>
</bean>

也许大家都注意到了上面这段代码的变化，在设置phoneNumber属性默认值时，不再使用<ref>标签来引用phoneNumber对象，而是直接使用了<value>来设置一个文本的电话号。Spring当遇到这种情况时，也就是说，某个属性值和属性类型不一致时（如本例中一个是文本，一个是PhoneNumber类型），会先找一下属性类型是否有相应的属性编辑器已经被安装，在本例中将以bean.PhoneNumber作为key来查找，正好找到上面安装的PhoneEditor，因此，Spring就会调用PhoneEditor类中的setAsValue方法来设置PhoneNumber对象实例，然后Spring在内部又分调用getValue来获得PhoneNumber对象实例，并将其赋给Contact的phoneNumber属性。其实所有类型的bean.PhoneNumber的属性都可以使用这个属性编辑器。
大家可以看看，这样做是不是简单的多！尤其是在发布通用的framework或程序时，就更为简单了。在Spring中已经定义了很多这种属性编辑器，如我们可以使用org.springframework.beans.propertyeditors.URLEditor将字符串映射成java.net.URL对象。

下面的代码通过ApplicationContext来获得Contact的对象实例，并输出其phoneNumber属性值：

import org.springframework.context.*;
import org.springframework.context.support.*;
public class Test
{

public static void main(String[] args)
{

ApplicationContext context = new
FileSystemXmlApplicationContext("src\applicationContext.xml");

bean.Contact contact = (bean.Contact) context.getBean("contact");
System.out.println(contact.getPhoneNumber().getNumber());

}

}

注：实际上，属性编辑器本身是由Java提供了，Spring只是利用了这一特性使装配一个Bean更容易而已。