item 68 jihoon - JAVA-JIKIMI/EFFECTIVE-JAVA3 GitHub Wiki

[item68] 일반적으로 통용되는 명명 규칙을 따르라

자바 플랫폼은 명명 규칙이 잘 정립되어 있고, 규칙은 크게 철자와 문법으로 나뉜다.

철자 규칙

패키지, 클래스, 인터페이스, 메서드, 필드 타입 변수의 이름을 다룬다.
이 규칙들은 특별한 이유가 없는 한 반드시 따라야 한다.

• 패키지와 모듈

  • 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
  • 요소들은 모두 소문자 알파벳 혹은 숫자로 이뤄진다.
  • 조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다.
    • E.g. edu.cmu, com.google. org.eff
    • 예외적으로, 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.

• 클래스와 인터페이스

  • 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작 (E.g. List, FutherTask)
  • 여러 단어의 첫 글자만 딴 약자나 max, min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여쓰지 않는다.
  • 약자의 경우 논란이 있지만 첫 글자만 대문자로 하는 쪽이 많다(이 시작과 끝을 명확히 알 수 있다).
    • HttpUrl vs HTTPURL

• 메서드와 필드

  • 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같다 (E.g. remove, ensureCapacity)
  • 첫 단어가 약자라면 해당 약자는 단어 전체가 소문자여야 한다. (E.g httpUrl)
  • 상수 필드는 예외
    • 상수 필드 : static final 필드 및 불변 참조 타입
    • 단어를 모두 대문자로 쓰며, 단어 사이는 밑줄로 구분한다 (E.g. VALUE, POSITIVE_INFINIY)
    • 이름에 밑줄을 사용하는 요소는 상수 필드가 유일

• 지역변수

  • 다른 멤버와 비슷한 명명 규칙 적용
  • 문맥에서 의미 유추가 쉬워 약어를 써도 좋다 (E.g. i, denom, hoseNum)
  • 입력 매개변수도 지역변수의 하나이나, 메서드 설명 문서에까지 등장하는 만큼 신경을 더 써줘야 한다.

• 타입 매개변수

  • 임의의 타입 : T (Type)
  • 컬렉션 원소 타입 : E (Element)
  • 맵의 키와 값 : K와 V (Key, Value)
  • 예외 : X (eXception)
  • 메서드 리턴 타입 : R (Return)
  • 그 외 임의 타입의 시퀀스 : T, U, V 혹은 T1, T2, T3

문법 규칙

철자 규칙에 비해 더 유연하고 논란도 많다.

• 클래스

  • 객체 생성할 수 있는 클래스 : 보통 단수 명사나 명사구 사용(E.g. Thread, priorityQueue, ChessPiece)
  • 객체 생성할 수 없는 클래스 : 보통 복수형 명사(E.g. Collectors, Collections)

• 인터페이스

  • 클래스와 동일하게 짓는다(E.g. Collection, Comparator).
  • able, ible로 끝나는 형용사로 짓는다(E.g. Runnable, Iterable, Accessible)

• 메서드

  • 동작 수행 : 동사, 동사구(E.g. append, drawImage)

  • boolean 타입 리턴 : is, has로 시작하고 명사나 명사구 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다 (E.g. isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings)

  • 해당 인스턴스의 속성 리턴

    • 보통 명사, 명사구 (E.g. Size, hashCode)
    • get으로 시작하는 동사구로 짓는다 (E.g. getTime)
      • 주로 JavaBeans 명세에 뿌리를 두고 있다
      • 클래스가 한 속성의 getter와 setter를 모두 제공할 때도 적합한 규칙 (E.g. getAttribute, setAttribute)
    • get으로 시작하는 형태만 써야한다는 주장도 있지만 근거가 빈약하다(명사, 명사구 사용 코드가 더 가독성이 좋다).

      if (car.speed() > 2 * SPEED_LIMIT)
        generateAudibleAlert("제한 속도 초과");
      

  • 특별한 메서드

    • 객체의 타입을 바꿔, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드 : toType (E.g. toString, toArray)
    • 객체의 내용을 다른 뷰로 보여주는 메서드 : asType (E.g. asList)
    • 객체의 값을 기본 타입 값으로 변환하는 메서드 : typeValue (E.g. intValue)
    • 정적 팩터리 : from, of, valueOf, instance, getInstance, newInstance, getType, newType 등을 사용

• 필드

  • 필드가 직접 노출될 일이 거의 없기 때문에 규칙이 덜 명확하고 덜 중요하다.
  • boolean 타입 : 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태 (E.g. initialized, composite)
  • 다른 타입의 필드 : 명사나 명사구 (E.g. height, digits, bodyStyle)

• 지역변수

  • 필드와 비슷, 조금 더 느슨

핵심 정리

• 철자 규칙은 직관적이라 모호하지 않은데, 문법 규칙은 더 복잡하고 느슨하다
• 명명 규칙을 체화하자
• 상식이 이끄는대로 따르자