자바 어노테이션(@Annotation)

자바에서 사용하는 어노테이션 (@Annotation )은 컴파일러를 위한 일종의 주석으로, [데이터를 조작하거나 코드에 영향을 미치지 않으며] 컴파일 과정과 실행과정에서 어떻게 추가적인 처리 & 컴파일을 해야 하는지 정보를 줄 수 있다.

 

또한 꼭 컴파일러 설정이 아니더라도, 소프트웨어 개발 툴이 어노테이션 정보를 읽어 빌드 또느 배치시에 필요한 코드를 자동으로 생성할 수 있도록 만들 수 있다.

 

어노테이션을 적극적으로 사용하기전에는 이러한 설정 정보를 XML등으로 따로 관리했는데, 어노테이션을 사용하며 자바 소스코드와 함께 합쳐 하나로 관리 할 수 있게 되었다. 또한 @어노테이션을 이용하면 코드상에 설정정보가 명확하게 들어나서 개발자의 실수를 줄여준다.

@AnnotationName

어노테이션을 자바에서 제공하는 [표준 어노테이션]과, @interface 태그를 이용해 어노테이션을 새로 만들 때 사용되는 [메타 어노테이션]이 있다. 

표준 어노테이션 (*가 붙은 것은 메타 어노테이션)

 

---

# 자주 사용하는 표준어노테이션

@Override

오바라이딩을 올바르게 했는지, 컴파일 타임에 체크를 한다. 

class Parent {
	void myMethod(){~}
}

class Child extends Parent{
    // ??? 오버라이딩을 하려다가 실수로 다른 이름을 작성하였다.
    // 하지만 컴파일러 입장에서는 이게 오버라이딩을 하려고 한건지 알 수 없다.
    void myMetho(){~}    
}

class Child extends Parent{
    @Override 
    void myMetho(){~} // 컴파일 에러! 부모에게 존재하지 않는 메서드    
}

 

@Deprecated

이름만 봐도 알 수 있듯이, 더 이상 사용하지 않는 것을 권장하는 옛 필드나 메서드에 붙인다. 사용하지 않으면 삭제하면 되지 않냐?고 생각할 수 있지만 자바에서는 기존 앱의 하위호환성을 제공하기 위해 해당 어노테이션을 사용한다.

@Deprecated
public int getDate(){
	return normalize().getDayOfMonth();
}

실제 Deprecated된 메서드. 컴파일시에도 경고문이 올라오지만, 보통 IDE에서 먼저 알려준다.

 

@FunctionalInterface

함수형 인터페이스에 사용하며, 컴파일러가 함수형으로 올바르게 작성했는지 문법적으로 확인한다. (하나의 추상메서드만 가지고 있는가?)

 

@SuppressWarnings("경고")

해당 메서드, 필드에 경고메시지가 나타나도 컴파일러가  무시하도록 설정한다. 여러 개를 무시하려면 { "a", "b", "c" } 로 작성한다. 해당 어노테이션의 사용으로 이 경고를 개발자가 확인하였고, 오류가 아니라는 것을 알려줄 수 있다.

@SuppressWarnings("unchecked")
ArrayList list = new ArrayList(); // 제네릭 타입을 지정하지 않았음
list.add(obj); // unchecked 경고 발생

 

그 외 다양한 어노테이션이 있다는거만 알고있자.

 

---

# 직접 만들기, 메타 어노테이션

@interface 를 이용하여 클래스 정의하듯이 새로운 어노테이션을 만들 수 있다. java.lang.annotation.ElementType을 이용하여 특정 타입에만 적용되도록 설정한다.

@Target(  타입지정  )
@Retention(  어노테이션 생명주기  )
public @interface SuppressWarnings{
	String[] value();
    ...
}

 

@Target

어노테이션의 적용대상을 지정한다.

// 클래스(type), 필드(filed), 메서드(method)에 적용가능한 어노테이션.
@Target( {TYPE, FILED, METHOD } )
public @interface MyAnnotation{...}

// 참고로 TYPE, FILED 등은 java.lang.annotation.ElementType 에 존재하는 설정값이다.
@Target( {ElementType.TYPE, ElementType.METHOD } )
public @interface MyAnnotation{...}

 

---

@Retention

어노테이션이 유지(retention)되는 시기, 즉 어노테이션의 생명주기를 지정해줄 수 있다. CLASS로 지정하면 런타임상에 존재하나 어노테이션을 사용하는 건 불가능한데 (리플렉션 불가능, JVM의 ClassLoader 까지만 사용가능) CLASS 를 쓰는 일은 거의 없고 보통 SOURCE/RUNTIME 로 구분지어 사용한다. 

SOURCE	소스 코드를 분석할 때만 의미있고, 컴파일 이후 바이트 코드에는 남지 않는다.
CLASS (기본값)	바이트 코드 파일까지 존재는 하나, 리플렉션을 이용해서 어노테이션 정보를 얻을 수는 없다. (보통 잘 안쓴다.)
RUNTIME	바이트 코드 파일까지 존재하고 리플렉션을 이용하여 런타임 시에 어노테이션 정보를 얻을 수 있다.

source - 컴파일 이후 클래스파일에 존재 X / runtime - 바이트코드에 존재.

@Target(ElementType.METHOD )
@Retention(RetentionPolicy.SOURCE) // 컴파일 이후에는 없어짐.
public @interface Override{...}

//참고로 어노테이션 선언 순서는 별 상관 없다.
@Documented
@Retention(RetentionPolicy.RUNTIME) // 실행 후에도 사용가능(리플렉션)
@Target( TYPE )
public @interface FunctionalInterface{...}

---

@Documented

javadoc으로 작성한 문서(html)에 포함시키려면 @Documented를 사용한다. 우리가 직접 사용할 일은 거의 없다.

//참고로 어노테이션 선언 순서는 별 상관 없다.
@Documented
@Retention(RetentionPolicy.RUNTIME) // 실행 후에도 사용가능(리플렉션)
@Target( TYPE )
public @interface FunctionalInterface{...}

 

@Inherited (상속)

해당 어노테이션을 대상의 자식까지 적용되게 할 떄 사용한다. 거의 사용할 일이 없는 어노테이션이긴 하다.

@Inheriteed
@interface MyAnno


@MyAnno
class Parent{} // 어노테이션 적용됨

class Child extends Parent{} //  어노테이션 적용됨.

 

@Repeatable

같은 어노테이션을 여러개 붙일 수 있도록 만들어준다. 이것도 거의 사용할 일은 없다.

@Repeatable(ToDos.class)
@interface ToDo{
	...
}

// 단, 제대로 사용하기 위해서는 하나로 묶어서 관리할 컨테이너 어노테이션을 같이 정의해야한다.
@interface ToDos{
	ToDo[] value();// 어노테이션을 배열타입으로 선언. 참고로 이름은 반드시 value여야함.
    // 어노테이션 요소의 이름이 value인 경우에는 생략하여 입력 가능.
}

@ToDo("delete test codes.")
@ToDo("override inheriteed methods")
class MyClass{
	...
}

 

---

# 어노테이션 타입 정의하기

어노테이션도 클래스와 동일하게 정의 할 수 있다. 단 타입을 정의할 땐 매개변수가 없는 추상메서드만 이용할 수 있다. 당연히 추상메서드로만 이루어져있으므로, 예외를 선언하는거나 제네릭<T>를 사용하는 건 불가능하다.

@interface 어노테이션이름{
	타입 요소이름(); // 추상메서드만 사용할 수 있다.
}

@interface TestInfo{
    int count();
    static final id =100; // 예외적으로 상수는 사용가능하다. 생략해도 상수로 취급함.
    String testedBy();
    String[] testTools(); // 배열
    TestType testType(); // enum 이나 Class도 가능하다.
    DateTime testDate(); // 자신이 아닌 다른 어노테이션(@DataTime)을 포함할 수 있다.
}

이렇게 정의한 어노테이션은 아래와 같이 사용할 수있다. 이렇게 받은 정보를 컴파일러나 소프트웨어 개발 툴이 사용할 수 있다. 보통은 어노테이션에 저장된 값을 다루는 일은 거의 없고 보통 만들어진 어노테이션을 아래와 같이 사용하게 된다.

 

@ default 값

적용시 값을 지정하지 않았을 떄 사용할 수 있는 기본값을 지정할 수 있다. 당연한거지만 default 메서드는 사용 불가능하다.

@interface TestInfo{
    int count() default 1 // 기본값 1
    // 당연한거지만 기본값으로 null을 줄 수는 없다.
    
    int id = 100; // 이는 static final int id=100으로 변환된다. 즉 상수이다.
}

 

@ value 요소

요소의 이름이 value일때는 사용시 이름을 생략할 수 있다.

@interface TestInfo{
	String value();
}

@TestInfo("이렇게 바로 사용할수있음") // value="~"로 취급됨.
class NewClass {...}

 

@ 요소 타입이 배열일 때

괄호 { } 를 사용해서 입력하며, 값이 하나 인경우 괄호를생략해도 된다.

@Test(testTools= {"JUnit", "AutoTester"} )// 배열 타입
@Test(testTools ="JUnit")// 값이 하나일 땐 생략가능
@Test(testTools = {})// 줄 값이 없을땐 빈괄호를 줘야함. testTools; 이런거 안됨.

 

@ 어노테이션의 기본 추상메서드

java.lang.annotation.Annotation 은 모든 어노테이션의 조상 인터페이스이다. 하지만 extends로 상속은 할 수는 없다.(하면 컴파일 에러) 그럼에도 불구하고 이렇게 만든 이유는, Object의 메서드처럼 모든 어노테이션이 가지고 있는 추상메서드를 제공하기 위해서이다.

package java.lnag.annotation;

public interface Annotation{
    boolean equals(Object obj);
    int hashCode();
    String toString();
    
    Class<? extends Annotation> annotationType(); // 어노테이션 타입반환
}

 

@ Marker 어노테이션

거창한건 아니고, 요소없이 비어있는 어노테이션을 의미한다. 이름 그대로 특정 필드, 메서드를 구분할 마커로 쓰인다.

@Target(METHOD)
@Retention(SOURCE)
public @interface Test{} // 마커 어노테이션

@Test // 테스트 표시용도.
public void method(){...}

@Deprecated // 사용하면 경고띄우는 용도.
public int getDate(){...}