BeanUtil工具類的使用
BeanUtils的使用
1.commons-beanutils的介紹
commons-beanutils是Apache組織下的一個基礎的開源庫，它提供了對Java反射和內省的API的包裝，依賴內省，其主要目的是利用反射機制對JavaBean的屬性進行處理。我們知道一個JavaBean通常包含了大量的屬性，很多情況下，對JavaBean的處理導致了大量的get/set代碼堆積，增加了代碼長度和閱讀代碼的難度，現在有了BeanUtils，我們對JavaBean屬性的處理就方便很多。
2.BeanUtils的使用
BeanUtils是commons-beanutils包下的一個工具類，如果想在我們的項目中使用這個類需要導入以下兩個jar包：
l commons-beanutils.jar
l commons-logging.jar
下面我們就來練習如何使用BeanUtils，案例詳情請參考BeanUtils使用案例詳解，點擊此處下載案例源代碼，具體如下：
(1)創建一個web應用，Example5，將上面說到的兩個jar包拷貝的WEB-INF/lib下；
(2)在該應用下的src目錄下新建一個Class類，名稱為Person，主要代碼如例1-1所示：
例1-1 Person.java
|
public class Person { private Stringname; private int private Stringgender; private boolean bool; 此處省略以上四個屬性的get/set方法 @Override public String toString() { return "Person [name=" + name + ", age=" + age + ", gender=" + gender + "]"; } } |
例1-1中，定義了四個成員變量，並重寫了toString()方法。
(3)在src目錄下新建一個Class類，名稱為Demo，在該類中定義了一個單元測試方法，主要代碼如例1-2所示：
例1-2 Demo.java
|
public class Demo { @Test public void fun1() throws Exception{ String className="cn.itcast.domain.Person"; Class clazz=Class.forName(className); Object bean=clazz.newInstance(); BeanUtils.setProperty(bean, "name", "張三"); BeanUtils.setProperty(bean, "age", "23"); BeanUtils.setProperty(bean, "gender", "男"); BeanUtils.setProperty(bean, "xxx", "XXX"); System.out.println(bean); } } |
例1-2中，利用反射獲得Person類的對象，然後使用BeanUtils類的靜態方法setProperty(Object bean,String name,Object value)為指定bean的指定屬性賦值。該方法的第一參數是javaBean對象，第二個參數是javaBean的屬性，第三個參數是屬性的值。
(4)運行Demo類的單元測試方法fun1()，控制臺打印結果如圖1-1所示：
圖1-1 控制臺打印結果
圖1-1中，Person信息的打印格式是我們再Person類的toString()方法中設置的。
(5)使用BeanUtils的getProperty(Object bean,String name)方法獲取指定bean的指定屬性值，如例1-3所示：
|
public class Demo { @Test public void fun1() throws Exception{ String className="cn.itcast.domain.Person"; Class clazz=Class.forName(className); Object bean=clazz.newInstance(); BeanUtils.setProperty(bean, "name", "張三"); BeanUtils.setProperty(bean, "age", "23"); BeanUtils.setProperty(bean, "gender", "男"); BeanUtils.setProperty(bean, "xxx", "XXX"); System.out.println(bean); String age = BeanUtils.getProperty(bean, "age"); System.out.println(age); } } |
(6)測試fun1方法，控制臺打印結果如圖1-2所示：
圖1-2 控制臺打印結果
以上是通過BeanUtils類的setProperty()和getProperty()方法對javaBean屬性的設置和獲取；開發中可能會有這樣的需求：將表單提交過來的請求參數封裝在一個javaBean中，這個時候我們再使用BeanUtils的setProperty()和getProperty()方法就會很麻煩；因此BeanUtils又為我們提供了一個靜態方法populate(Object bean,Map properties)，其中第二個參數就是封裝請求參數的Map，我們可以通過request.getParameterMap()方法獲取一個封裝了所有請求參數的Map對象。
下面通過一個例子來了解BeanUtils類的populate(Object bean,Map properties)方法，如下所示：
(7)在Example5中創建一個javaBean類，User，主要代碼如例1-4所示：
例1-4 User.java
|
public class User { private Stringusername; private String password; 此處省略User類的成員變量的get/set方法 @Override public String toString() { return "User [username=" + username + ", password=" + password + "]"; } } |
(8)在Demo類中再定義一個單元測試方法fun2，主要代碼如例1-5所示：
例1-5 fun2()方法
|
@Test public void fun2() throws Exception { Map<String,String> map = new HashMap<String,String>(); map.put("username", "zhangSan"); map.put("password", "123"); User user = new User(); BeanUtils.populate(user, map); System.out.println(user); } |
例1-5中，將map裏面的數據封裝到javaBean中，這裏有一個要求：Map中的key值要與JavaBean中的屬性名稱保持一致，否則封裝不進去。
(9)測試fun2方法，控制臺打印結果如圖1-3所示：
圖1-3 控制臺打印結果
現在我們再對BeanUtils進行封裝，封裝成一個工具類，我們之前也封裝過類似的一個工具類，該工具類中提供了一個方法用來獲取不重復的32位長度的大寫字符串，如下所示：
(10)在Example5中創建一個工具類，名稱為CommonUtils，在該類中定義一個方法，用來將map中的數據封裝到javaBean中，主要代碼如例1-6所示：
例1-6 CommonUtils.java
|
public class CommonUtils { /** * 生成不重復的32位長的大寫字符串 * @return */ public static String uuid() { return UUID.randomUUID().toString().replace("-","").toUpperCase(); } /** * 把map轉換成指定類型的javaBean對象 * @param map * @param clazz * @return */ public static <T> T toBean(Map map, Class<T> clazz) { try { /* * 1. 創建指定類型的javabean對象 */ T bean = clazz.newInstance(); /* * 2. 把數據封裝到javabean中 */ BeanUtils.populate(bean, map); /* * 返回javabean對象 */ return bean; } catch(Exception e) { throw new RuntimeException(e); } } } |
例1-6中，CommonUtils定義了一個靜態的泛型方法：toBean(Map map,Class<T> clazz)，根據傳遞的參數來判斷將map中的數據封裝到哪個javaBean中。當中來利用了反射獲得指定類型的javaBean對象，然後再調用BeanUtils類的populate()方法。
(11)在Demo類中再定義一個單元測試方法fun3，主要代碼如例1-7所示：
例1-7 fun3()方法
|
@Test public void fun3() { Map<String,String> map = new HashMap<String,String>(); map.put("username", "lisi"); map.put("password", "123"); /* * request.getParameterMap(); */ User user = CommonUtils.toBean(map, User.class); System.out.println(user); } |
例1-7中，將map中的數據使用CommonUtils類的toBean()方法封裝到user中，然後返回一個user對象。
(12)運行fun3()方法，控制臺打印結果如圖1-4所示：
圖1-4 控制臺打印結果
需要註意的是，在使用BeanUtils類的setProperty()、getProperty()和populate()方法時都拋出了異常，我們制作的幫助類需要對異常進行處理，這樣在調用這個幫助類的這個方法時就不用再對異常進行處理。另外，在調用BeanUtils的setProperty()方法時，如果設置的屬性不存在或者沒有給javaBean的某個屬性賦值，該方法不會拋出異常。
BeanUtil工具類的使用