어노테이션의 사전적 정의는 주석이다. 하지만 우리가 일반적으로 말하는 JAVA의 주석과는 다르다.

어노테이션은 코드에 메타데이터를 제공. 이는 코드의 의미를 명확하게 하고, 코드의 동작을 변경하거나 프레임워크와 상호작용하는 방법을 제공.

형태는 ‘@…’로 클래스, 인터페이스, 메소드, 필드, 지역 변수 위에 사용 가능.

• 어노테이션을 사용하는 이유 (효과) 는 무엇일까?

• 코드 반복을 줄일 수 있다. → 간결하고 유연한 코드 → 유지보수 향상
  • 예시
• 가독성이 증가한다.
  • 예시

• 나만의 어노테이션은 어떻게 만들 수 있을까?

• 커스텀 어노테이션 - 필요한 기능을 직접 구현한 어노테이션

  • @interface로 어노테이션 정의
  • 포함할 요소(=어노테이션 안의 추상 메서드) 추가
  • 반환 값이 있고 매개 변수가 없는 추상 메서드로 작성

  <예시 1.>

  //함수와 클래스에 사용가능
  @Target({ElementType.METHOD, ElementType.TYPE})
  @Retention(RetentionPolicy.RUNTIME)
  public @interface CustomAnnotation {
  		//별칭
  		//@CustomAnnotation("testvalue")와 @CustomAnnotation(name = "testvalue")을 동일하게 사용 가능
      @AliasFor("value")
      String name() default "defaultValue";
      @AliasFor("name")
      String value() default "defaultValue";
      
      String[] stringArr() default "";
  }
  

  @Target - 어노테이션이 적용될 수 있는 타켓을 지정한다. 하나일 경우에는 ‘@Target(ElementType.TYPE)’처럼 작성되고 복수 타겟에 적용될 때에는 위처럼 배열형식으로 작성한다.

  1. ElementType.TYPE: 클래스, 인터페이스 등
  2. ElementType.FIELD: 필드(멤버 변수)
  3. ElementType.METHOD: 메서드
  4. ElementType.PARAMETER: 메서드 혹은 생성자의 파라미터
  5. ElementType.CONSTRUCTOR: 생성자
  6. ElementType.LOCAL_VARIABLE: 로컬 변수
  7. ElementType.ANNOTATION_TYPE: 다른 어노테이션
  8. ElementType.PACKAGE: 패키지
  9. ElementType.TYPE_PARAMETER: 타입 매개변수(Java 8 이후)
  10. ElementType.TYPE_USE: 타입 사용(Java 8 이후)

  @Retention - 어노테이션의 유지 정책을 지정

  1. SOURCE: 컴파일 이후 소스코드에서 유지X. 컴파일 타임에만 사용할 경우에 주로 사용.
  2. CLASS: 컴파일된 클래스 파일에는 유지되지만, 런타임 중에는 사용X.
  3. RUNTIME: 런타임 시에도 사용. 대부분의 커스텀 어노테이션에서 사용.

  @AliasFor - 필수요소는 아니지만, 스프링의 어노테이션들의 내부 코드를 보면 자주 보이는 요소이다. 이는 어노테이션 속성에 별칭을 정의한다. 동일한 값에 대해 여러 속성 이름을 사용할 수 있다.

  default - 디폴트 값을 지정할 수 있다.

  커스텀 어노테이션은 실무에서 꼭 필요한 경우에만 사용하도록 한다. 커스텀 어노테이션이 다수 존재하면 코드를 읽는 데에 불편함을 겪는다. 최대한 기존에 존재하는 어노테이션들을 이용하자.

• 추가 내용 및 의문점

• 참고 링크