Spring5参考指南: BeanWrapper和PropertyEditor

PropertyEditor

Spring使用PropertyEditor的概念来实现Object和String之间的转换。

比如你配置了一个时间对象，但是在配置上，你可能需要传入一个String，然后可以通过PropertyEditor来将其自动转换为时间类型。

在Spring中使用PropertyEditor的情况有如下几种：

• 通过使用PropertyEditor实现来设置bean的属性。当使用String作为在XML文件中声明的某个bean的属性值时，Spring（如果相应属性的setter有类参数）则使用ClassEditor尝试将参数解析为Class对象。

• 在Spring的MVC框架中解析HTTP请求参数是通过使用各种属性编辑器实现来完成的，这些实现可以手动绑定到CommandController的所有子类中。

Spring有内置的方便使用的PropertyEditor实现，他们都在org.springframework.beans.propertyeditors包里面，大多数都是通过BeanWrapperImpl来注册的。下表列出了Spring提供的多种PropertyEditor：

Spring使用java.beans.PropertyEditorManager为可能需要的属性编辑器设置搜索路径，如果标准JavaBeans基础结构与它们处理的类位于同一个包中，并且与该类具有相同的名称，并且附加了Editor，那么标准JavaBeans基础结构会自动发现PropertyEditor类（无需显式注册）。例如，可以具有以下类和包结构，这足以使SomethingEditor类被识别并用作某个类型化属性的属性编辑器。

如下面的目录结构：

com
  flydean
     beans
        ExoticType
        ExoticTypeEditor

下面是ExoticType和ExoticTypeEditor的定义：

@Data
public class ExoticType {

    private String name;

    public ExoticType(String name) {
        this.name = name;
    }
}

public class ExoticTypeEditor extends PropertyEditorSupport {

    public void setAsText(String text) {
        setValue(new ExoticType(text.toUpperCase()));
    }
}

除了自动注册之外，也可以使用CustomEditorConfigurer将新创建的PropertyEditor注册到ApplicationContext：

    <bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
        <property name="customEditors">
            <map>
                <entry key="com.flydean.beans.ExoticType" value="com.flydean.beans.ExoticTypeEditor"/>
            </map>
        </property>
    </bean>

你也可以使用标准的BeanInfo JavaBeans机制。下面的示例使用BeanInfo机制显式地用关联类的属性注册一个或多个PropertyEditor实例：

com
  flydean
     beans
        ExoticType
        ExoticTypeBeanInfo

以下引用的ExoticTypeBeanInfo类的Java源代码将CustomNumberEditor与ExoticType类的age属性关联起来：

public class ExoticTypeBeanInfo extends SimpleBeanInfo {

    public PropertyDescriptor[] getPropertyDescriptors() {
        try {
            final PropertyEditor numberPE = new CustomNumberEditor(Integer.class, true);
            PropertyDescriptor ageDescriptor = new PropertyDescriptor("age", ExoticType.class) {
                public PropertyEditor createPropertyEditor(Object bean) {
                    return numberPE;
                };
            };
            return new PropertyDescriptor[] { ageDescriptor };
        }
        catch (IntrospectionException ex) {
            throw new Error(ex.toString());
        }
    }
}

PropertyEditorRegistrar

另一种机制来注册属性编辑器到Spring容器的方法就是使用PropertyEditorRegistrar。

下面是使用的例子：

public final class CustomPropertyEditorRegistrar implements PropertyEditorRegistrar {

    public void registerCustomEditors(PropertyEditorRegistry registry) {

        @H_502_132@// it is expected that new PropertyEditor instances are created
        registry.registerCustomEditor(ExoticType.class, new ExoticTypeEditor());

        @H_502_132@// you could register as many custom property editors as are required here...
    }
}

下面是使用CustomEditorConfigurer的配置例子：

    <bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
        <property name="propertyEditorRegistrars">
            <list>
                <ref bean="customPropertyEditorRegistrar"/>
            </list>
        </property>
    </bean>

    <bean id="customPropertyEditorRegistrar"
          class="com.flydean.beans.CustomPropertyEditorRegistrar"/>

本节的例子可参考beanWrapper-propertyEditor
更多教程请参考flydean的博客

（编辑：北几岛）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!

@Data
public class Company {

    private String name;
    private Employee managingDirector;
}

@Data
public class Employee {

    private String name;

    private float salary;

}

public class BeanWrapperUsage {

    public static void main(String[] args) {
        BeanWrapper company = new BeanWrapperImpl(new Company());
        @H_502_132@// setting the company name..
        company.setPropertyValue("name", "Some Company Inc.");
        @H_502_132@// ... can also be done like this:
        PropertyValue value = new PropertyValue("name", "Some Company Inc.");
        company.setPropertyValue(value);

        @H_502_132@// ok,let's create the director and tie it to the company:
        BeanWrapper jim = new BeanWrapperImpl(new Employee());
        jim.setPropertyValue("name", "Jim Stravinsky");
        company.setPropertyValue("managingDirector", jim.getWrappedInstance());

        @H_502_132@// retrieving the salary of the managingDirector through the company
        Float salary = (Float) company.getPropertyValue("managingDirector.salary");
    }
}