Java/EffectiveJava

Effective Java Item68. 일반적으로 통용되는 명명 규칙을 따르라.

Flambee 2025. 3. 9. 21:17

자바 플랫폼은 명명 규칙이 잘 정립되어 있으며, 그중 많은 것으로 자바 언어 명세에 기술되어 있다. 자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다.

철자 규칙

  • 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.
    • 패키지와 모듈 이름은 각 요소를 점으로 구분하여 계층적으로 짓는다.
      • 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.
        • 8자 이하의 짦은 단어로 해야한다.
      • 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우엔 계층을 나눠 더 많은 요소로 구성해도 좋다.
    • 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.
      • 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.
    • 메서드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같다.
      • 첫 단어가 약자라면 단어 전체가 소문자여야 한다.
    • 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.
    • 지역변수에도 다른 멤버와 비슷한 명명 규칙이 적용된다.
    • 타입 매개변수 이름은 보통 한 문자로 표현한다.
      • T : 입의의 타입
      • E : 컬렉션 원소의 타입
      • K, V : 맵의 키와 값
      • X : 예외
      • R : 메서드 반환타입
      • T, U, V, T1, T2, T3 : 임의 타입의 시퀀스

        문법 규칙

  • 패키지 : 패키지에 대한 규칙은 따로 없다.
  • 클래스 :
    • 객체를 생성할 수 있는 클래스의 이름은 보통 단수 명사나 명사구를 사용한다.(Thread, PriorityQueue, ChessPicee)
    • 객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓거나. (Collection, Comparator) able, ible로 끝나는 형용사로 짓는다.
    • 애너테이션은 워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다(BindingAnnotation, Inject, ImplemetedBy, Singletone 등)
  • 메서드 :
    • 어떤 동작을 수행하는 메서드의 이름은 동사나, 동사구로 짓는다.(append, drawImage)
    • boolean 값을 반환하는 메서드라면 보통 is나 has로 시작하고 명사나 명사구, 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.(isDigit, isProbablePrime, isEmpty)
    • 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.
    • 객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다.
    • 객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType 형태로 짓는다.
    • 객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 보통 typeValue 형태로 짓는다.
    • 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType을 사용한다.
  • 필드 :
    • 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다.
    • boolean 타입의 필드 이름은 보통 booelan 접근자 메서드에서 앞 단어를 뺀 형태다.
    • 다른 타입의 필드라면 명사나 명사구를 사용한다.
    • 지역 변수 이름도 필드와 비슷하게 지으면 되나, 조금 더 느슨하다.