利用Spring 对Apache Common BeanUtil进行定制

Apache BeanUtil简介。

Apache Common BeanUtil是一个常用的在对象之间复制数据的工具类，著名的web开发框架struts就是依赖于它进行ActionForm的创建。

    BeanUtil最常用的类是org.apache.commons.beanutils.BeanUtils。
    
    

    BeanUtils最常用的方法为：
   
   

    1.   public void copyProperties(java.lang.Object dest, java.lang.Object orig)
	把orig中的值copy到dest中.
    
    

    2.   public java.util.Map describe(java.lang.Object bean)
	把Bean的属性值放入到一个Map里面。
    
    

    3.   public void populate(java.lang.Object bean, java.util.Map properties)
	把properties里面的值放入bean中。
    
    

    4.   public void setProperty(java.lang.Object bean, java.lang.String name, java.lang.Object value)
	设置Bean对象的名称为name的property的值为value.
    
    

    5.   public String getProperty(java.lang.Object bean, java.lang.String name)
   
   

    	    取得bean对象中名为name的属性的值。
    
    

    详细的使用方法可以参见官方网站：
    
    

    http://jakarta.apache.org/commons/beanutils/
   
   

Apache Common BeanUtil的常见使用场景。

 
 1.     
 
 同类之间不同对象要求进行数据复制。

    
    

User user1  =  …;
User user2  =  …;
BeanUtils. copyProperties(user2,user1);

 
 2.     
 
 不同类不同对象之间的数据复制。

    
    

UserForm userForm  =  …;
User user  =  …;
BeanUtils. copyProperties(user, userForm);

相信经常使用struts的人，一定会很熟悉上面的代码。
这是一个典型把页面的value object数据复制到domain object的例子。
    
    

 
 3.     
 
 对象数据和Map之间互相转化。
   
   

User user  =  …;
Map userMap  =  BeanUtils.describe(user);
Map userMap  =  …;
User user  =  …;
BeanUtils.populate(user,userMap);

   Map可以看成一个动态数据容器，作为VO很适合在不同层之间传播数据，作为PO也可以动态存储字段信息，
合理运用可以减少程序很多修改和维护工作。所以让bean和map之间方便的进行数据填充，非常必要。
   
   

Apache Common BeanUtil的支持类型的扩展。

  BeanUtils能够顺利的完成对象属性值的复制，依赖于其对类型的识别。在org.apache.commons.beanutils.converters包中有一系列converter类，用于不同类型之间对象的转化。比如说BigDecimalConverter，显然，就是用来转化BigDecimal的。这里面基本的类型已经写得很全了。如果需要扩展BeanUtil的类型支持，必须要自己写Converter去实现org.apache.commons.beanutils.Converter接口。扩展只要找一个具体的Converter类照着修改就好了。

这是一个最简单的例子。

public   class  MyTypeConverter  implements  Converter  ... {
    private boolean useDefault = false;

    private Object defaultValue = null;

    public MyConverter(Object defaultValue) ...{
        useDefault = false;
        if (defaultValue == null) ...{
           this.defaultValue  = null;
        } else ...{
           this.defaultValue  = defaultValue;
        }
        useDefault = true;
    }

    public Object convert(Class type, Object value) ...{
        if(value == null)...{
            if(useDefault)...{
                   return defaultValue;
           }else...{
                   Throw new ConvertException(…);
           }               
        }
        if(value.getClass().equals(type))
               return value;
        else 
               return value.toString();
    }
}

另外一个简单的办法是直接继承AbstractConverter。

public   class  MyTypeConverter  implements  AbstractConverter ... {
   protected Object convertToType(Class type, Object value) throws Exception...{
       //…
   }
}

Defaultvalue之类的设定就做了默认处理。可以只考虑转化到除了String以外其他类型时的情况。

Converter具体类在写完后需要注册到BeanUtils系统才可以用。 通过ConvertUtils.register(Converter converter,Class clazz)这个静态方法， 我们就可以把一个具体的Converter邦定到一个Class。 每次当BeanUtils试图处理这种Class类型的属性时，就会调用已经注册到这个Class上的Converter.

Converter类和如何注册的问题解决了，那么何时注册比较好呢？ 最好是和BeanUtils默认的Connvertor同时注册。 ConvertUtils的方法都是委派到ConvertUtilsBean.getInstance()返回的一个单例上来执行的。

ConvertUtilsBean的构造器如下:

public  ConvertUtilsBean()  ... {
        converters.setFast(false);
        //就是这句。
        deregister();
        converters.setFast(true);
}

deregister()代码如下：

public   void  deregister()  ... {
        boolean booleanArray[] = new boolean[0];
        byte byteArray[] = new byte[0];
        …
        converters.clear();
        register(BigDecimal.class, new BigDecimalConverter());
        register(BigInteger.class, new BigIntegerConverter());
        register(Boolean.TYPE, new BooleanConverter(defaultBoolean));
        register(Boolean.class,  new BooleanConverter(defaultBoolean));
        …
}

问题来了，这是硬编码的，一般还是不要修改原代码的好。其实这块部分适合作成一个配置，但是BeanUtil的作者尽量保持简单的关系。
我们还有机会在外面注册Convertor以添加或者替换BeanUtil默认的Converter。

这种工具类的初始化总该在我们的业务逻辑运行起来之前就完成的。那么自然比如是个web程序，
就可以把register的工作放到初始化就运行的servlet或者listener上去。

Public  class  MyServerlet ... {
        public void init()...{
                ConvertUtils.register(MyTypeConverter,MyType.class);
        }
}

很显然，我们依然通过代码进行了配置，而且一旦脱离了servlet环境，将不再可用。

Apache Common BeanUtil的Spring配置。

如果我们采用IOC框架，那么可以通过优雅的配置对BeanUtil进行自己的定制。

以spring为例我们做如下配置。

< bean  id ="beanUtilsConfig"  class ="com.winfo.util.BeanUtilsConfig" >
< property  name ="converters" >
         < map >
               < entry >
                   < key >
                      < value > java.sql.Timestamp </ value >
                   </ key >
                   < ref  bean ="sqlTimestampConverter"   />
               </ entry >
        </ map >
     </ property >
</ bean >
< bean  id ="sqlTimestampConverter"  class ="org.apache.commons.beanutils.converters.SqlTimestampConverter" >
     < constructor-arg >
        < null />
     </ constructor-arg >
</ bean >

beanUtilsConfig类：
  
  

public   class  BeanUtilsConfig  implements  InitializingBean ... {

        private Map converters = new HashMap();

        public void afterPropertiesSet() throws Exception ...{

               Set keys = converters.keySet();

               for(Object key:keys)...{
                       ConvertUtils.register((Converter)converters.get(key),Class.forName((String) key));
               }
        }

        public Map getConverters() ...{
               return converters;
        }

        public void setConverters(Map converterMap) ...{
               this.converters = converterMap;
        }
}  

这样就完成了在spring框架启动的时候，注册Converter类，
修改sqlTimestampConverter的Converter为默认值为null的Converter。

当然，在调用ConvertUtils.register之前，BeanUtil的默认Convertor已经注册完成。

由上可以看出IOC容器对于改进我们的设计非常有帮助，如果BeanUtil基于IOC容器开发的话，其可配置性将大大增强。