애너테이션

📌 애너테이션

: 주석처럼 소스코드에 영향을 미치지 않으면서 컴파일러에게 유용한 정보를 제공하는 것 ('@'가 붙은 태그)

 

https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html

Annotation (Java Platform SE 8 )

 

📌 표준 애너테이션

: 자바에서 기본적으로 제공하는 애너테이션

 

✔️ @Override

: 컴파일러에게 오버라이딩하는 메서드라는 것을 알림 → 컴파일러가 같은 이름의 조상메서드가 없으면 오류를 발생시킴!

: 메서드 앞에만 붙일 수 있음

class MyClass extends Object {
    @Override
    public String toString() { ... } // Object 클래스의 toString() 메서드를 오버라이드
}

❗ @Override 애너테이션을 붙이지 않았으면, toString()을 tostring()으로 잘못써도 오류 발생X → 실행 후 어디서 잘못되었는지 알아내기 어려움!

 

✔️ @Deprecated

: 더 이상 사용되지 않는 필드나 메서드에 사용하는 애너테이션, 이 애너테이션이 붙은 대상은 다른 것으로 대체되었으니 더 이상 사용하지 않을 것을 권한다(강제X)는 의미!

: @Deprecated 애너테이션이 붙은 필드나 메서드를 사용하면, 컴파일 에러 X, 해당 필드 또는 메서드가 Deprecated되었다는 메시지만!

:보통 JDK 버전이 업그레드 될 때 사용!

 

✔️ @FunctionallInterface

: '함수형 인터페이스'를 선언할 때, 이 애너테이션을 붙이면 컴파일러가 '함수형 인터페이스'를 올바르게 선언했는지 확인하고, 잘못된 경우 에러를 발생

(함수형 인터페이스는 뒷쪽에 나옴)

 

✔️ @SuppressWarnings

: 컴파일러가 보여주는 경고메시지가 나타나지 않게 억제!

❗ 일반적으로 컴파일러의 경고메시지는 모두 확인하고 해결해서 컴파일 후에 어떠한 메시지도 나타나지 않게 해야함! 그래서 알고도 무시하고 싶을 때 @SuppressWarnings를 사용!

 

@SuppressWarnings("deprecation") // deprecation 관련 경고를 억제
public static void main(String args[]) {
    ...
    @SuppressWarnings("unchecked") // 지네릭스 관련 경고를 억제
    ArrayList<Integer> list = new ArrayList();
}

: @SuppressWarnings({"deprecation", "unchecked"})와 같이 한번에 억제 가능! but 해당 대상에만 애너테이션을 붙여서 경고의 억제 범위를 최소화하는 것이 best! → 나중에 main함수에 추가되는 코드까지 경고가 억제될수도 있기 때문

 

🙋🏻‍♀️ 억제할 수 있는 경고 메시지는 어떤 것이 있나요? (주로 사용되는 것)

✔️ deprecation : @Deprecated가 붙은 대상을 사용해서 발생하는 경고 억제

✔️ unchecked : 지네릭스로 타입을 지정하지 않았을 때 발생하는 경고 억제

✔️ rawtypes : 지네릭스를 사용하지 않아서 발생하는 경고 억제

✔️ varargs : 가변인자의 타입이 지네릭 타입일 때 발생하는 경고를 억제

❕ 오류 메시지에서 대괄호 [] 안에 있는 것이 메시지의 종류

 

✔️ @SafeVarargs

: 메서드에 선언된 가변인자의 타입이 non-reifiable일 경우, 해당 메서드를 선언, 호출하는 부분에서 "unchecked" 경고가 발생하는데, 이 경고를 억제하기 위해서 사용

 

🙋🏻‍♀️ non-reifiable?

👩🏻‍🏫 컴파일 후 제거되는 타입(ex. T) 반대로 reifiable 타입은 컴파일 후 제거X. 대부분의 지네릭 타입은 non-reifiable 타입!

@SafeVarargs // unchecked 경고 억제
@SuppressWarnings("varargs") // varargs 경고 억제
public static <T> List<T> asList(T... a) {
    return new ArrayList<T>(a); // List<Integer> list =  asList(new int[3]);
}

❕ @SafeVarargs으로 'unchecked' 경고는 억제할 수 있지만 'varargs' 경고는 억제할 수 없기 때문에 보통 @SuppressWarnings("varargs")와 함께 사용

 

🙋🏻‍♀️ 그럼 그냥 @SuppressWarnings("unchecked")를 쓰면 되지 않나요?

👩🏻‍🏫 메서드에 선언된 가변인자의 타입이 non-reifiable(ex. 지네릭 타입)일 경우, 해당 메서드를 선언, 호출하는 부분에서 "unchecked" 경고가 발생! 따라서 해당 메서드를 선언부 + 해당 메서드를 호출할 때마다 @SuppressWarnings("unchecked")를 붙여줘야함 but @SafeVarargs를 사용하면 선언부에만 해당 애너테이션을 붙이면 호출할 때 자동으로 경고가 억제!

 

📌 메타 애너테이션

: 애너테이션을 위한 애너테이션, 애너테이션을 정의할 때 애너테이션의 적용 대상(target)이나 유지기간(retention)등을 지정하는데 사용

: 메타 애너테이션도 표준 애너테이션!

 

✔️ @Target

: 애너테이션이 적용가능한 대상을 지정하는데 사용

import static java.long.annotation.ElementType.*;

@Target({FIELD, TYPE, TYPE_USE})
public @interface MyAnnotation { ... }

 

📋 @Target으로 지정할 수 있는 애너테이션 적용대상의 종류

▪ ANNOTATION_TYPE : 애너테이션

▪ CONSTRUCTOR :  생성자

▪  FIELD : 필드(멤버변수, enum상수)

▪  LOCAL_VARIABLE : 지역변수

▪  METHOD : 메서드

▪  PACKAGE : 패키지

▪  PARAMETER : 매개변수

▪  TYPE : 타입(클래스, 인터페이스, enum)

▪  TYPE_PARAMETER : 타입 매개변수

▪  TYPE_USE : 티입이 사용되는 모든 곳

@MyAnnotation // TYPE
class MyClass {
    @MyAnnotation // FIELD
    int i;
    
    @MyAnnotation // TYPE_USE
    MyClass mc
}

 

✔️ @Retention

: 애너테이션이 유지되는 기간을 지정하는데 사용

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FunctionalInterface { ... }

 

📋 @Retention으로 지정할 수 있는 애너테이션 유지정책의 종류

▪  SOURCE : 소스 파일에만 존재 ← 컴파일러를 직접 작성할 것이 아니면 사용할 일이 없음!

▪  CLASS : 클래스 파일에 존재 (기본값)

▪  RUNTIME : 런타임(실행 시)에도 사용가능 (by 리플렉션)

 

🙋🏻‍♀️ 리플랙션?

👩🏻‍🏫  클래스의 메소드, 타입, 변수들에 접근할 수 있도록 해주는 자바 API, Class 객체를 통해서 사용

https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html

Class (Java Platform SE 8 )

import static java.long.annotation.ElementType.*;

@Target(TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value();
}

@MyAnnotation("you can put the value here")
class AnnotationResolver {
    Class<AnnotationResolver> me = AnnotationResolver.class;
    
    MyAnnotation anno = (MyAnnotation) me.getAnnotation(AnnotationResolver.class);
    System.out.println(anno.value()); // you can put the value here
}

❕ getAnnotations()를 통해 모든 애너테이션을 배열로 받을 수도 있음!

 

✔️ @Documented

: 애너테이션에 대한 정보가 javadoc으로 작성한 문서에 포함되도록 함

https://www.geeksforgeeks.org/java-documented-annotations/

Java @Documented Annotations - GeeksforGeeks

 

✔️ @Inherited

: 애너테이션이 자손 클래스에도 상속되도록 하는 것

@Inherited
public @interface MyAnnotation { ... }

@MyAnnotation
class MyClass { ... }

class MyLittleClass extends MyClass { ... } // @MyAnnotation이 붙은 것으로 인식

 

✔️ @Repeatable

: 하나의 대상에 같은 애너테이션을 여러번 붙일 수 있게 하는 것

@Repeatable(ToDos.class)
public @interface ToDo {
    String value();
}

@ToDo("delete test codes")
@ToDo("override inherited method")
class MyClass { ... }

 

❕ 일반적인 애너테이션과 달리 같은 이름의 애너테이션이 여러 개가 하나의 대상에 적용될 수 있기 때문에, 이 애너테이션들을 하나로 묶어서 다룰 수 있는 컨테이너 애너테이션도 추가로 정의해야함! (ex. ToDos.class)

@interface ToDos {
    ToDo[] value();
}

 

✔️ @Native

: 네이티브 메서드에 의해 참조되는 상수 필드에 붙이는 애너테이션

 

🙋🏻‍♀️ 네이티브 메서드?

👩🏻‍🏫 JVM이 설치된 OS의 메서드, 보통 C언어로 작성되며 자바에서는 메서드의 선언부만 정의하고 구현은X, 호출하면 OS의 메서드가 호출됨

❕ 이것을 위해서 자바에 정의된 네이티브 메서드와 OS의 메서드를 연결해주는 작업이 추가로 필요함(JNI의 역할)

 

📌 애너테이션을 직접 만들어보자!

@interface 애너테이션이름 {
    타입 요소이름(); // 애너테이션의 요소 선언
    ...
}

 

✔️ 애너테이션 요소

: 애너테이션 내에 선언된 메서드(반환값O, 매개변수X, 상속을 통해 구현할 필요X)

: 애너테이션을 사용할 때 이 요소들의 값을 빠짐없이 지정해주어야함! (디폴트값 지정 OK)

 

📋 애너테이션 요소 규칙

1️⃣ 요소의 타입은 기본형, String, enum, 애너테이션, Class만 허용

2️⃣ ()안에 매개변수 선언X

3️⃣ 예외 선언X

4️⃣ 요소를 타입 매개변수(T)로 정의X

@interface TestInfo {
    int count() default 1;
    String testedBy();
    String[] testTools() default { "JUnit", "AutoTester" };
    TestType testType() default TestType.FIRST; // enum TestType { FIRST, FINAL }
    DataTime testDate(); //자신이 아닌 다른 애너테이션을 포함O
}

@interface DataTime {
    String yymmdd();
    String hhmmss();
}

@TestInfo(testedBy="aaa", 
        testDate=@DateTime(yymmdd="230719", hhmmss="010859"))

 

❕ 애너테이션 요소가 하나뿐이고 이름이 value인 경우, 애너테이션을 사용할 때 요소의 이름을 생략해도 됨

@interface TestInfo { String value(); }

@TestInfo("passed")
class MyTest() { ... }

 

❕ 모든 애너테이션의 조상은 Annotation임. 하지만 애너테이션은 상속 허용X 

❕ 애너테이션에 요소가 하나도 정의되어 있지 않으면 마커 애너테이션이라고 함!