JAVA | Annotation과 그 종류

 🤔 Annotation : 에너테이션이란 ?

---

자바 애너테이션(Java Annotation) : 자바 소스 코드에 추가하여 사용할 수 있는 메타데이터의 일종

 

- 보통 @ 기호를 앞에 붙여서 사용

- JDK 1.5 버전 이상에서 사용 가능

- 클래스 파일에 임베디드되어 컴파일러에 의해 생성된 후 자바 가상머신에 포함되어 작동

 

어노테이션은 @어노테이션이름(속성1=값1, 속성2=값2, ...) 형태로 사용하며, 주로 클래스, 메서드, 변수, 매개변수 등에 부착하여 사용됩니다.

 

* 메타데이터 : 애플리케이션이 처리할 데이터가 아닌, 컴파일 과정과 실행 과정에서 코드를 어떻게 처리해야 하는지 알려주는 추가 정보

 

 

📌 에너테이션의 필요성 

---

기존의 파일 관리 방법

과거의 파일 관리는 자바 코드와 관련 설정 파일을 따로 저장하고, 그 때마다 version을 구분하여 관리했다.

위은 관리방법은 다음과 같은 단점이 있었다.

  1. 이용자가 설정 파일을 업데이트 하지 않는 어려움
  2. 설정과 코드가 분리되어있어 개발에 대한 어려움

 

그 해결책으로 다음과 같은 방법이 제시되었다.

 

어노테이션의 적용

 

이로 인해 하나의 파일에서 코드와 설정을 관리할 수 있게 되었다.

 

 

📑 어노테이션의 종류

---

• 표준(내장) 어노테이션 : 자바가 기본적으로 제공해주는 어노테이션
• 메타 어노테이션 : 어노테이션을 위한 어노테이션 
• 사용자정의 어노테이션 : 사용자가 직접 정의하는 어노테이션

 

1. 빌트인 어노테이션(Built-in Annotation)

 

@Override

• 상위 클래스나 인터페이스의 메서드를 오버라이드함을 나타냅니다.
• 상위 클래스(또는 인터페이스)에서 해당 메서드를 찾을 수 없다면 컴파일 에러를 발생 시킵니다

public class Parent {
    public void mother() {
    }

    public void father() {
    }
}

public class child extends Parent {
    @Override
    public void mother() { // good override.
        System.out.println("Mom");
    }

    @Override
    public void daughter() { // Compile-time error.
    }
}

 

@Deprecated

• 해당 요소(클래스, 메서드, 필드 등)가 더 이상 사용되지 않음을 나타냅니다.
• 사용할 경우 컴파일 경고를 발생 키십니다.

 

@SuppressWarnings

• 컴파일러의 경고를 무시하도록 지정합니다.

 

2. 메타 어노테이션(Meta Annotation)

 

@Retention

• 어노테이션의 유지 정책을 지정합니다. (소스, 클래스, 런타임)
• RetentionPolicy.SOURCE : 컴파일 전까지만 유효. (컴파일 이후에는 사라짐)
• RetentionPolicy.CLASS : 컴파일러가 클래스를 참조할 때까지 유효.
• RetentionPolicy.RUNTIME : 컴파일 이후에도 JVM에 의해 계속 참조가 가능. (리플렉션 사용)

 

@Target

• 어노테이션을 부착할 수 있는 대상(클래스, 메서드, 필드 등)을 지정합니다.
• ElementType.PACKAGE : 패키지 선언
• ElementType.TYPE : 타입 선언
• ElementType.ANNOTATION_TYPE : 어노테이션 타입 선언
• ElementType.CONSTRUCTOR : 생성자 선언
• ElementType.FIELD : 멤버 변수 선언
• ElementType.LOCAL_VARIABLE : 지역 변수 선언
• ElementType.METHOD : 메서드 선언
• ElementType.PARAMETER : 전달인자 선언
• ElementType.TYPE_PARAMETER : 전달인자 타입 선언
• ElementType.TYPE_USE : 타입 선언

 

@Documented

• 해당 어노테이션을 javadoc으로 문서화할 것인지를 나타냅니다.

 

@Inherited

• 해당 어노테이션을 상속 가능하도록 지정합니다.

 

 

3. 커스텀 어노테이션(Custom Annotation)

개발자가 직접 정의한 어노테이션으로, 애플리케이션에 맞는 사용자 정의 어노테이션을 만들 수 있습니다.

 

@Target(ElemetType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ObjectId { // Annotation 정의
}

public class SkillSpec { // Annotation 적용
	//
    @ObjectId
    private String old;
    private String name;
    ...
}

 

📋 참고 자료

---

1. https://velog.io/@jkijki12/annotation

[Java] 어노테이션이 뭔데??

 

2. 자바의 정석- 남궁성

 

3. https://bangu4.tistory.com/199

[Java] Annotation 어노테이션 - 총정리

 

4. https://techblog.woowahan.com/2684/

시의적절한 커스텀 어노테이션 | 우아한형제들 기술블로그

⇒ 커스텀 어노테이션을 어떻게 사용해야 하는지를 예시를 들어 설명해주시는데, 커스텀 어노테이션을 자주 사용하는 분들이라면 한번쯤 읽어볼만한 내용인 것 같아 여기에 참고로 넣어둔다.