淺談Spring的屬性編輯器的使用

在 Spring 配置文件中，我們往往通過字面值設置 Bean 各種類型的屬性值 ，這個功能是通過屬性編輯器實現的。

任何實現了 java.beans.PropertyEditor 接口的類都是屬性編輯器 。 它可以將外部需要設置的值轉換為 JVM 內部的對應類型，所以屬性編輯器其實就是一個類型轉換器 。

1 JavaBean 編輯器

Sun 所制定的 JavaBean 編輯器，很大程度上是為 IDE 準備的。它讓 IDE 能夠以可視化的方式來設置 JavaBean 的屬性 。

Java 通過 java.beans.PropertyEditor 定義了設置 JavaBean 屬性的方法，通過 BeanInfo 描述了 JavaBean 哪些屬性是可定制的，此外還描述了可定制屬性與 PropertyEditor 之間的對應關系 。

BeanInfo 與 JavaBean 之間的對應關系，通過兩者之間規范的命名確立，對應 JavaBean 的 BeanInfo 采用如下命名規范：<Bean>BeanInfo。 如 BookBean 對應的 BeanInfo 為 BookBeanBeanInfo。 當 JavaBean 連同其屬性編輯器注冊到 IDE 后，當在開發界面中對 JavaBean 進行定制時， IDE 就會根據 JavaBean 規范找到對應的 BeanInfo ，然后再根據 BeanInfo 中的描述信息找到 JavaBean 屬性描述（使用哪個屬性編輯器等），進而為 JavaBean 生成特定開發編輯界面 。

Java 提供了一個用于管理默認屬性編輯器的管理器： PropertyEditorManager ，它保存著一些常見類型的屬性編輯器，如果某個 JavaBean 的常見類型屬性沒有通過 BeanInfo 顯式指定它的屬性編輯器， 那么 IDE 將自動使用 PropertyEditorManager 中注冊的對應屬性的默認編輯器 。

1.1 屬性編輯器（PropertyEditor）
PropertyEditor 是屬性編輯器接口，它定義了將外部設置值轉換為內部 JavaBean 屬性值的接口方法 。主要接口方法說明如下：

PropertyEditor 接口是內部屬性值和外部設置值的溝通橋梁 。

Java 為 PropertyEditor 提供了一個方便的實現類： PropertyEditorSupport ，該類實現了 PropertyEditor 接口，我們可以通過擴展這個類來設計自己的屬性編輯器 。

1.2 Bean 屬性描述（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 ，我們可以通過擴展這個類來實現自定義的功能 。

2 Spring 默認屬性編輯器

Spring 的屬性編輯器與傳統的用于 IDE 開發的屬性編輯器不同，它沒有 UI 界面，只是將配置文件中的文本配置值轉換為 Bean 屬性的對應值 。

Spring 在 PropertyEditorRegistrySupport 中為常見的屬性類型提供了默認屬性編輯器，分為 3 大類，共有 32 個：

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

3 自定義 Spring 屬性編輯器

如果我們的應用定義了特殊類型的屬性，并且希望在配置文件中以字面值方式來配置屬性值，那么就可以編寫自定義屬性編輯器并注冊到 Spring 容器的方式來實現。

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

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

Book.java

public class Book {
 /**
  * 作者
  */
 private Author author;
 /**
  * 書名
  */
 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("格式錯誤");
  }
  Author author=new Author();
  author.setName(text);
  //調用父類的方法，來設置屬性對象
  setValue(author);
 }
}

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

現在注冊自定義的屬性編輯器：

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

BeanWrapper 在設置 book 的 author 屬性時，將檢索自定義屬性編輯器注冊表，當發現 author 屬性類型所對應的屬性編輯器 CustomPropertyEditor 時，它就會這個定制的屬性編輯器把 "村上春樹" 轉換為 Author 對象 。

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

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

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。