[Spring] 어노테이션의 정의와 동작원리

📌 들어가며

SpringBoot를 이용해 개발을 하다보면 정말 많이 사용하게 되는 것 중 하나가 어노테이션입니다. 종류도 매우 다양하며(@RestController, @Component.. 등) Personal 어노테이션을 만들 수도 있습니다. 오늘은 이러한 Spring에서 어노테이션의 정의와 동작원리에 대해서 알아보도록 하겠습니다.

 

📌 Annotation 의 정의

어노테이션에 대한 정의를 자바 공식 문서에서 찾아보면

 

https://docs.oracle.com/javase/tutorial/java/annotations/

Lesson: Annotations (The Java™ Tutorials > Learning the Java Language)

 

Annotations, a form of metadata, provide data about a program that is not 
part of the program itserlf. Annotaions have no direct effect on the operation of the code they annotate.

 

사전적인 의미로는 주석을 뜻하며 즉, 코드 사이에 주석처럼 쓰이면서 특별한 의미, 기능을 수행하도록 하는 기술로 

코드의 동작에는 직접적으로 영향을 주지 않고

프로그램에게 추가적인 정보를 제공해주는 메타 데이터입니다.

 

일반적으로 아래와 같은 세 가지 용도로 활용됩니다.

• 컴파일러에게 코드 작성 문법 에러를 체크하도록 정보를 제공
• 소프트웨어 개발툴이 빌드나 배치 시 코드를 자동으로 생성할 수 있도록 정보를 제공
• 런타임 시 특정 기능을 실행하도록 정보를 제공

 

📌 Annotation 파일 정의하기

@Target({ElementType.[적용대상]})
@Retention(RetentionPolicy.[정보유지되는 대상])
public @interface [어노테이션 이름]{
    ...
}

어노테이션 파일은 위와 같이 정의하며 각 상황에 맞게 필요에 따라 적용할 수 있습니다.

 

Target 설정

ElementType Enum 값
ANNOTATION_TYPE	어노테이션 선언
CONSTRUCTOR	생성자 선언
FIELD	필드 선언 (열거 형 상수 포함)
LOCAL_VARIABLE	지역 변수 선언
METHOD	메서드 선언
PACKAGE	패키지 선언
PARAMETER	Public Parameter
TYPE	클래스, 인터페이스(주석 유형 포함) 또는 열거 형 선언
TYPE_PARAMETER	Type 파라미터 선언 (java 8에 추가)
TYPE_USE	Type 이 상요되는 곳 (java 8dp 추가)

 

Retention 설정

RetentionPolicy Enum 값
CLASS	컴파일러에 의해 클래스 파일에 기록되지만 런타임에는 유지되지 않습니다.
RUNTIME	컴파일러에 의해 클래스 파일에 기록되고 런타임에 유지됩니다.
SOURCE	소스에만 반영되어 컴파일러에 의해 삭제됩니다.

 

📌 Annotation의 동작원리

Annotation 의 동작원리는 아래 그림과 같습니다.

 

Annotation Processor가 해당 Annotation 과 Annotation이 붙은 부분을 수집해서 byte code를 만들고 .class 파일을 만듭니다.

이 과정에서 Parser는 수집(실행)되지 않은 Annotation Processor 가 있는지 확인한 후 

모두 수행할 때까지 작업을 반복합니다.

 

Oracle 은 Processing 의 반복 횟수를 Round 라고 부릅니다. 한 Round에서는 하나의 Annotation을 통해 

Boilerplate code를 만들고 나서 다시 Parser가 검사를 하는데 이때 Annotation이 중첩되어 있는 경우

아직 동작하지 않은(Boilerplate code를 만들지 않은) Annotation이 있을 수 있기 때문입니다.

 

.class 파일을 기반으로 jvm 의 클래스 로더에 올라가는데 그전에 annotation 이 붙은 코드들이 잘 바뀌어야 합니다.

 

 

 

참고:

https://hirlawldo.tistory.com/43

https://velog.io/@gale4739/Spring-Boot-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98

https://developer-youn.tistory.com/122

https://honeyinfo7.tistory.com/56