2022-02-17-목.md

3-2.리플렉션 API: 어노테이션 정보 조회

어노테이션 만들기

public @interface MyAnnotation { ...}

• 기본적으로 어노테이션은 주석과 같은 취급이다. 그래서 클래스 로딩되어 바이트코드를 읽어 클래스 정보가 메모리에 올라갈 때 클래스에 붙은 어노테이션 정보는 제외하고 올라간다.
• 메모리에 어노테이션 정보도 함께 올려 런타임시에도 유지하고 싶다면?
  • @Retention 어노테이션 사용

중요 어노테이션

• @Retention: 해당 어노테이션을 언제까지 유지할 것인가?
• @Target: 어디에 사용할 수 있는가? → 클래스, 필드, 생성자 ..
• @Inherit: 해당 어노테이션을 하위 클래스까지 전달할 것인가?

@Retention(RetentionPolicy.RUNTIME) //런타임시까지 유지
@Target({ElementType.TYPE, ElementType.FIELD}) //클래스, 필드에 사용
@Inherited
public @interface MyAnnotation { ...}

어노테이션에 필드 추가하기

• 어노테이션에도 필드를 추가할 수 있다. ex) name, age 필드 추가

  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      String name();
  
      int age();
  }

  
  사용 방법: 어노테이션 사용시 필드에 값을 매번 추가해 줘야 한다.

  @MyAnnotation(name = "chocho", age = 27)
  public class Book { ... }

• default 키워드

  • default 키워드를 사용하면 필드에 값 설정을 생략할 경우 필드의 default 값이 들어간다.

  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      String name() default "chowon";
  
      int age() default 27;
  }

  
  사용 방법

  @MyAnnotation
  public class Book { ... }
  

• value 키워드

  • 필드명을 value로 설정하면 어노테이션에 값 설정시, 필드명을 명시할 필요가 없다.
  • 필드가 하나일 때 유용하다.

  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      String value() default "chocho";
  }

  
  

  사용 방법: 필드명을 명시할 필요 없다.

  @MyAnnotation("chovly")
  public class Book { ...}

리플렉션 사용하여 어노테이션 정보 조회하기

1. 클래스 위에 붙은 어노테이션 조회

• 어노테이션에 @Retention을 꼭 붙여야 한다.

  • 붙이지 않으면 메모리에 클래스 정보가 올라갈 때 어노테이션 정보가 제외된다.

  // MyAnnotation.class
  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      // default가 없으면 어노테이션 선언시 직접 값을 매번 입력해야함. 안 주면 에러
      String name() default "chowon";
  
      int age() default 27;
  
      // 값을 하나만 받을 때 유용
      String value() default "chocho";
  }
  
  // Book.class
  @MyAnnotation
  public class Book { ... }
  
  // Main.class
  public class Main {
  
      public static void main(String[] args) {
  
          Arrays.stream(Book.class.getAnnotations()).forEach(System.out::println);
          }
  }
  
  // result
  @chapter03.chapter03_2.MyAnnotation(name="chowon", value="chocho", age=27)

2. 부모 클래스의 어노테이션까지 조회

• @Inhert를 어노테이션에 붙이면 자식 클래스에게까지 어노테이션이 적용된다.

• getAnnotations() 호출하면 자기 자신에게 붙은 어노테이션 뿐만 아니라, 부모 클래스에 붙은 어노테이션도 출력된다.

  // MyAnnotation.class
  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      // default가 없으면 어노테이션 선언시 직접 값을 매번 입력해야함. 안 주면 에러
      String name() default "chowon";
  
      int age() default 27;
  
      // 값을 하나만 받을 때 유용
      String value() default "chocho";
  }
  
  // Book.class
  @MyAnnotation
  public class Book { ... }
  
  // MyBook.class
  @AnotherAnnotation
  public class MyBook extends Book {
  }
  
  // Main.class
  public class Main {
  
      public static void main(String[] args) {
  
          Arrays.stream(MyBook.class.getAnnotations()).forEach(System.out::println);
          }
  }
  
  // result
  @chapter03.chapter03_2.MyAnnotation(name="chowon", value="chocho", age=27)
  @chapter03.chapter03_2.AnotherAnnotation(name="chovly", value="princess bubblegum", age=30)

3. 상속받은 어노테이션 제외하고 조회

• getDeclaredAnnotations()

  • 부모 클래스로 상속받은 어노테이션은 제외하고 자신에게만 붙은 어노테이션 조회

  Arrays.stream(MyBook.class.getDeclaredAnnotations()).forEach(System.out::println);

4. 필드에 붙어 있는 어노테이션 조회

• 어노테이션 생성시 @Target에 ElementType.FIELD 추가

  @Retention(RetentionPolicy.RUNTIME)
  @Target({ElementType.TYPE, ElementType.FIELD})
  @Inherited
  public @interface MyAnnotation {
  
      // default가 없으면 어노테이션 선언시 직접 값을 매번 입력해야함. 안 주면 에러
      String name() default "chowon";
  
      int age() default 27;
  
      // 값을 하나만 받을 때 유용
      String value() default "chocho";
  }

• 그러면 어노테이션을 클래스의 필드에 붙일 수 있다.

  public class Book {
      private static StringB= "BOOK";
  
      private static final StringC= "BOOK";
  
      private String a = "a";
  
      @AnotherAnnotation // 필드위에 추가
      public String d = "d";
  
      @MyAnnotation // 필드위에 추가
      protected String e = "e";
  		
  		...
  }

• 조회

  Arrays.stream(Book.class.getDeclaredFields()).forEach(f -> {
      Arrays.stream(f.getAnnotations()).forEach(System.out::println);
  });
  
  // result
  @chapter03.chapter03_2.AnotherAnnotation(name="chovly", value="princess bubblegum", age=30)
  @chapter03.chapter03_2.MyAnnotation(name="chowon", value="chocho", age=27)

4. 어노테이션 정보들 꺼내기

• 특정 어노테이션 정보만 꺼낼 수 있다.

• 어노테이션의 필드 값을 꺼낼 수 있다.

  Arrays.stream(Book.class.getDeclaredFields()).forEach(f -> {
      Arrays.stream(f.getAnnotations()).forEach(a -> {
          if (a instanceof MyAnnotation) { // 특정 어노테이션만 정보를 출력
              MyAnnotation myAnnotation = (MyAnnotation) a;
              System.out.println("name = " + myAnnotation.name());
              System.out.println("age = " + myAnnotation.age());
          }
      });
  });
  
  // result
  name = chowon
  age = 27