Spring 中的基础知识（2）—— 属性编辑器

最新推荐文章于 2022-06-12 10:52:41 发布

HeatDeath

最新推荐文章于 2022-06-12 10:52:41 发布

阅读量516

点赞数

分类专栏： Spring-基础 SSM学习笔记

Spring-基础同时被 2 个专栏收录

67 篇文章 0 订阅

订阅专栏

SSM学习笔记

29 篇文章 11 订阅

订阅专栏

在Spring配置文件里，我们往往通过字面值为Bean各种类型的属性提供设置值：不管是double类型还是int类型，在配置文件中都对应字符串类型的字面值。

这里写图片描述

BeanWrapper填充Bean属性时如何将这个字面值转换为对应的double或int等内部类型呢？我们可以隐约地感觉到一定有一个转换器在其中起作用，这个转换器就是属性编辑器。

任何实现 java.beans.PropertyEditor 接口的类都是属性编辑器。

属性编辑器的主要功能就是将外部的设置值转换为 JVM 内部的对应类型，所以属性编辑器其实就是一个类型转换器。

1 JavaBean 的编辑器

Sun所制定的JavaBean规范，很大程度上是为IDE准备的——它让IDE能够以可视化的方式设置JavaBean的属性。如果在IDE中开发一个可视化应用程序，我们需要通过属性设置的方式对组成应用的各种组件进行定制，IDE通过属性编辑器让开发人员使用可视化的方式设置组件的属性。

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

BeanInfo与JavaBean之间的对应关系，通过两者之间规范的命名确立：对应JavaBean的BeanInfo采用如下的命名规范：<Bean>BeanInfo。如ChartBean对应的BeanInfo为ChartBeanBeanInfo；Car对应的BeanInfo为CarBeanInfo。当JavaBean连同其属性编辑器相同的组件注册到IDE中后，当在开发界面中对JavaBean进行定制时，IDE就会根据JavaBean规范找到对应的BeanInfo，再根据BeanInfo中的描述信息找到JavaBean属性描述（是否开放、使用哪个属性编辑器），进而为JavaBean生成特定开发编辑界面。

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

2 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()：为属性提供一个表示初始值的字符串，属性编辑器以此值作为属性的默认值。

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

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

3 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，一般情况下，可以通过扩展SimpleBeanInfo实现自己的功能。

4 一个实例

在本节中，我们来看一个具体属性编辑器的实例，该实例根据《Core Java Ⅱ》上的一个例子改编而成。

ChartBean是一个可定制图表组件，允许通过属性的设置定制图表的样式以得到满足各种不同使用场合要求的图表。我们忽略ChartBean的其他属性，仅关注其中的两个属性：

CharBean

public class ChartBean extends JPanel{  
   private int titlePosition = CENTER;  
   private boolean inverse;  
   //省略get/setter方法  
}

下面，我们为titlePosition属性提供一个属性编辑器。我们不去直接实现PropertyEditor，而是通过扩展PropertyEditorSupport这个方便类来定义我们的属性编辑器：

TitlePositionEditor

import java.beans.*;  
 public class TitlePositionEditor extends PropertyEditorSupport{  
    private String[] options = { "Left", "Center", "Right" };   

    //①代表可选属性值的字符串标识数组  
    public String[] getTags() { return options; }      

    //②代表属性初始值的字符串  
    public String getJavaInitializationString() { return "" + getValue(); }   

    //③将内部属性值转换为对应的字符串表示形式，供属性编辑器显示之用  
    public String getAsText(){  
       int value = (Integer) getValue();  
       return options[value];  
    }  

    //④将外部设置的字符串转换为内部属性的值  
    public void setAsText(String s){   
       for (int i = 0; i < options.length; i++){  
          if (options[i].equals(s)){  
             setValue(i);  
             return;  
          }  
       }  
    }  
 }

①处通过getTags()方法返回一个字符串数组，因此在IDE中该属性对应的编辑器将自动提供一个下拉框，下拉框中包含3个可选项：“Left”、“Center”、“Right”。而③和④处的两个方法分别完成属性值到字符串的双向转换功能。CharBean的inverse属性也有一个相似的编辑器InverseEditor，我们忽略不讲。

下面编写ChartBean对应的BeanInfo，根据JavaBean的命名规范，这个BeanInfo应该命名为ChartBeanBeanInfo，它负责将属性编辑器和ChartBean的属性挂钩起来：

ChartBeanBeanInfo

import java.beans.*;  
 public class ChartBeanBeanInfo extends SimpleBeanInfo{  
    public PropertyDescriptor[] getPropertyDescriptors() {  
       try{  

//①将TitlePositionEditor绑定到ChartBean的titlePosition属性中    
PropertyDescriptor titlePositionDescriptor                         
             = new PropertyDescriptor("titlePosition", ChartBean.class);  
          titlePositionDescriptor.setPropertyEditorClass(TitlePositionEditor.class);  


//②将InverseEditor绑定到ChartBean的inverse属性中            
PropertyDescriptor inverseDescriptor                          
             = new PropertyDescriptor("inverse", ChartBean.class);                      
          inverseDescriptor.setPropertyEditorClass(InverseEditor.class);  
          return new PropertyDescriptor[]{titlePositionDescriptor, inverseDescriptor};  
       }  
       catch (IntrospectionException e){  
          e.printStackTrace();  
          return null;  
       }  
    }  
 }

在ChartBeanBeanInfo中，我们分别为ChartBean和titlePosition和inverse属性指定对应的属性编辑器。将ChartBean连同属性编辑器以及ChartBeanBeanInfo打成JAR包，使用IDE组件扩展管理功能注册到IDE中。

5 Spring默认属性编辑器

Spring的属性编辑器和传统的用于IDE开发时的属性编辑器不同，它们没有UI界面，仅负责将配置文件中的文本配置值转换为Bean属性的对应值，所以Spring的属性编辑器并非传统意义上的JavaBean属性编辑器。

Spring为常见的属性类型提供了默认的属性编辑器。从图5-4中，我们可以看出BeanWrapperImpl类扩展了PropertyEditorRegistrySupport类，Spring在PropertyEditor RegistrySupport中为常见属性类型提供了默认的属性编辑器，这些“常见的类型”共32个，可分为3大类，总结如下：

Spring提供的默认属性编辑器

这里写图片描述

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

 defaultEditors：用于保存默认属性类型的编辑器，元素的键为属性类型，值为对应的属性编辑器实例；

 customEditors：用于保存用户自定义的属性编辑器，元素的键值和defaultEditors相同。

PropertyEditorRegistrySupport通过类似以下的代码定义默认属性编辑器：

this.defaultEditors.put(char.class, new CharacterEditor(false));  
this.defaultEditors.put(Character.class, new CharacterEditor(true));  
this.defaultEditors.put(Locale.class, new LocaleEditor());  
this.defaultEditors.put(Properties.class, new PropertiesEditor());