[Spring] Meta Annotation이란? (@Target, @Retention 등)

🌱 어노테이션의 기본 구조

이미 선언되어 있는 어노테이션을 보면 기본적으로 @Target, @Retention이 설정되어 있는 것을 볼 수 있다.

여기서 이 @Target, @Retention이 뭘까?

 

🌱 Meta Annotation이란?

메타 어노테이션은 어노테이션을 정의할 때 사용되는 어노테이션이다.

메타 어노테이션은 다른 어노테이션 위에 선언되어 그 어노테이션의 사용 방법과 동작을 지정한다.

 

🫧 @Retention

어노테이션을 언제까지 유지할것인지 지정한다.

소스 코드, 클래스 파일, 런타임 중 어느 시점까지 어노테이션 정보를 유지할지를 결정한다.

1️⃣ @Retention(RetentionPolicy.SOURCE)

컴파일 전까지만 유지되는 어노테이션이 필요한 경우 사용하는 옵션, 컴파일러에 의해 제거된다.

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.SOURCE)
public @interface Getter {
}

@Getter 어노테이션은 Getter 메서드를 생성하기 위해 소스 코드 수준에서만 필요하다. 즉, 컴파일 시에만 해당 어노테이션 정보가 필요하며, 런타임에는 더 이상 해당 정보가 필요하지 않기 때문에 SOURCE 옵션을 사용한다.

2️⃣ @Retention(RetentionPolicy.CLASS)

컴파일러에 의해 .class 파일에 기록되지만 런타임에는 사라진다.

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
@Constraint(validatedBy = { })
public @interface NotNull {
}

@NotNull 어노테이션은 해당 어노테이션을 선언한 필드가 null이 아닌 값을 가져야 함을 나타낸다.

이 어노테이션은 필드의 유효성을 검사하는 역할을 하기 때문에 컴파일된 클래스 파일에만 어노테이션 정보가 유지되어야 하고, 런타임에는 해당 어노테이션 정보가 더 이상 필요하지 않기 때문에 CLASS 옵션을 사용한다.

3️⃣ @Retention(RetentionPolicy.RUNTIME)

컴파일러에 의해 .class 파일에 기록되고, JVM에 의해 어노테이션이 유지된다.
즉, Java로 작성한 코드가 돌아가는 동안에는 계속 유지된다는 의미이다.

@Retention(RetentionPolicy.RUNTIME)
@Target(value = { FIELD, METHOD, ANNOTATION_TYPE })
public @interface LastModifiedDate {
}

스프링에서 대부분의 어노테이션은 RUNTIME 옵션을 사용한다. @LastModifiedDate 어노테이션은 엔티티의 마지막 수정일을 나타내는데, 데이터베이스에서 엔티티가 수정될 때마다 해당 필드에 현재 시간을 자동으로 할당해야 하므로 RUNTIME 옵션을 사용한다.

 

🫧 @Target

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

클래스, 필드, 메서드 등의 어느 요소에 어노테이션을 적용할 수 있는지를 결정한다.

1. @Target({ElementType.TYPE})
   : 클래스, 인터페이스, Enum 또는 Record
2. @Target({ElementType.FIELD})
   : 변수
3. @Target({ElementType.METHOD})
   : 메서드
4. @Target({ElementType.PARAMETER})
   : 메서드의 파라미터(클라이언트에서 전달 받는 API의 파라미터들에 자주 사용됨)
5. @Target({ElementType.CONSTRUCTOR})
   : 생성자
   
6. @Target({ElementType.LOCAL_VARIABLE})
   : 변수 중 지역 변수만
7. @Target({ElementType.ANNOTATION_TYPE})
   : 어노테이션
8. @Target({ElementType.PACKAGE})
   : 패키지. 패키지 정보를 기록하는 역할
9. @Target({ElementType.TYPE_PARAMETER})
   : 타입 변수(ex. 제네릭에 선언하는 타입 등)
10. @Target({ElementType.TYPE_USE})
    : 타입 변수 뿐 아니라 모든 타입
11. @Target({ElementType.RECORD_COMPONENT})
    : 레코드
12. @Target({ElementType.MODULE})
    : 모듈

 

🫧 @Documented

해당 어노테이션이 javadoc에 포함되도록 지정한다.

즉, 해당 어노테이션의 사용법과 설명이 문서화된다.

@Documented
@Retention(RUNTIME)
public @interface Nonnull {
}

 

🫧 @Inherited

해당 어노테이션이 상속될 수 있도록 지정한다.

즉, 부모 클래스에 선언된 어노테이션이 자식 클래스에도 적용되도록 한다.

@Inherited
@InterceptorBinding
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Transactional {
}