[Java] 애노테이션

👩‍🚀 목표

자바의 애노테이션에 대해 학습하세요.

👩‍💻 학습할 것

• 애노테이션 정의하는 방법
• @retention
• @target
• @documented
• 애노테이션 프로세서

 

 

 

Annotation

• 인터페이스 기반으로 주석처럼 프로그래밍 언어에 영향을 미치지 않으며 프로그램에 대해 의미를 부여하거나 기능을 제공한다.
• JDK 1.5에 추가되었다.
• JDK에서 제공하는 annotation은 java.lang.annotation 패키지에 포함되어 있다.
• Built in Annotation과 Meta-Annotation으로 나뉘며 개발자가 직접 만들어내는 Custom Aannotation이 있다.

 

용도

• Information for the compiler- Annotations can be used by the compiler to detect errors or suppress warnings.
  
  • 주석은 컴파일러에서 오류를 감지하거나 경고를 억제하는 데 사용할 수 있다.
• Compile-time and deployment-time processing -  Software tools can process annotation information to generate code, XML files, and so forth.
  • 소프트웨어 도구는 주석 정보를 처리하여 코드, XML 파일 등을 생성할 수 있다.
• Runtime processing -  Some annotations are available to be examined at runtime.
  • 일부 주석은 런타임에 검사할 수 있다.

 

Built-in Annotation

• JDK에 내장되어 있다.

 

@Override

• 메서드 앞에만 붙일 수 있다.
• 수퍼클래스의 메소드를 오버라이딩 한 것이라는 것을 컴파일러에게 알려준다.
  • 오타가 발생한 부분을 잡아낼 수 있다.
  • → @Override 안쓰면 컴파일러는 새로운 이름의 메서드가 추가된 것으로 인식

class Child extends Parent {
    @Override
    void parentmethod();
}

 

 

@Deprecated

• 더 이상 사용되지 않는 필드나 메서드에 붙인다.
• 예를 들어 java.util.Date의 대부분의 메서드에는 이 어노테이션이 붙어있다.
• 기존의 것 대신 새로 추가된 개선된 기능을 사용하도록 유도한다.

 

 

 

Meta-Annotation

• 어노테이션에 대한 정보를 나타내는 어노테이션

 

@Target

• 어노테이션이 적용가능한 대상을 지정하는데 사용
• 여러 값을 지정할 때는 괄호 { } 를 사용
• 적용 대상 종류 : ANNOTATION_TYPE, CONSTRUCTOR, FILD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE, TYPE_PARAMETER, TYPE_USE

 

@Retention

• 어노테이션이 유지되는 기간을 지정하는데 사용
• 유지정책은 세가지가 있다.

유지 정책 retention policy

• SOURCE : 소스 파일에만 존재 🙆‍♀️, 클래스파일에는 존재 🙅‍♀️
• CLASS : 클래스 파일에 존재 🙆‍♀️, 실행시 사용 🙅‍♀️, Default
• RUNTIME : 클래스 파일에 존재 🙆‍♀️, 실행시 사용 🙆‍♀️'

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {}

 

 

@Documented

• 어노테이션에 대한 저보가 javadoc으로 작성한 문서에 포함되도록 한다.
• 자바에서 제공하는 기본 애너테이션 중에 @Override와 @SuppressWarnings를 제외한 어노테이션에 붙어있다. 

 

 

 

커스텀 애너테이션 정의

• @기호를 붙이는 것을 제외하면 인터페이스를 정의하는 것과 동일하다.
• 모든 애너테이션의 조상은 Annotation이다.
  • 암묵적으로 java.lang.annotation.Annotation 확장
  • → equals(), hashCode(). toString() 사용 가능
• 애너테이션은 상속 허용🙅‍♀️ → 명시적으로 조상으로 지정할 수 없다. 
• 애너테이션의 요소는 반환값이 있고, 매개변수는 없는 추상 메서드의 형태를 가진다.
• 요소의 타입은 기본형, String, enum, 애너테이션, Class만 허용한다.
• ( ) 안에 매개변수를 선언할 수 없다.
• 예외를 선언할 수 없다.
• 요소를 타입 매개변수로 정의할 수 없다.

@interface 애너테이션명 {
    타입 요소명();
    int count();
    String[] testTools();
    TestType testType();
}

 

• 각 요소는 기본값을 가질 수 있으며 값을 지정하지 않으면 기본 값이 사용된다.
  • 기본값으로 null을 제외한 모든 리터럴이 가능하다.

@interface TestInfo {
    int count() default 1;
}

@TestInfo // @TestInfo(count=1)과 동일
public class NewClass { ... }

 

• 애너테이션 요소가 하나뿐이고 이름이 value일 때, 요소의 이름을 생략하고 값만 적어도 된다.

@interface TestInfo {
    String value();
}

@TestInfo("passed")   // @TestInfo(value="passed")와 동일
class NewClass {...}

 

 

 

애노테이션 프로세서

• 자바 컴파일러 플러그인 일종
• 어노테이션에 대한 코드베이스를 검사, 수정, 생성하는 역할
• 어노테이션을 사용하기 위해 어노테이션 프로세서가 필요
• 컴파일러가 컴파일 하는 중에 새로운 소스코드를 생성하거나 기존 소스코드 변경 가능
• 클래스(바이트코드)도 생성할 수 있고 별개의 리소스 파일을 생성할 수 있는 강력한 기능

 

사용 예

• 롬복 : 기존코드 변경
• AutoService : 리소스 파일 생성
• @Override

 

동작구조

1. 어노테이션 프로세서를 사용한다는 것을 자바 컴파일러가 알고있는 상태에서 컴파일 수행

2. 어노테이션 프로세서들이 각자의 역할에 맞게 구현되어 있는 상태에서 실행되지 않은 어노테이션 프로세서 실행

3. 어노테이션 프로세서 내부에서 어노테이션에 대한 처리

4. 자바 컴파일러가 모든 어노테이션 프로제서가 실행되었는지 검사하고, 모든 어노테이션 프로세서가 실행되지 않았다면 반복

 

 

 

 

 

참조

12주차 과제: 애노테이션

남궁성, 자바의 정석 기초편, 도우출판, 2019

어노테이션 프로세서