출처 : http://woongsanta.tistory.com/25
1. jakarta Project BeanUtils 소개
요즘 자주 사용하는 스트럿츠, 스프링 등의 프레임워크를 보면 BeanUtils를 자주 사용하는 걸 볼 수 있습니다.
자바 객체의 속성들을 동적으로 파악해서 필요한 처리를 해야 하는 경우가 점차 증가하고 있는것입니다.
기존의 Reflection와 Introspection API를 이용해서 구현할 수 있지만 API를 이해하고 활용하기가 매우 복잡하고 까다롭기도 합니다. 좀 더 쉽고 편하게
이용할 수 없을까 하는 needs에 의해 만들어 진게 BeanUtils 컴포넌트입니다.
이 컴포넌트를 처음 본다고 하시는 분도 계시겠지만 실제 우리 소스에서 검색해보면 사용 페이지가 제법 나오기도 하며 스프링 프레임워크가 적용되지 않은 페이지에서 쉽고 편하게 사용할 수 있는 모듈이기도 합니다.
이클립스에서 BeanConverterUtils, BeanUtils로 검색해보세요^^
일단 우리가 현재 이 모듈을 어떻게 사용하고 있는지 보겠습니다.
검색을 보면 request로 넘기는 무수히 많을 값을 ReqPrdSearch 객체에 값을 자동으로
넣어 주는 걸 볼 수 있습니다.
검색을 하면 get 방식으로 다음처럼 값이 넘어 갑니다.
fld=&so=0&mfr=&attr_1=&attr_2=&attr_3=&attr_4=&attr_5=&attr_6=&am1=&am2=&am3=&am4=&am5=&am6=&mfm=&cm=&sn=41&pg=20&rq=&price1=-1&price2=-1&searchColl=ALL&tq=mp3&cat0=&cat1=&cat2=&catdepth=-1&searchListType=A
이 값들을 어떻게 처리할까요?
그냥 useBean 쓰면 안되나요? 안됩니다.^^
jsp가 아닌 bean에서 처리할려 하니 쓸 수가 없습니다.
물론 스프링에서 아래처럼하면 됩니다.
bind(request, ReqPrdSearch);
하지만 스프링를 사용하지 않은 경우 어떻게 하나요?
beanUtils를 이용하시면 됩니다.
request를 객체에 담는거 이외에 또 어디에서 사용하고 있을까요?
DB로 부터 가져온 값을 처리할 때 이용하고 있습니다.
spring jdbc를 이용해서 DB로부터 값을 가져와서 Map(GSData)에 넣고 이용하는데
그 값을 객체에 넣고 사용할 때가 있습니다. 소스를 추적하다 보면 값넣어 주는
부분이 안보이는데 잘 작동이 되는 걸 볼 수 있습니다.
알게 모르게 이미 우리 안에서 사용되고 있으며
알면 편하고 쉽게 쓸 수 있어서 간단하게 BeanUtils를 소개합니다.
2. reference
http://jakarta.apache.org/commons/beanutils/
이곳에 가시면 각종 guide문서와 최신 jar파일을 다운 받으실수 있습니다.
http://jakarta.apache-korea.org/commons/beanutils.html
영어에 거부 반응이 있으신분은 여기 가보시면 번역된 내용을 접하실 수 있습니다.
http://www.jakartaproject.com/
자카르타프로젝트라는 책을 쓴 최범균씨 홈페이지인데 좋은 정보를 얻을 수 있습니다.
3. 주요 클래스
3-1. BeanUtils
객제의 정보, 속성 값 읽기, 속성 값 쓰기 등의 기능을 제공하고 있으며
PropertyUtils와 차이점은 value를 convert 해준다는 겁니다.
3-2. PropertyUtils
BeanUtils와 기능은 거의 흡사합니다.
3-3. ConvertUtils
타입에 따라 convet 하는 기능을 수행합니다.
4. 상세 내용
BeanUtils를 사용하기 위해서는 몇가지 규칙이 있습니다.
관련 부분은 필요시 사이트나 책을 찾아 보시면 나옵니다.
BeanUtils, PropertyUtils, ConvertUtils는 모두 static한 메소드를 가지고 있으며
BeanUtilsBean, PropertyUtilsBeanUtilsBean, ConvertUtilsBeanUtilsBean 이라는
싱글톤으로 구현된 객체와 wrapping되어 있는걸 볼 수 있습니다.
...
public static Object cloneBean(Object bean)
throws IllegalAccessException, InstantiationException,
InvocationTargetException, NoSuchMethodException {
return BeanUtilsBean.getInstance().cloneBean(bean);
}
...
나름대로 참고할 만한 구조 같습니다. ^^
4-1. BeanUtils
// bean 복제 // orig에서 dest로 복제, 동일 속성명이 존재해야합니다. // orig의 property를 dest로 복제 // Return the value of the specified array property of the specified bean, as a String array. // 배열값 가져오기, property name을 'name[0]' 이런 식으로 주어야 한다. 규칙임 // 배열값 가져오기 index는 몇번째 // mapped property 가져오기, property name을 'name(0)' 이런 식으로 주어야 한다. public static String getNestedProperty(Object bean, String name) // bean에서 값 가져오기 public static String getSimpleProperty(Object bean, String name) // bean에서 해당 name의 property에 value를 convert해서 넣는다. /* /* |
describe메소드를 이용해서 객체의 property와 value, type등을 쉽게 알아낼 수 있습니다.
Map map = BeanUtils.describe(bean);
Set set = map.keySet();
Iterator it = set.iterator();
while (it.hasNext()) {
String key = (String)it.next();
if ("class".equals(key)) {
continue;
}
Object value = map.get(key);
properties.put(key, value);
}
4-2. PropertyUtils
BeanUtils와 거의 동일합니다.
BeanUtils가 bean를 다루기위한거라면 PropertyUtils는 map을 처리한다고 보시면
됩니다.
4-3. ConvertUtils
이 utils은 싱글톤으로 구현된 ConvertUtilsBean에서 맵에 각종 컨버터를
등록해 놓고 lookup(Class clazz)해서 converter 얻고 그걸로 값을 처리하고
있습니다.
조금만 수정하면 아주 잘 써먹을 수 있는 util이길래 언급합니다.
5. example & test
배열, 기본형, 객체를 property로 하는 dto들을 만들어 잘 처리가 되는지 확인합니다.
Person.java : dto안에 또 다른 dto를 넣어서 잘 처리되는지 확인하기 위해 만들었습니다.
public class Person { private String name; private int age; public Person(String name, int age) public String toString() String retValue = ""; retValue = "Person ( " return retValue; |
Employee.java : 기본형, 배열, 객체 등을 property로 생성합니다.
public class Employee { private String address; private String firstName; private String lastName; private int age; private Person person; private Date credate; private List personList; private String[] fld1; private int[] fld2; public String[] getFld1() { String retValue = ""; retValue = "Employee ( " return retValue; } |
BeanConvertUtils.java
public class BeanConvertUtils { //map의 value을 bean에 넣어주는 메소드 public static void mapToBean(java.util.Map properties, java.lang.Object bean) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException { if (properties == null) { BeanUtils.populate(bean, properties); } //bean의 value을 map에 넣어주는 메소드 Map map = PropertyUtils.describe(bean); map.remove("class"); } |
TestBeanConvertUtils : 테스트 케이스
public class TestBeanConvertUtils extends TestCase { Employee emp; GSData map; HttpServletRequestMock request; public void setUp() { List list = new ArrayList(); list.add(new Person("kkaok1", 23)); list.add(new Person("kkaok2", 22)); emp = new Employee(); map = new GSData(); public void testmapToBean() throws IllegalAccessException, InvocationTargetException, NoSuchMethodException{ new ConvertUtilsBean().convert("0", i1.getClass()); Employee emptest = new Employee(); public void testbeanToMap() throws IllegalAccessException, InvocationTargetException, NoSuchMethodException{ assertEquals(map.get("address"), maptest.get("address")); } |
6. 마무리
map에 있는 값을 bean에 넣거나
bean에 있는 값을 map에 넣거나
request에 있는 값을 bean에 넣거나
동적으로 변하는 bean을 분석해야 할때 정말 편하고 쉽게 쓸 수 있는 모듈입니다.
한번 소스를 뜯어 보시면 좋은 내용을 접하실 기회가 되실 거라 믿습니다.
7. 참고
eclipse에서 테스트 하실때는 commons-beanutils.jar, commons-beanutils-bean-collections.jar, commons-beanutils-core.jar, commons-logging-1.1.jar, junit-3.8.1.jar 등을 빌드패스에 넣어 주세요
* request의 값을 빈에 넣는 예)
BeanUtils.populate(객체, request.getParameterMap());
* request.getParameterMap() 이렇게 하면 map에 key, value로 값이 return 됩니다.