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

2023-09-12 15:14:05 127

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

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

1JavaBean编辑器

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

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

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

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

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

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

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

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

1.2Bean属性描述（BeanInfo）

BeanInfo描述了JavaBean中的可编辑属性以及对应的属性编辑器，每一个属性对应一个属性描述器PropertyDescriptor。

PropertyDescriptor的构造函数有两个入参：PropertyDescriptor(StringpropertyName,ClassbeanClass)，其中propertyName为属性名；beanClass是JavaBean所对应的Class。

PropertyDescriptor还有一个setPropertyEditorClass(ClasspropertyEditorClass)方法，它可以为JavaBean属性指定编辑器。

BeanInfo接口中最重要的方法是：PropertyDescriptor[]getPropertyDescriptors()，它会返回JavaBean的属性描述器数组。

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

2Spring默认属性编辑器

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

publicclassBook{
/**
*作者
*/
privateAuthorauthor;
/**
*书名
*/
privateStringname;
//省略get/setter方法
}

Author.java

publicclassAuthor{
privateStringname;
//省略get/setter方法
}

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

publicclassCustomPropertyEditorextendsPropertyEditorSupport{
@Override
publicvoidsetAsText(Stringtext)throwsIllegalArgumentException{
if(text==null||text.length()==0){
thrownewIllegalArgumentException("格式错误");
}
Authorauthor=newAuthor();
author.setName(text);
//调用父类的方法，来设置属性对象
setValue(author);
}
}

如果使用BeanFactory，则需要手工调用registerCustomEditor(ClassrequiredType,PropertyEditorpropertyEditor)方法注册自定义属性编辑器；如果使用的是ApplicationContext，那么只需要在配置文件中注册CustomEditorConfigurer即可。CustomEditorConfigurer实现了BeanFactoryPostProcessor接口，所以它是一个Bean的工厂后处理器。

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

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

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

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

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

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

热门推荐

随机推荐