언어/JAVA

[Effective Java] 명명 패턴보다 애너테이션을 사용하라

2020. 4. 1. 21:49
반응형

아이템 39 : 명명 패턴보다 애너테이션을 사용하라

 

전통적으로 도구나 프레임워크가 특별히 다뤄야 할 프로그램 요소에는 딱 구분되는 명명 패턴을 적용해왔다. 예컨데 테스트 프레임워크인 JUnit은 버전 3까지 테스트 메서드 이름을 test로 시작하게끔 했다. 효과적인 방법이지만 단점도 크다.

첫 번째, 오타가 나면 안 된다. 실수로 이름을 testSafetyOverride로 지으면 JUnit 3은 이 메서드를 무시하고 지나치기 때문에 개발자는 이 테스트가 통과했다고 오해할 수 있다.

두 번째, 올바른 프로그램 요소에서만 사용되리라 보증 할 방법이 없다는 것이다. 클래스 이름을 TestSafetyMechanisms로 지어 JUnit에 던져줬다고 해보자. 개발자는 이 클래스에 정의된 테스트 메서드들을 수행해주길 기대하겠지만 JUnit은 클래스 이름에는 관심이 없다. 경고 메시지조차 출력되지 않고, 테스트도 전혀 수행되지 않는다.

세 번째, 프로그램 요소를 매개변수로 전달할 마땅한 방법이 없다는 것이다.

 

애너테이션은 이 모든 문제를 해결해주는 멋진 개념으로, JUnit도 버전 4부터 전면 도입하였다.

 

애너테이션 선언에 다는 애너테이션을 메타애너테이션이라 한다.

 

여러 개의 값을 받는 애너테이션을 만드는 방법으로 애너테이션에 @Repeatable 메타애너테이션을 다는 방식이 있다.

@Repeatable을 단 애너테이션은 하나의 프로그램 요소에 여러 번 달 수 있다. 단, 주의할 점이 있다.

첫 번째, @Repeatable을 단 애너테이션을 반환하는 '컨테이너 애너테이션'을 하나 더 정의하고, @Repeatable에 이 컨테이너 애너테이션의 class 객체를 매개변수로 전달해야 한다.

두 번째, 컨테이너 애너테이션은 내부 애너테이션 타입의 배열을 반환하는 value 메서드를 정의해야 한다.

세 번째, 컨테이너 애너테이션 타입에는 적절한 보전 정책과 적용 대상을 명시해야 한다. 그렇지 않으면 컴파일되지 않을 것이다.

 

애너테이션으로 할 수 있는 일을 명명 패턴으로 처리할 이유가 없다.

 

도구 제작자를 제외하고는 , 일반 프로그래머가 애너테이션 타입을 직접 정의할 일은 거의 없다. 하지만 자바 프로그래머라면 예외 없이 자바가 제공하는 애너테이션 타입들은 사용해야 한다.

 

핵심 정리

명명 패턴보다는 애너테이션을 사용하는게 좋다. 애너테이션으로 할 수 있는 일을 굳이 명명 패턴으로 처리할 이유가 없으며, 애너테이션으로 명명 패턴이 가지고 있는 문제를 해결 할 수 있다.

반응형

'언어 > JAVA' 카테고리의 다른 글

[Effective Java] 정의하려는 것이 타입이라면 마커 인터페이스를 사용하라  (0) 2020.04.04
[Effective Java] @Override 애너테이션을 일관되게 사용하라  (0) 2020.04.02
[Effective Java] 확장할 수 있는 열거 타입이 필요하면 인터페이스를 사용하라  (0) 2020.03.31
[Effective Java] ordinal 인덱싱 대신 EnumMap을 사용하라  (0) 2020.03.30
[Effective Java] 비트 필드 대신 EnumSet을 사용하라  (0) 2020.03.29
'언어/JAVA' 카테고리의 다른 글
  • [Effective Java] 정의하려는 것이 타입이라면 마커 인터페이스를 사용하라
  • [Effective Java] @Override 애너테이션을 일관되게 사용하라
  • [Effective Java] 확장할 수 있는 열거 타입이 필요하면 인터페이스를 사용하라
  • [Effective Java] ordinal 인덱싱 대신 EnumMap을 사용하라
지나가던 개발자
지나가던 개발자
지나가던 개발자
나의 발전을 위한 공간
지나가던 개발자
전체
오늘
어제
  • 분류 전체보기 (221)
    • 언어 (86)
      • C++ (43)
      • JAVA (43)
    • 게임 개발 (4)
      • 간단한 RPG 게임 만들기 (4)
      • 게임 개발 이슈 해결 (0)
    • 백준 문제풀이 (36)
      • PLATINUM (0)
      • GOLD (13)
      • SILVER (21)
      • BRONZE (2)
    • 프로그래머스 문제풀이 (32)
      • LEVEL 5 (0)
      • LEVEL 4 (0)
      • LEVEL 3 (7)
      • LEVEL 2 (19)
      • LEVEL 1 (6)
    • SQL 문제풀이 (15)
      • 프로그래머스 (4)
      • 해커랭크 (11)
    • 디자인 패턴 (1)
    • 웹 (17)
      • 웹 이론 정리 (17)
    • CS 지식 (28)
      • 알고리즘 (0)
      • 데이터베이스 (11)
      • 자료구조 (0)
      • 네트워크 (7)
      • 그래픽스 (0)
      • 운영체제 (9)
      • 기타 (1)
    • Git (1)

블로그 메뉴

  • 홈
  • 태그
  • 방명록
  • 깃 허브

공지사항

인기 글

태그

  • Silver 3
  • 클래스와 인터페이스
  • Gold 5
  • 객체 지향 설계
  • 열거 타입과 애너테이션
  • Level 2
  • mysql
  • Chapter 4
  • level 1
  • 프로그래머스
  • 소멸자 및 대입 연산자
  • 백준
  • 객체 생성과 파괴
  • 상속
  • 해커랭크
  • 설계 및 선언
  • c++
  • java
  • BOJ
  • Chapter 6

최근 댓글

최근 글

hELLO · Designed By 정상우.
지나가던 개발자
[Effective Java] 명명 패턴보다 애너테이션을 사용하라
상단으로

티스토리툴바

개인정보

  • 티스토리 홈
  • 포럼
  • 로그인

단축키

내 블로그

내 블로그 - 관리자 홈 전환
Q
Q
새 글 쓰기
W
W

블로그 게시글

글 수정 (권한 있는 경우)
E
E
댓글 영역으로 이동
C
C

모든 영역

이 페이지의 URL 복사
S
S
맨 위로 이동
T
T
티스토리 홈 이동
H
H
단축키 안내
Shift + /
⇧ + /

* 단축키는 한글/영문 대소문자로 이용 가능하며, 티스토리 기본 도메인에서만 동작합니다.