`

关于Spring属性编辑器详解

 
阅读更多

什么是属性编辑器,作用? 
* 自定义属性编辑器,spring配置文件中的字符串转换成相应的对象进行注入 
spring已经有内置的属性编辑器,我们可以根据需求自己定义属性编辑器 

* 如何定义属性编辑器? 
* 继承PropertyEditorSupport类,覆写setAsText()方法,参见:UtilDatePropertyEditor.java 
* 将属性编辑器注册到spring中,参见:applicationContext.xml 

比如: 
有一个类里面有一个Date属性 

Java代码  收藏代码
  1. public class Bean1 {  
  2.      private Date dateValue;  
  3.      public void setDateValue(Date dateValue) {  
  4.         this.dateValue = dateValue;  
  5.     }  
  6. }  


applicationContext.xml配置文件如下: 

Java代码  收藏代码
  1. <!--将bean1中的Date赋值2008-08-15,spring会认为2008-08-15是String,无法转换成Date,会报错!-->  
  2. <bean id="bean1" class="com.bjsxt.spring.Bean1">  
  3.       <property name="dateValue">  
  4.          <value>2008-08-15</value>  
  5.     </property>  
  6. </bean>  
  7. <!-- 于是定义属性编辑器 -->        
  8. <bean id="customEditorConfigurer" class="org.springframework.beans.factory.config.CustomEditorConfigurer">  
  9.     <property name="customEditors">  
  10.         <map>  
  11.             <entry key="java.util.Date">  
  12.                 <bean class="com.bjsxt.spring.UtilDatePropertyEditor">  
  13.                                         <!--干脆把format也注入,灵活处理格式-->  
  14.                     <property name="format" value="yyyy-MM-dd"/>  
  15.                 </bean>  
  16.             </entry>  
  17.         </map>  
  18.     </property>  
  19. </bean>     


UtilDatePropertyEditor.java 如下,必须继承java.beans.PropertyEditorSupport类,覆写setAsText()方法 

Java代码  收藏代码
  1. import java.beans.PropertyEditorSupport;  
  2. import java.text.ParseException;  
  3. import java.text.SimpleDateFormat;  
  4. import java.util.Date;  
  5.   
  6. /** 
  7.  * java.util.Date属性编辑器  
  8.  * @author Administrator 
  9.  * 
  10.  */  
  11. public class UtilDatePropertyEditor extends PropertyEditorSupport {  
  12.   
  13.     private String format="yyyy-MM-dd";  
  14.       
  15.     @Override  
  16.     public void setAsText(String text) throws IllegalArgumentException {  
  17.         System.out.println("UtilDatePropertyEditor.saveAsText() -- text=" + text);  
  18.           
  19.         SimpleDateFormat sdf = new SimpleDateFormat(format);  
  20.         try {  
  21.             Date d = sdf.parse(text);  
  22.             this.setValue(d);  
  23.         } catch (ParseException e) {  
  24.             e.printStackTrace();  
  25.         }  
  26.     }  
  27.   
  28.     public void setFormat(String format) {  
  29.         this.format = format;  
  30.     }  
  31.   
  32. }  


这样就可以完成正确解析了,注意customEditors是Spring的类CustomEditorConfigurer提供的属性,是一个Map,里面存放的都是自定义的编辑器(customEditors),比如这里存放的是UtilDatePropertyEditor日期编辑器,看CustomEditorConfigurer源码就知道了。 

测试一下: 

Java代码  收藏代码
  1. import org.springframework.beans.factory.BeanFactory;  
  2. import org.springframework.context.support.ClassPathXmlApplicationContext;  
  3.   
  4. import junit.framework.TestCase;  
  5.   
  6. public class InjectionTest extends TestCase {  
  7.       
  8.     private BeanFactory factory;  
  9.       
  10.     @Override  
  11.     protected void setUp() throws Exception {  
  12.         factory = new ClassPathXmlApplicationContext("applicationContext.xml");   
  13.     }  
  14.   
  15.     public void testInjection1() {  
  16.         Bean1 bean1 = (Bean1)factory.getBean("bean1");  
  17.         System.out.println("bean1.dateValue=" + bean1.getDateValue());  
  18.     }  
  19.       
  20. }  

 

 

 

 

最近刚在研究Spring的编辑器,发现很有意思,刚好galaxystar起了一个这样贴,我想对PropertyEditor作一个详细的整理会对大家有益,特定启了这个新帖。 
    
    所谓的PropertyEditor,顾名思义,就是属性编辑器。由于Bean属性通过配置文档以字符串了方式为属性赋值,所以必须有一个“东东”负责将这个字符串转换为属性的直接对象,如属性的类型为int,那么编辑器要做的工作就是int i = Integer.parseInt("1"); 
   Spring为一般的属性类型提供了默认的编辑器,BeanWrapperImpl是Spring框架中重要的类,它负责对注入的Bean进行包装化的管理,常见属性类型对应的编辑器即在该类中通过以下代码定义: 
  

Java代码  收藏代码
  1. private void registerDefaultEditors()  
  2.     {  
  3.         // Simple editors, without parameterization capabilities.  
  4.         // The JDK does not contain a default editor for any of these target types.  
  5.         this.defaultEditors.put(byte[].classnew ByteArrayPropertyEditor());  
  6.         this.defaultEditors.put(Class.classnew ClassEditor());  
  7.         this.defaultEditors.put(File.classnew FileEditor());  
  8.         this.defaultEditors.put(InputStream.classnew InputStreamEditor());  
  9.         this.defaultEditors.put(Locale.classnew LocaleEditor());  
  10.         this.defaultEditors.put(Properties.classnew PropertiesEditor());  
  11.         this.defaultEditors.put(Resource[].class,  
  12.                                 new ResourceArrayPropertyEditor());  
  13.         this.defaultEditors.put(String[].classnew StringArrayPropertyEditor());  
  14.         this.defaultEditors.put(URL.classnew URLEditor());  
  15.   
  16.         // Default instances of collection editors.  
  17.         // Can be overridden by registering custom instances of those as custom editors.  
  18.         this.defaultEditors.put(Collection.class,  
  19.                                 new CustomCollectionEditor(Collection.class));  
  20.         this.defaultEditors.put(Set.classnew CustomCollectionEditor(Set.class));  
  21.         this.defaultEditors.put(SortedSet.class,  
  22.                                 new CustomCollectionEditor(SortedSet.class));  
  23.         this.defaultEditors.put(List.classnew CustomCollectionEditor(List.class));  
  24.   
  25.         // Default instances of character and boolean editors.  
  26.         // Can be overridden by registering custom instances of those as custom editors.  
  27.         PropertyEditor characterEditor = new CharacterEditor(false);  
  28.         PropertyEditor booleanEditor = new CustomBooleanEditor(false);  
  29.   
  30.         // The JDK does not contain a default editor for char!  
  31.         this.defaultEditors.put(char.class, characterEditor);  
  32.         this.defaultEditors.put(Character.class, characterEditor);  
  33.   
  34.         // Spring's CustomBooleanEditor accepts more flag values than the JDK's default editor.  
  35.         this.defaultEditors.put(boolean.class, booleanEditor);  
  36.         this.defaultEditors.put(Boolean.class, booleanEditor);  
  37.   
  38.         // The JDK does not contain default editors for number wrapper types!  
  39.         // Override JDK primitive number editors with our own CustomNumberEditor.  
  40.         PropertyEditor byteEditor = new CustomNumberEditor(Byte.classfalse);  
  41.         PropertyEditor shortEditor = new CustomNumberEditor(Short.classfalse);  
  42.         PropertyEditor integerEditor = new CustomNumberEditor(Integer.classfalse);  
  43.         PropertyEditor longEditor = new CustomNumberEditor(Long.classfalse);  
  44.         PropertyEditor floatEditor = new CustomNumberEditor(Float.classfalse);  
  45.         PropertyEditor doubleEditor = new CustomNumberEditor(Double.classfalse);  
  46.   
  47.         this.defaultEditors.put(byte.class, byteEditor);  
  48.         this.defaultEditors.put(Byte.class, byteEditor);  
  49.   
  50.         this.defaultEditors.put(short.class, shortEditor);  
  51.         this.defaultEditors.put(Short.class, shortEditor);  
  52.   
  53.         this.defaultEditors.put(int.class, integerEditor);  
  54.         this.defaultEditors.put(Integer.class, integerEditor);  
  55.   
  56.         this.defaultEditors.put(long.class, longEditor);  
  57.         this.defaultEditors.put(Long.class, longEditor);  
  58.   
  59.         this.defaultEditors.put(float.class, floatEditor);  
  60.         this.defaultEditors.put(Float.class, floatEditor);  
  61.   
  62.         this.defaultEditors.put(double.class, doubleEditor);  
  63.         this.defaultEditors.put(Double.class, doubleEditor);  
  64.   
  65.         this.defaultEditors.put(BigDecimal.class,  
  66.                                 new CustomNumberEditor(BigDecimal.classfalse));  
  67.         this.defaultEditors.put(BigInteger.class,  
  68.                                 new CustomNumberEditor(BigInteger.classfalse));  
  69.     }  


   但是,并非Bean的属性都是这些常见的类型,如果你的Bean需要注入一个自定义类型的属性,而又想享受IoC的好处,那么就只得自己开干,提供一个自定义的PropertyEditor了。 
   下面,分几个步骤来说明,定义一个自定义PropertyEditor的过程。 
  1)首先,碰到的问题即是,要如何编辑自己的PropertyEditor,其实需要了解一点java.beans包的知识,在该包中,有一个java.beans.PropertyEditor的接口,它定义了一套接口方法(12个),即通过这些方法如何将一个String变成内部的一个对象,这两个方法是比较重要的: 
    a)setValue(Object value) 直接设置一个对象,一般不直接用该方法设置属性对象 
     b)setAsText(String text) 通过一个字符串来构造对象,一般在此方法中解析字符串,将构造一个 
     类对象,调用setValue(Object)来完成属性对象设置操作。 
  
  2)实现所有的接口方法是麻烦的,java.beans.PropertyEditorSupport 适时登场,一般情况下,我们通过扩展这个方便类即可。 

  3)编写完后,就是在Spring配置文件中注册该属性类型编辑器的问题,Spring提供了专门的注册工具类 
   org.springframework.beans.factory.config.CustomEditorConfigurer,它负责将属性类型和 
   属性编辑器关联起来。到时BeanFactory注入Bean的属性时,即会在注册表中查找属性类型对应的编辑器。 

  下面给出一个小例子,例子先作一个简单描述: 
  1)Person 需要进行属性注入的Bean,有两个属性 一个是name,一个是address Address是一个类 
  2)Address Person的属性类型,本身有3个属性。 
  3)AddressPropertyEditor Address类型对应的属性编辑器。 
  
  开工: 
  1.Person.java 

Java代码  收藏代码
  1. package com.stamen.propedit;  
  2.   
  3. import org.apache.commons.lang.builder.ToStringBuilder;  
  4.   
  5.   
  6. public class Person {  
  7.     private String name;  
  8.   
  9.     private Address address;  
  10.   
  11.   
  12.     public Address getAddress() {  
  13.         return address;  
  14.     }  
  15.   
  16.     public void setAddress(Address address) {  
  17.         this.address = address;  
  18.     }  
  19.   
  20.     public String getName() {  
  21.         return name;  
  22.     }  
  23.   
  24.     public void setName(String name) {  
  25.         this.name = name;  
  26.     }  
  27.     public String toString() {  
  28.         return ToStringBuilder.reflectionToString(this);  
  29.     }  
  30.  }   



  2.Address.java 

Java代码  收藏代码
  1. package com.stamen.propedit;  
  2. import org.apache.commons.lang.builder.ToStringBuilder;  
  3. public class Address {  
  4.     private String street;  
  5.   
  6.     private String doorNum;  
  7.   
  8.     private String postCode;  
  9.   
  10.     public String getDoorNum() {  
  11.         return doorNum;  
  12.     }  
  13.   
  14.     public void setDoorNum(String doorNum) {  
  15.         this.doorNum = doorNum;  
  16.     }  
  17.   
  18.     public String getPostCode() {  
  19.         return postCode;  
  20.     }  
  21.   
  22.     public void setPostCode(String postCode) {  
  23.         this.postCode = postCode;  
  24.     }  
  25.   
  26.     public String getStreet() {  
  27.         return street;  
  28.     }  
  29.   
  30.     public void setStreet(String street) {  
  31.         this.street = street;  
  32.     }  
  33.       
  34.     public String toString() {  
  35.         return ToStringBuilder.reflectionToString(this);  
  36.     }  
  37.   
  38. }  
  39.    


  
AddressPropertyEditor.java 

Java代码  收藏代码
  1. package com.stamen.propedit;  
  2.   
  3. import java.beans.PropertyEditorSupport;  
  4. import java.util.Date;  
  5.   
  6. import org.springframework.util.StringUtils;  
  7. public class AddressPropertyEditor extends PropertyEditorSupport{  
  8.     //支持的格式为 streeValue,doorNumValue,postCode  
  9.     public void setAsText(String text)  
  10.     {  
  11.         System.out.println("使用自己的编辑器。");  
  12.         if (text == null || !StringUtils.hasText(text)) {  
  13.             throw new IllegalArgumentException("老大,不能为空啊!");  
  14.         }  
  15.         else  
  16.         {  
  17.             String[] strArr = StringUtils.tokenizeToStringArray(text,",");  
  18.             Address add = new Address();  
  19.             add.setStreet(strArr[0]);  
  20.             add.setDoorNum(strArr[1]);  
  21.             add.setPostCode(strArr[2]);  
  22.             setValue(add);  
  23.         }  
  24.     }  
  25.       
  26.     public String getAsText()  
  27.     {  
  28.         Address add = (Address)getValue();  
  29.         return ""+add;  
  30.     }  
  31. }  
  32.    



打开Spring配置文件,添上这两个配置项: 

Java代码  收藏代码
  1.   <bean id="customEditorConfigurer"  class="org.springframework.beans.factory.config.CustomEditorConfigurer">  
  2.   <property name="customEditors">  
  3.     <map>  
  4.       <entry key="com.stamen.propedit.Address"> <!-- 属性类型 -->  
  5.         <bean class="com.stamen.propedit.AddressPropertyEditor"/> <!--对应Address的编辑器 -->  
  6.       </entry>  
  7.     </map>  
  8.   </property>  
  9. </bean>  
  10.   
  11.  <bean id="person" class="com.stamen.propedit.Person">  
  12.     <property name="name" value="Tom"/>  
  13.     <property name="address" value="朝阳区,Soho 1601,010101"/>  
  14.  </bean>  

 

 

分享到:
评论

相关推荐

    spring自定义编辑器

    ### Spring自定义编辑器详解 #### 一、引言 在Spring框架中,自定义编辑器主要用于处理数据类型的转换问题,特别是在将用户输入的数据转换为Java对象时非常有用。例如,用户通过表单提交了一个日期格式的字符串,...

    Spring中属性注入详解

    Spring提供了一种名为属性编辑器(Property Editor)的机制,用于将配置文件中的字符串转换为对应的Java对象。这里我们自定义了一个`Date`类型的属性编辑器`DatePropertyEditor`: ```java import java.beans....

    《精通Spring2.X企业应用开发详解》

    - **Spring属性编辑器**:介绍如何使用Spring的属性编辑器来实现更为灵活的数据类型转换。 - **使用外部属性文件**:探讨如何利用外部属性文件来管理应用程序的配置信息,特别是加密属性文件的使用技巧。 - **国际化...

    Struts 2+Hibernate+Spring整合开发技术详解随书源码

    在"Struts 2+Hibernate+Spring整合开发技术详解"这本书中,作者蒲子明深入浅出地讲解了这三大框架的整合使用。随书源码包含第19至21章的内容,主要涉及的是实际项目中的两个应用场景:BBS论坛系统和Photo System照片...

    UEditor在线编辑器

    **UEditor 在线编辑器详解** UEditor 是百度推出的一款开源的富文本在线编辑器,它为用户提供了丰富的文本编辑功能,包括文字样式、图片上传、表格操作、代码高亮等,广泛应用于网站内容管理、博客写作、论坛发帖等...

    spring3.0jar包

    此外,它还支持属性编辑器,用于在不同数据类型之间进行转换,以及属性值的自动检测和验证。 3. **org.springframework.web.servlet-3.0.5.RELEASE.jar**:这个模块是Spring MVC(Model-View-Controller)的基础,...

    Spring中WebDataBinder使用详解

    Spring中WebDataBinder使用详解 Spring中WebDataBinder是Spring MVC框架中的一种数据绑定机制,用于将Web请求参数绑定到JavaBean的属性上。它通过在控制器类中使用@InitBinder注解来配置Web数据绑定。 ...

    Spring-Reference_zh_CN(Spring中文参考手册)

    5. 校验,数据绑定,BeanWrapper,与属性编辑器 5.1. 简介 5.2. 使用Spring的Validator接口进行校验 5.3. 从错误代码到错误信息 5.4. Bean处理和BeanWrapper 5.4.1. 设置和获取属性值以及嵌套属性 5.4.2. 内建的...

    jsp在线图文编辑器

    **JSP在线图文编辑器详解** 在Web开发中,为了提供用户友好的界面来编辑文本内容,常常会使用到在线的图文编辑器。"fck-demo"是一个专门为JSP(JavaServer Pages)平台设计的在线文本编辑器,它极大地简化了用户在...

    eclipse添加springXML文件的提示

    - 返回到Eclipse主界面,在编辑器中打开Spring XML文件。 - 在XML文件的上下文菜单中选择`Open With` -&gt; `XML Editor` -&gt; `Source Mode`,以便在源代码模式下编辑XML文件。 - 这样做可以确保Eclipse能够正确识别...

    FCK编辑器源码工程

    **FCK编辑器源码工程详解** FCKeditor是一款经典的开源Web富文本编辑器,它在Web开发领域中被广泛使用,特别是在需要提供用户友好、类似桌面应用的文本编辑体验时。这款编辑器允许用户在网页上进行文字格式化、插入...

    Spring MVC3构建Web应用详解

    总的来说,Spring MVC提供了一种灵活且强大的方式来组织和控制Web应用的流程,包括模型、视图和控制器的分离,以及依赖注入等特性,使开发者可以更专注于业务逻辑,而不是底层的HTTP请求处理。在实际开发中,还可以...

    Spring 2.0 开发参考手册

    5. 校验,数据绑定,BeanWrapper,与属性编辑器 5.1. 简介 5.2. 使用Spring的Validator接口进行校验 5.3. 从错误代码到错误信息 5.4. Bean处理和BeanWrapper 5.4.1. 设置和获取属性值以及嵌套属性 5.4.2. 内建...

    Spring 开发参考手册

    - **属性编辑器** (Property Editor): 用于转换不可直接转换的数据类型,如将字符串转换为日期等。 - **数据绑定** (Data Binding): 将 HTTP 请求中的参数与 Java 对象属性之间建立映射关系。 - **BeanWrapper**: -...

    Thymeleaf+spring 参考文档

    - **表单集成**:模板中的表单可以直接与后端实体对象进行绑定,包括属性编辑器、转换服务和验证错误处理等功能。 - **国际化消息显示**:从Spring管理的消息文件中获取国际化消息,并在模板中展示。 - **资源解析...

    Spring.3.x企业应用开发实战(完整版).part2

    5.2.2 Spring默认属性编辑器 5.2.3 自定义属性编辑器 5.3 使用外部属性文件 5.3.1 使用外部属性文件 5.3.2 使用加密的属性文件 5.3.3 属性文件自身的引用 5.4 引用Bean的属性值 5.5 国际化信息 5.5.1 基础知识 5.5.2...

    Spring Tool Suite

    - 专门的XML编辑器支持Spring配置文件,如`application.xml`和`beans.xml`,提供语法高亮、错误检测和自动格式化。 6. **Spring Boot Dashboard** - STS内嵌了Spring Boot Dashboard,用于管理和运行Spring Boot...

    spring-framework-4.1.6.RELEASE-schema.zip

    7. **util**:包含了一些通用的工具类和辅助功能,如集合工厂、属性编辑器等。Schema文件中可能包含一些辅助配置元素,如列表、映射等。 8. **jdbc**:提供了一组模板类和JDBC抽象,以简化数据库访问。Schema文件...

    Spring中文帮助文档

    5. 校验,数据绑定,BeanWrapper,与属性编辑器 5.1. 简介 5.2. 使用Spring的Validator接口进行校验 5.3. 从错误代码到错误信息 5.4. Bean处理和BeanWrapper 5.4.1. 设置和获取属性值以及嵌套属性 5.4.2. 内建...

Global site tag (gtag.js) - Google Analytics