F012 - Annotation

✍️ 자바의 신 후반부에 Annotation에 대해서 공부했다.
3주차 멘토링 중, 멘토님께서 Lombok이 우리가 작성한 소스코드에 어떻게 개입하는지 여쭤보셨는데 응용이 되지 않아서 대답도 못하는 꿀먹은 벙어리가 되었다.
이번 시간에는 Annotation에 대해서 간단히 정리해보자!

---

Annotation

얼마 전 공부한 내용 중, @Override Annotation(이하 어노테이션)에 대해서 공부했다. @Override 어노테이션은 부모 클래스에서 정의한 생성자 혹은 메소드를 상속받는 자식클래스에서 재정의 할 때, 해당 생성자 혹은 메소드는 재정의된 상태하는 것이라고 명시적으로 나타내기 위해 사용된다.

해당 어노테이션의 소스코드를 확인해보면, @Override 어노테이션은 1. 메소드 영역에서 사용 할 수 있으며 2. 컴파일러에 의해 컴파일 시 소스코드에서 제거된다.

package java.lang;

import java.lang.annotation.*;

/**
 * Indicates that a method declaration is intended to override a
 * method declaration in a supertype. If a method is annotated with
 * this annotation type compilers are required to generate an error
 * message unless at least one of the following conditions hold:
 *
 * <ul><li>
 * The method does override or implement a method declared in a
 * supertype.
 * </li><li>
 * The method has a signature that is override-equivalent to that of
 * any public method declared in {@linkplain Object}.
 * </li></ul>
 *
 * @author  Peter von der Ah&eacute;
 * @author  Joshua Bloch
 * @jls 9.6.1.4 @Override
 * @since 1.5
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

 

🔎 메소드 영역에서 사용가능하다. → @Target(ElementType.METHOD)

🔎 컴파일러에 의해 컴파일 시 소스코드에서 제거된다. → @Retention(RetentionPolicy.SOURCE)

@Override 어노테이션은 Java에서 기본 제공해주는 3 가지 어노테이션 중 하나인데, 위의 코드를 통해 이러한 기본 어노테이션도 @Targe, @Retention 같은 어노테이션 설정을 위한 어노테이션으로 설정되어 있는 것을 확인 할 수 있다. 이러한 어노테이션은 Meta Annotation이라고 한다.

Annotation 뽑아먹기

📍 어노테이션은 메타 데이터로써, 컴파일 과정과 실행 과정 중 해당 어노테이션을 통해 어떻게 처리 할 것인지 명시하는 역할을 수행한다.

📍 Java에서 기본으로 제공하는 어노테이션으로는 @Override, @Deprecated, @SuppressWarning 이 존재하며, Java 7에서 @SafeVarargs, Java 8에서 @FunctionalInterface 를 지원한다.

Meta Annotation

Meata Annotation(이하 메타 어노테이션)이란 어노테이션을 만들기 위한 설정을 도와주는 어노테이션으로 java.lang.annotation 패키지 내에 위치해있으며 코드를 살펴보면 자신 또한 메타 어노테이션으로 구성되어 있다.

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

이러한 메타 어노테이션은 새롭게 만들 어노테이션이 어디에 사용될지, 어떤 시점에서 적용될지, API 문서에 등록을 할지 등을 설정 할 수 있다. 다음 리스트를 통해 확인해보자.

📍 @Target
ElementType[]을 value 값으로 가지며, 해당 배열을 통해 해당 어노테이션이 어디에 적용 가능한지 설정 할 수 있다. 해당 메타 어노테이션은 하나의 어노테이션에서 여러 개의 타깃을 설정 할 수 있다.

✔️ ElementType.TYPE : 클래스, 인터페이스 혹은 이넘 타입에 적용 가능하다. 
✔️ ElementType.FIELD : 클래스 내 필드에 적용 가능하다. 
✔️ ElementType.METHOD : 메소드에 적용 가능하다. 
✔️ ElementType.CONSTRUCTOR : 생성자에 적용 가능하다. 
✔️ ElementType.PARAMETER : 매개 변수 인자에 적용 가능하다. 
✔️ ElementType.LOCAL_VARIABLE : 메소드 혹은 생자 내의 지역 변수에 적용 가능하다. 
✔️ ElementType.ANNOTATION_TYPE : 어노테이션 타입에 적용 가능하다. 
✔️ ElementType.PACKAGE : 패키지에 적용 가능하다. 
✔️ ElementType.TYPE_PARAMETER : Java 8 부터 추가되어 타입 파라미터에 적용 가능하다. 
✔️ ElementType.TYPE_USE : Java 8 부터 추가되어 해당 타입이 사용된다는 것을 명시한다.

📍 @Retetion 
RetentionPolicy[]을 value 값으로 가지며, @Target 어노테이션과 동일하게 여러 개의 설정값을 지정 할 수 있다. 해당 어노테이션은 어떤 시점에 어노테이션을 적용할지 설정한다.

✔️ RetetionPolicy.SOURCE : 컴파일러에 의해 적용에서 제외된다. 
✔️ RetetionPolicy.CLASS : 컴파일러에 의해 .class 파일로 컴파일 될 때 적용되지만 Runtime 시점까지는 유효하지 못한다. 
✔️ RetetionPolicy.RUNTIME : 리플렉션에 의해 컴파일 이후에도 지속적으로 참조가 가능하다.

📍 @Documented 
해당 메타 어노테이션은 적용된 어노테이션이 자바 API 문서에 등록될지를 설정 할 수 있다.

📍 @Inherited 
해당 메타 어노테이션은 적용된 어노테이션에 상속의 기능 부여에 대한 설정을 담당한다.

📍 @Repeateble
Java 8 부터 추가되어 연속적으로 어노테이션을 적용 할 수 있도록 지원한다.

Custom Annotation

package annotation;

import java.lang.annotation.*;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.SOURCE)
@Inherited
public @interface Auth {
    String name();

    String date();

    String description();
}

/*
	@Auth(name = "심성헌", date = "2021-05-24", description = "커스텀 어노테이션을 만들어보자!")
    public class AnnotationTest {}
*/

---

🤖 이번 시간에는 Lombok 디컴파일을 알아보기 위해 Annotation이 어떻게 구성되고 만들어지는지 알아보았다. 다음 시간에는 우리가 주로 사용하는 어노테이션들이 어떻게 동작하는지 알아보자!