在 Spring 配置文件中，我們往往通過(guò)字面值設(shè)置 Bean 各種類型的屬性值 ，這個(gè)功能是通過(guò)屬性編輯器實(shí)現(xiàn)的。

任何實(shí)現(xiàn)了 java.beans.PropertyEditor 接口的類都是屬性編輯器 。 它可以將外部需要設(shè)置的值轉(zhuǎn)換為 JVM 內(nèi)部的對(duì)應(yīng)類型，所以屬性編輯器其實(shí)就是一個(gè)類型轉(zhuǎn)換器 。

1 JavaBean 編輯器

Sun 所制定的 JavaBean 編輯器，很大程度上是為 IDE 準(zhǔn)備的。它讓 IDE 能夠以可視化的方式來(lái)設(shè)置 JavaBean 的屬性 。

Java 通過(guò) java.beans.PropertyEditor 定義了設(shè)置 JavaBean 屬性的方法，通過(guò) BeanInfo 描述了 JavaBean 哪些屬性是可定制的，此外還描述了可定制屬性與 PropertyEditor 之間的對(duì)應(yīng)關(guān)系 。

BeanInfo 與 JavaBean 之間的對(duì)應(yīng)關(guān)系，通過(guò)兩者之間規(guī)范的命名確立，對(duì)應(yīng) JavaBean 的 BeanInfo 采用如下命名規(guī)范：<Bean>BeanInfo。 如 BookBean 對(duì)應(yīng)的 BeanInfo 為 BookBeanBeanInfo。 當(dāng) JavaBean 連同其屬性編輯器注冊(cè)到 IDE 后，當(dāng)在開(kāi)發(fā)界面中對(duì) JavaBean 進(jìn)行定制時(shí)， IDE 就會(huì)根據(jù) JavaBean 規(guī)范找到對(duì)應(yīng)的 BeanInfo ，然后再根據(jù) BeanInfo 中的描述信息找到 JavaBean 屬性描述（使用哪個(gè)屬性編輯器等），進(jìn)而為 JavaBean 生成特定開(kāi)發(fā)編輯界面 。

Java 提供了一個(gè)用于管理默認(rèn)屬性編輯器的管理器： PropertyEditorManager ，它保存著一些常見(jiàn)類型的屬性編輯器，如果某個(gè) JavaBean 的常見(jiàn)類型屬性沒(méi)有通過(guò) BeanInfo 顯式指定它的屬性編輯器， 那么 IDE 將自動(dòng)使用 PropertyEditorManager 中注冊(cè)的對(duì)應(yīng)屬性的默認(rèn)編輯器 。

1.1 屬性編輯器（PropertyEditor）
PropertyEditor 是屬性編輯器接口，它定義了將外部設(shè)置值轉(zhuǎn)換為內(nèi)部 JavaBean 屬性值的接口方法 。主要接口方法說(shuō)明如下：

PropertyEditor 接口是內(nèi)部屬性值和外部設(shè)置值的溝通橋梁 。

Java 為 PropertyEditor 提供了一個(gè)方便的實(shí)現(xiàn)類： PropertyEditorSupport ，該類實(shí)現(xiàn)了 PropertyEditor 接口，我們可以通過(guò)擴(kuò)展這個(gè)類來(lái)設(shè)計(jì)自己的屬性編輯器 。

1.2 Bean 屬性描述（BeanInfo）

BeanInfo 描述了 JavaBean 中的可編輯屬性以及對(duì)應(yīng)的屬性編輯器，每一個(gè)屬性對(duì)應(yīng)一個(gè)屬性描述器 PropertyDescriptor。

PropertyDescriptor 的構(gòu)造函數(shù)有兩個(gè)入?yún)ⅲ?PropertyDescriptor(String propertyName, Class beanClass) ，其中 propertyName 為屬性名； beanClass 是 JavaBean 所對(duì)應(yīng)的 Class。

PropertyDescriptor 還有一個(gè) setPropertyEditorClass(Class propertyEditorClass) 方法，它可以為 JavaBean 屬性指定編輯器 。

BeanInfo 接口中最重要的方法是：PropertyDescriptor[] getPropertyDescriptors() ，它會(huì)返回 JavaBean 的屬性描述器數(shù)組 。

BeanInfo 接口的一個(gè)常用的實(shí)現(xiàn)類是 SimpleBeanInfo ，我們可以通過(guò)擴(kuò)展這個(gè)類來(lái)實(shí)現(xiàn)自定義的功能 。

2 Spring 默認(rèn)屬性編輯器

Spring 的屬性編輯器與傳統(tǒng)的用于 IDE 開(kāi)發(fā)的屬性編輯器不同，它沒(méi)有 UI 界面，只是將配置文件中的文本配置值轉(zhuǎn)換為 Bean 屬性的對(duì)應(yīng)值 。

Spring 在 PropertyEditorRegistrySupport 中為常見(jiàn)的屬性類型提供了默認(rèn)屬性編輯器，分為 3 大類，共有 32 個(gè)：

PropertyEditorRegistrySupport 中有兩個(gè)用于保存屬性編輯器的 Map 類型變量：

3 自定義 Spring 屬性編輯器

如果我們的應(yīng)用定義了特殊類型的屬性，并且希望在配置文件中以字面值方式來(lái)配置屬性值，那么就可以編寫(xiě)自定義屬性編輯器并注冊(cè)到 Spring 容器的方式來(lái)實(shí)現(xiàn)。

Spring 默認(rèn)的屬性編輯器大都擴(kuò)展自 java.beans.PropertyEditorSupport，我們可以通過(guò)擴(kuò)展 PropertyEditorSupport 來(lái)自定義屬性編輯器 。在Spring 環(huán)境下僅需要將配置文件中字面值轉(zhuǎn)換為屬性類型的對(duì)象即可，并不需要提供 UI 界面，所以僅需要覆蓋 PropertyEditorSupport 的 setAsText() 方法就可以啦 (∩_∩)O哈哈~。

假設(shè)我們有兩個(gè)實(shí)體 Book 和 Author，希望在配置 Book 時(shí)，可以直接設(shè)置 Author 的名字。

Book.java

public class Book {
 /**
  * 作者
  */
 private Author author;
 /**
  * 書(shū)名
  */
 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("格式錯(cuò)誤");
  }
  Author author=new Author();
  author.setName(text);
  //調(diào)用父類的方法，來(lái)設(shè)置屬性對(duì)象
  setValue(author);
 }
}

如果使用 BeanFactory ，則需要手工調(diào)用 registerCustomEditor(Class requiredType, PropertyEditor propertyEditor) 方法注冊(cè)自定義屬性編輯器；如果使用的是 ApplicationContext ，那么只需要在配置文件中注冊(cè) CustomEditorConfigurer 即可 。CustomEditorConfigurer 實(shí)現(xiàn)了BeanFactoryPostProcessor 接口，所以它是一個(gè) Bean 的工廠后處理器 。

現(xiàn)在注冊(cè)自定義的屬性編輯器：

<!-- 注冊(cè)自定義的屬性編輯器-->
<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="村上春樹(shù)"/>
</bean>

BeanWrapper 在設(shè)置 book 的 author 屬性時(shí)，將檢索自定義屬性編輯器注冊(cè)表，當(dāng)發(fā)現(xiàn) author 屬性類型所對(duì)應(yīng)的屬性編輯器 CustomPropertyEditor 時(shí)，它就會(huì)這個(gè)定制的屬性編輯器把 "村上春樹(shù)" 轉(zhuǎn)換為 Author 對(duì)象 。

按照規(guī)范， Java 會(huì)在 JavaBean 的相同類包下查找是否存在 <JavaBean>Editor 的類；如果存在，就會(huì)自動(dòng)使用 <JavaBean>Editor作為該 JavaBean 的屬性編輯器 。Spring 也支持這個(gè)規(guī)范。

所以如果在類包下有一個(gè)名為 AuthorEditor 屬性編輯器類，那么就無(wú)須在配置文件中注冊(cè)自定義的屬性編輯器啦O(∩_∩)O哈哈~

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論