아이템39 명명 패턴보다 애너테이션을 사용하라

• 전통적으로 도구나 프레임워크가 특별히 다뤄야 할 프로그램 요소에는 딱 구분되는 명명 패턴을 적용해왔다. 예컨대 테스트 프레임워크인 JUnit은 버전 3까지 테스트 메서드 이름을 test로 시작하게끔 했다.

명명 패턴의 단점

1. 오타가 나면 안된다. 만약 개발자의 실수로 오타가 발생하더라도 이를 검증하기가 쉽지 않다.
2. 올바른 프로그램의 요소에서만 사용되리라 보증할 방법이 없다. 예를 들어 메서드에서만 사용가능한 명명 패턴을 클래스 명에도 사용하지 못하게 강제할 수 있는 방법이 없다.
3. 프로그램 요소를 매개변수로 전달할 마땅한 방법이 없다. 이름 옆에 함꼐 붙여서 전달할 수도 있겠지만, 보기도 나쁘고 꺠지기도 쉽다.

위 단점을 모두 해결해주는 애너테이션!

import java.lang.annotation.*;
/**
* 테스트 메서드임을 선언하는 애너테이션이다.
* 매개변수 없는 정적 메서드 전용이다.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Test {
}

• 위처럼 애너테이션 선언에 다는 애너테이션을 메타애너테이션(meta-annotation)이라 한다. @Retention(RetentionPolicy.RUNTIME) 메타애너테이션은 @Test가 런타임에도 유지되어야 한다는 표시다. 만약 이 메타애너테이션을 생략하면 테스트 도구는 @Test를 인식할 수 없다. 한편, @Target(ElementType.METHOD) 메타애너테이션은 @Test 가 반드시 메서드 선언에서만 사용돼야 한다고 알려준다. 따라서 클래스 선언, 필드 선언 등 다른 프로그램 요소에는 달 수 없다.

매개변수 하나를 받는 애너테이션 타입

import java.lang.annotation.*;
/**
* 명시한 예외를 던져야만 성공하는 테스트 메서드용 애너테이션
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface ExceptionTest {
    Class<? extends Throwable> value();
}

public class Sample2 {
@ExceptionTest(ArithmeticException.class)
public static void m1() { // 성공해야 한다.
    int i = 0;
    i = i / i;
}
@ExceptionTest(ArithmeticException.class)
public static void m2() { // 실패해야 한다. (다른 예외 발생)
    int[] a = new int[0];
    int i = a[1];
}
@ExceptionTest(ArithmeticException.class)
public static void m3() { } // 실패해야 한다. (예외가 발생하지 않음)
}

• reflection 을 이용해 value에 접근할 수 있고 그에 따라 다른 동작을 구현할 수 있다.

정리

• 이번 아이템의 테스트 프레임워크는 아주 간단하지만 애너테이션이 명명 패턴보다 낫다는 점은 확실히 보여준다. 테스트는 애너테이션으로 할 수 있는 일 중 극히 일부일 뿐이다. 애너테이션으로 할 수 있는 일을 명명 패턴으로 처리할 이유는 없다.