Apache Commons BeanUtils包学习

一、概述
第一次看到BeanUtils包，是在Struts项目中，作为Struts一个工具来使用的，
估计功能越弄越强，就移到Common项目中了吧。

BeanUtils一共有四个package:
org.apache.commons.beanutils
org.apache.commons.beanutils.converters
org.apache.commons.beanutils.locale
org.apache.commons.beanutils.locale.converters
后三个包主要是用于数据的转换，围绕着一个Converter接口，该接口只有一个方法：
java.lang.Object convert(java.lang.Class type, java.lang.Object value) ，
用于将一个value转换成另一个类型为type的Object。在一些自动化的应用中应该会有用。
这里不作评论，以后有兴趣了，或者觉得有用了，再行研究。
这里只讲第一个包。

二、测试用的Bean
在开始所有的测试之前，我写了一个简单的Bean，以便于测试，代码如下：
package test.jakarta.commons.beanutils;

/**
* @author SonyMusic
*
*/
public class Month {
private int value;
private String name;
private int[] days={11,22,33,44,55};

public Month(int v, String n){
value=v;
name=n;
}

/**
* Returns the name.
* @return String
*/
public String getName() {
return name;
}

/**
* Returns the value.
* @return int
*/
public int getValue() {
return value;
}

/**
* Sets the name.
* @param name The name to set
*/
public void setName(String name) {
this.name = name;
}

/**
* Sets the value.
* @param value The value to set
*/
public void setValue(int value) {
this.value = value;
}

/**
* @see java.lang.Object#toString()
*/
public String toString() {
return value+"("+name+")";
}

public int[] getDays() {
return days;
}

public void setDays(int[] is) {
days = is;
}

}

三、BeanUtils
这是一个主要应用于Bean的Util（呵呵，这个解释很绝吧），以下是其中几个方法的例子

//static java.util.Map describe(java.lang.Object bean)
//这个方法返回一个Object中所有的可读属性，并将属性名/属性值放入一个Map中，另外还有
//一个名为class的属性，属性值是Object的类名，事实上class是java.lang.Object的一个属性
Month month=new Month(1, "Jan");

try {
Map map=BeanUtils.describe(month);
Set keySet=map.keySet();
for (Iterator iter = keySet.iterator(); iter.hasNext();) {
Object element = (Object) iter.next();
System.out.println("KeyClass:"+element.getClass().getName());
System.out.println("ValueClass:"+map.get(element).getClass().getName());
System.out.print(element+"\t");
System.out.print(map.get(element));
System.out.println();
}
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
}
输出为：
KeyClass:java.lang.String
ValueClass:java.lang.String
value 1
KeyClass:java.lang.String
ValueClass:java.lang.String
class class test.jakarta.commons.beanutils.Month
KeyClass:java.lang.String
ValueClass:java.lang.String
name Jan
注意到所有Map中的key/value都是String，而不管object中实际的值是多少。
与此对应的还有static void populate(java.lang.Object bean, java.util.Map properties)
用于将刚才describe出的Map再装配成一个对象。


再看这样一段代码
曹晓钢也许还记得，为了取一个不确定对象的property，着实花了不少时间，
难度不大，但要做到100%的正确，仍然需要付出很大的精力。
//static java.lang.String getProperty(java.lang.Object bean, java.lang.String name)
Month month=new Month(1, "Jan");

try {
System.out.println(BeanUtils.getProperty(month,"value"));
} catch (Exception e) {
e.printStackTrace();
}
//输出是：1

与getProperty类似的还有getIndexedProperty, getMappedProperty，
以getIndexedProperty为例：
Month month=new Month(1, "Jan");

try {
System.out.println(BeanUtils.getIndexedProperty(month,"days",1));
System.out.println(BeanUtils.getIndexedProperty(month,"days[1]"));
} catch (Exception e) {
e.printStackTrace();
}
这两个调用是相同的。


BeanUtils中还有一个方法：
static void copyProperties(java.lang.Object dest, java.lang.Object orig)
它真是太有用，还记得struts中满天飞的都是copyProperties，我甚至怀疑整个BeanUtils最初
是不是因为这个方法的需求才写出来的。
它将对象orig中的属性复制到dest中去。


四、PropertyUtils
这个类和BeanUtils类很多的方法在参数上都是相同的，但返回值不同。
BeanUtils着重于"Bean"，返回值通常是String，而PropertyUtils着重于属性，
它的返回值通常是Object。


五、ConstructorUtils
这个类中的方法主要分成两种，一种是得到构造方法，一种是创建对象。
事实上多数时候得到构造方法的目的就是创建对象，这里只介绍一下创建对象。
//static java.lang.Object ConstructorUtils.invokeConstructor
//(java.lang.Class klass, java.lang.Object[] args)
//根据一个java.lang.Class以及相应的构造方法的参数，创建一个对象。
Object obj=ConstructorUtils.invokeConstructor(Month.class, {new Integer(1), "Jan"});
Month month=(Month)obj;
try {
System.out.println(BeanUtils.getProperty(month,"value"));
} catch (Exception e) {
e.printStackTrace();
}
输出证明，构造方法的调用是成功的。
如果需要强制指定构造方法的参数类型，可以这样调用：
Object[] args={new Integer(1), "Jan"};
Class[] argsType={int.class, String.class};
Object obj;
obj = ConstructorUtils.invokeExactConstructor(Month.class, args, argsType);
Month month=(Month)obj;
System.out.println(BeanUtils.getProperty(month,"value"));
argsType指定了参数的类型

 

-----------------------------------------------------------

BeanUtils相关类的运用：

public class BeanUtilsStudy {   
    public static void main(String[] args) throws Exception {   
        PersonBean pbean = new PersonBean("java", 12);   
        pbean.setP("P属性");   
        // 定义几个属性名称   
        String propertyP = "p";   
        String propertyName = "name";   
        String propertyAge = "age";   
        Object returnValue = null;   
        // **************getProperty与setProperty方法：获取与设置JavaBean的属性**************   
       // 获取p属性值   
        returnValue = BeanUtils.getProperty(pbean, propertyP);   
        System.out.println(returnValue);   
        // 获取name属性值   
        returnValue = BeanUtils.getProperty(pbean, propertyName);   
        System.out.println(returnValue);   
        // 设置p属性值   
        BeanUtils.setProperty(pbean, propertyP, "C++");   
        System.out.println(pbean.getP());   
        // 设置age属性值   
        BeanUtils.setProperty(pbean, propertyAge, 24);   
        System.out.println(pbean.getAge());   
        // 可以自动帮我们进行类型转换   
        BeanUtils.setProperty(pbean, propertyAge, "25");   
        System.out.println(pbean.getAge());   
        // birthday类型的java.util.Date类，下面这样写在它在定义的是必须要实例化birthday   
        // java.util.Date有一个setTime()方法可以看作JavaBean   
        BeanUtils.setProperty(pbean, "birthday.time", new Date().getTime());   
        System.out.println(pbean.getBirthday());   
 
        // **************copyProperties方法：将一个JavaBean的属性copy到另一个JavaBean中**************   
       // PersonBean2是PersonBean的子类   
        PersonBean2 pb2 = new PersonBean2();   
        // 将pbean的属性值copy到pb2属性   
        BeanUtils.copyProperties(pb2, pbean);   
        System.out.println(pb2.getName());   
 
        // **************describe方法：将javaBean转换成Map对象************** //   
        Map beanMap = BeanUtils.describe(pbean);   
        for (Object key : beanMap.keySet()) {   
            System.out.println(key + "=" + beanMap.get(key));   
        }   
 
        // **************populate方法：将Map中的值设置到javaBean对象************** //   
       Map<String, Object> map = new HashMap<String, Object>();   
       map.put("name", ".NET");   
       map.put("age", 32);   
        map.put("p", "PPP");   
        BeanUtils.populate(pbean, map);   
       System.out.println(pbean.getName() + "/t" + pbean.getAge() + "/t"  
                + pbean.getP());   
 
       // 还有一个PropertyUtils   
        returnValue = PropertyUtils.getProperty(pbean, propertyName);   
        System.out.println(returnValue);   
        PropertyUtils.setProperty(pbean, propertyAge, 21);   
        System.out.println(pbean.getAge());   
       // PropertyUtils.setProperty(pbean, propertyAge, "21");不能自动进行类型转换    
    }   
}

其中用的JavaBean如下：

public class PersonBean {  
    private String name;  
    private int age;  
    private Date birthday = new Date();  
    private String x;  
    public PersonBean() {  
    }  
    public PersonBean(String name, int age) {  
        this.name = name;  
        this.age = age;  
    }  
    public String getP() {  
        return x;  
    }  
    public void setP(String p) {  
        this.x = p;  
    }  
    public int getAge() {  
        return age;  
    }  
    public void setAge(int age) {  
        this.age = age;  
    }  
    public Date getBirthday() {  
        return birthday;  
    }  
    public void setBirthday(Date birthday) {  
        this.birthday = birthday;  
    }  
    public String getName() {  
        return name;  
    }  
    public void setName(String name) {  
        this.name = name;  
    }  
} 

public class PersonBean2 extends PersonBean {  
    private String address;   
    public String getAddress() {  
        return address;  
    }   
    public void setAddress(String address) {  
        this.address = address;  
    }   
}

 

 

BeanUtils.getArrayProperty(java.lang.Objectbean,java.lang.Stringname)

获取bean中数组成员变量(属性)的值.
没什么好说的,用法很简单,略.
还 是要说一句,如果我们指定的name不是数组类型的成员变量,结果会如何?会不会抛出类型错误的exception呢?回答是不会,仍然会返回一个 String的数组,数组的第一项就是name对应的值(如果不是String类型的话,JVM会自动的调用toString()方法的).

BeanUtils.getIndexedProperty(java.lang.Objectbean,java.lang.Stringname)
BeanUtils.getIndexedProperty(java.lang.Objectbean,java.lang.Stringname,intindex)

这两个方法都是获取数组成员变量(属性)中的单一元素值的方法.比如,我想得到SampleObject中words[1]的值,用法如下:
BeanUtils.getIndexedProperty(sampleOjbectInstance,"words[1]");
BeanUtils.getIndexedProperty(sampleOjbectInstance,"words",1);

BeanUtils.getMappedProperty(java.lang.Objectbean,java.lang.Stringname)
BeanUtils.getMappedProperty(java.lang.Objectbean,java.lang.Stringname,java.lang.Stringkey)

这两个方法是获取map成员变量中单一元素值的方法,用法与getIndexedProperty()方法相似,如我想得到SampleObject中map中home对应的值,用法如下:
BeanUtils.getMappedProperty(sampleOjbectInstance,map(home));
BeanUtils.getMappedProperty(sampleOjbectInstance,map,"home");

BeanUtils.getNestedProperty(java.lang.Objectbean,java.lang.Stringname)

获取嵌套属性值的方法,如我想得到SampleOjbect中成员变量sample中的display的值,用法如下:
BeanUtils.getNestedProperty(sampleOjbectInstance,"sample.display");

BeanUtils.getSimpleProperty(java.lang.Objectbean,java.lang.Stringname)
BeanUtils.getProperty(java.lang.Objectbean,java.lang.Stringname)

获 取属性值的方法.api已经很清楚了,我唯一的问题是这个simple是什么意思.javadoc只是说了getProperty()方法中的name参 数可以为普通属性名称,数组属性名称或嵌套属性名称的一种,而getSimpleProperty()方法中的name参数应该为普通属性名称了.我的想 法是通过对方法签名的不同,让developers可以显示区别对待普通属性,数组属性,map属性和嵌套属性.
ps:具体有何区别,看来要仔细看看源代码了.

BeanUtils.describe(java.lang.Objectbean)

将一个bean以map的形式展示.(这个方法和populate()是我梦想中的双手剑)
但是使用这个方法得到的结果有点令我失望,以SampleObject为例,代码片段如下:
SampleObjecta=newSampleObject();
a.setDisplay("firstone");
a.setName("A");
a.setNum(5);
a.setWords("goto".toCharArray());
SampleObjectAb=newSampleObjectA();
b.setDisplay("nestedproperty");
b.setNum(newDouble(2.0));
b.setName("sampleA");
a.setSample(b);
try{
MapdescMap=BeanUtils.describe(a);
System.out.println(descMap);
}
......
运行结果如下:
{num=5,display=firstone,class=classbeanutil.SampleObject,words=g,tag=false, sample=beanutil.SampleObjectA@be2358 ,map={port=80,home=localhost},name=A}

首 先可以看出,除了输出SampleObject中定义的key-value外,还会包含 class=classbeanutil.SampleObject这一项,我想这是为了通过获得的map我们可以知道原来的bean的具体类型;其次, 作为数组成员变量(属性)的words,在map中只包含了首个元素,而map类型的成员变量的输出结果到是非常令人满意.为什么明明长度为4的 words数组现在输出只有一个字符呢,我又进行了debug,并监控了words变量,发现在返回的descMap中,words对应的值的类型为 String,长度为1.

 

 

http://www.mscto.com/JavaBase/2009022464051.html