[Java] Annotation 놀이 - part.1

2006 년에 회사 프로젝트로 xml 파싱하는게 있었는데 그 때 처음 써봤던 어노테이션...
reflection 과 함게 반복적인 코드들을 자동화 시킬 수 있는 콤보를 보여주신다.

일단 해볼 것은 toString 메소드 자동화를 해보려고 한다.
프로퍼티의 값을 설정하고 출력 테스트를 해보려면 각 클래스마다 toString 을 오버라이딩 해야하는데
귀찮은 건 딱 질색이므로... 일단 고고싱..

ㅁ PrintToString - Annotation
package kr.co.vicki.test.annotations; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface PrintToString {}

간단하게 설명 들어갑니다.
 @Retention 의 설명을 아래와 같다.

Indicates how long annotations with the annotated type are to be retained.

해석을 하자면 ... 안되겠다. 그냥 언제까지 어노테이션이 유지되는지를 설정한다.
속성으로는 RetentionPolicy.RUNTIME, CLASS, SOURCE 가 있다. 런타임에서 가지고 놀 것이므로
RUNTIME 을 선택!!

@Target <<< javadoc 은 아래와 같이 설명을 해준다.

Indicates the kinds of program element to which an annotation type is applicable.

어떤 종류의 어노테이션이냐 라는 것을 설정하는 것이다. 하나의 값을 설정해도 되고 여러개를 설정해도 된다.
속성의 종류는 ElementType.FIELD, TYPE, METHOD, PARAMETER, LOCAL_VARIABLE,
CONSTRUCTOR, PACKAGE 가 있다. 여기서는 프로퍼티에 설정할 것이므로 FILED 로 낙찰...


ㅁ 헬퍼 클래스들...
package kr.co.vicki.test.reflect; import java.lang.reflect.Field; import java.lang.reflect.Method; import kr.co.vicki.test.annotations.PrintToString; public class ToStringHelper { public static String toString(Object obj) { StringBuffer buffer = new StringBuffer(); try { Class clazz = obj.getClass(); buffer.append(clazz.getName()).append(" { "); for (Field field : clazz.getDeclaredFields()) { PrintToString pts = field.getAnnotation(PrintToString.class); if (pts != null) { Method getter = BeansHelper.getGetterMethod(clazz, field); Object value = getter.invoke(obj, null); buffer.append(field.getName()).append("=") .append(value).append(","); } } buffer.append(" }"); } catch (Exception e) { e.printStackTrace(); } return buffer.toString(); } }
package kr.co.vicki.test.reflect; import java.lang.reflect.Field; import java.lang.reflect.Method; public class BeansHelper { /** * getter 메소드를 찾습니다. * @param clazz * @param field * @return * @throws Exception */ public static Method getGetterMethod(Class clazz, Field field) throws Exception { String prefix = "get"; if (Boolean.class == field.getType() || boolean.class == field.getType()) prefix = "is"; return getBeansMethod(clazz, field, prefix); } /** * setter 메소드를 찾습니다. * @param clazz * @param field * @return * @throws Exception */ public static Method getSetterMethod(Class clazz, Field field, Class... paramType) throws Exception { return getBeansMethod(clazz, field, "set", paramType); } /** * beans 의 메소드를 찾습니다. * @param clazz * @param field * @param prefix * @param params * @return * @throws Exception */ private static Method getBeansMethod(Class clazz, Field field, String prefix, Class... params) throws Exception { String fieldName = field.getName(); fieldName = prefix + fieldName.substring(0, 1).toUpperCase() + fieldName.substring(1); Method method = clazz.getMethod(fieldName, params); return method; } }
ToStringHelper 클래스는 toString 의 조작에 도움을 주는 클래스이며, BeansHelper 는 자바빈의
getter, setter 메소드를 가지고 오는데 사용합니다. (사실 어딨는지 몰라서 그냥 만든거임..)


ㅁ 가지고 놀기~~
package kr.co.vicki.test; import kr.co.vicki.test.annotations.PrintToString; import kr.co.vicki.test.reflect.ToStringHelper; public class Person { @PrintToString private String name; @PrintToString private int age; @PrintToString private String remark; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public String getRemark() { return remark; } public void setRemark(String remark) { this.remark = remark; } public String toString() { return ToStringHelper.toString(this); } public static void main(String[] args) { Person person = new Person(); person.setName("자수씨"); person.setAge(26); person.setRemark("치킨 먹고 싶어요.."); System.out.println(person); } }
실행을 해보면 어노테이션이 있는 프로퍼티만 toString 에서 보여주게 됩니다.

@PrintToString 어노테이션을 주석처리하고 실행해보면 나머지 것들만 보여줍니다.
public class Person { @PrintToString private String name; @PrintToString private int age; // @PrintToString private String remark; ... }

소스코드 - 이클립스에서 작성

invalid-file

다음번에는 멀해볼까나...