[이펙티브 자바] Item27 완벽공략. 애너테이션

 

item27. 비검사 경고를 제거하라. 

[이펙티브 자바] Item27. 비검사 경고를 제거하라. (tistory.com)

[이펙티브 자바] Item27. 비검사 경고를 제거하라.

 

어노테이션 annotation 이란? 

: 자바에서 어노테이션은 사전적인 의미로는 주석이라는 뜻으로 소스코드에 추가해서 사용할 수 있는 일종의 메타 데이터의 일종이다. 

메타 데이터란 애플리케이션이 처리해야할 데이터가 아니라 컴파일 과정과 실행 과정에서 코드를 어떻게 처리해야하는지를 알려주기 위한 추가 정보이다. 

 

 

자바 어노테이션의 기능 

- 컴파일러에게 코드 작성 문법 에러를 체크하도록 정보 제공 

- 소프트웨어 개발 환경이 빌드나 배포시 코드를 자동으로 생성할 수 있도록 정보 제공 

- 런타임에 특정 기능을 실행하도록 정보 제공 

 

 

@Target({ElementType.TYPE, ElementType.METHOD}) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface MyAnnotation
{

}

@MyAnnotation
public class MyClass
{
   @MyAnnotation
   public static void main(String[] args)
   {
      Arrays.stream(MyClass.class.getAnnotations()).forEach(System.out::println);
   }
}

@Documented 

: 간단한 어노테이션으로 이 어노테이션을 사용한 코드의 javadoc에 해당 어노테이션 정보가 포함되도록 하는 어노테이션이다. 

 

@Retention 

: 어노테이션의 정보를 얼마나 오래 유지할 것인가. 

RetentionPolicy.RUNTIME, SOURCE, CLASS 으로 범위를 정할 수 있다. 

RUNTIME : 바이트 코드 파일까지 어노테이션  정보를 유지하면서 리플렉션을 이용해 런타임에 어노테이션 정보를 가져올 수 있다. 

SOURCE :  compile 이후에는 삭제된다. 

CLASS : 바이트 코드 파일까지 어노테이션 정보는 유지하지만, 리플렉션을 이용해서 어노테이션 정보를 가져올 수 는 없다. 

 

@Target

: 어노테이션을 사용할 수 있는 위치 

ElementType.Tye, Filed, Method, Parameter .... 

Type : 클래스, 인터페이스, 열거타입 

Filed : 필드 

Method: 메서드 

... 

 

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    /**
     * The set of warnings that are to be suppressed by the compiler in the
     * annotated element.  Duplicate names are permitted.  The second and
     * successive occurrences of a name are ignored.  The presence of
     * unrecognized warning names is <i>not</i> an error: Compilers must
     * ignore any warning names they do not recognize.  They are, however,
     * free to emit a warning if an annotation contains an unrecognized
     * warning name.
     *
     * <p> The string {@code "unchecked"} is used to suppress
     * unchecked warnings. Compiler vendors should document the
     * additional warning names they support in conjunction with this
     * annotation type. They are encouraged to cooperate to ensure
     * that the same names work across multiple compilers.
     * @return the set of warnings to be suppressed
     */
    String[] value();
}

@SuppressWarnings 어노테이션의 @Retention을 보면 SOURCE까지로 compile 이후에는 삭제된다. 

그리고 @Target을 보면 어노테이션이 선언에만 달 수 있다는 것도 알 수 있다.