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

[letmeloveyou82]

자바 플랫폼의 명명 규칙은 잘 정립되어 있고, 그중 많은 것이 자바 언어 명세[JLS, 6.1]에 기술되어 있다.

자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다.

1. 철자 규칙

패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.

특별한 이유 없으면 반드시 따라야 한다.

식별자 타입	예
패키지와 모듈	org.junit.jupiter.api, com.google.common.collect
클래스와 인터페이스	Stream, FutureTask, LinkedHashMap, HttpClient
메서드와 필드	remove, groupingBy, getCrc
상수 필드	MIN_VALUE, NEGATIVE_INFINITY
지역변수	i, denom, houseNum
타입 매개변수	T, E, K, V, X, R, U, V, T1, T2

(1) 패키지와 모듈 이름

• 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
• 요소들은 모두 소문자 알파벳 혹은 (드물게) 숫자로 이뤄진다.
• 조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다.
  • edu.cmu, com.google, org.eff 이런 식
• 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.
• 도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세[JLS, 6.1]에 적혀 있다.
• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. utilities보다는 util처럼 의미가 통하는 약어를 추천한다. 여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 써도 좋다. 요소의 이름은 보통 한 단어 혹은 약어로 이루어진다.
• 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우엔 계층 나눠 더 많은 요소로 구성해도 좋다. 예를 들어, java.util은 java.util.concurrent.atomic과 같이 그 밑에 수많은 패키지를 가지고 있다. 이처럼 하부의 패키지를 하위 패키지(subpackage)라 부른다.

(2) (열거 타입과 애너테이션을 포함해) 클래스와 인터페이스 이름

• 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다(List, FutherTask 등).
• 여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여쓰지 않도록 한다. 약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지 살짝 논란이 있다. 전체를 대문자로 쓰는 프로그래머도 있지만, 그래도 첫 글자만 대문자로 하는 쪽이 훨씬 많다. (HTTPURL 보단 HttpUrl이 각 약자의 시작과 끝을 명확히 알 수 있기 때문)

(3) 메서드와 필드 이름

• 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같다(remove, ensureCapacity 등).
• 첫 단어가 약자라면 단어 전체가 소문자여야 한다.

단, 상수 필드는 예외

• 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.
  • VALUES, NEGATIVE_INFINITY 등
• 상수 필드는 값이 불변인 static final 필드를 말한다. 달리 말하면, static final 필드의 타입이 기본 타입이나 불변 참조 타입이라면 상수 필드에 해당한다. static final 필드이면서 가리키는 객체가 불변이라면 비록 그 타입은 가변이더라도 상수 필드다. 이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다.

(4) 지역 변수 이름

• 다른 멤버와 비슷한 명명 규칙이 적용된다. 단, 약어를 써도 좋다. (약어 써도 그 변수가 사용되는 문맥에서 의미 쉽게 유추할 수 있기 때문)
  • i, denom, houseNum 등
• 입력 매개변수도 지역변수의 하나다. 하지만, 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수보다는 신경을 써야 한다.

(5) 타입 매개변수 이름

• 보통 한 문자로 표현한다. 대부분은 다음의 다섯 가지 중 하나다.

  • 임의의 타입 : T
  • 컬렉션 원소의 타입 : E
  • 맵의 키와 값 : K와 V
  • 예외 : X
  • 메서드의 반환 타입 : R
  • 그 외의 임의 타입의 시퀀스 : T, U, V 혹은 T1, T2, T3

  차례로 Type, Element, Key, Value, eXception, Return에서 따왔다.

2. 문법 규칙

철자 규칙과 비교하면 더 유연하고 논란도 많다.

(1) 패키지 이름

규칙 따로 없음

(2) 클래스, 인터페이스, 애너테이션 이름

2-1) 클래스 이름

• 객체를 생성할 수 있는 클래스(열거 타입 포함) : 단수 명사나 명사구
  • Thread, PriorityQueue, ChessPiece 등
• 객체를 생성할 수 없는 클래스 : 복수형 명사
  • Collectors, Collections 등

2-2) 인터페이스 이름

• 클래스와 똑같이 짓거나 (Collection, Comparator 등)
• able 혹은 ible로 끝나는 형용사로 짓는다
  • Runnable, Iterable, Accessible

2-3) 애너테이션 이름

• 워낙 다양하게 활용되어 지배적인 규칙 없이 명사, 동사, 전치사, 형용사 두루 쓰임
  • BindingAnnotation, Inject, ImplementedBy, Singleton 등

(3) 메서드, 필드 이름

3-1) 메서드 이름

• 어떤 동작을 수행하는 메서드 : 동사나 (목적어를 포함한) 동사구
  • append, drawImage
• boolean 값을 반환하는 메서드 : 보통 is나 (드물게) has로 시작하고 명사나, 명사구, 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다
  • isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings 등
• 반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드 : 명사, 명사구, 혹은 get으로 시작하는 동사구
  • size, hashCode, getTime 등
  • 클래스가 한 속성의 게터와 세터를 모두 제공할 때 getAttribute와 setAttribute

특별한 메서드 이름

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

3-2) 필드 이름

클래스, 인터페이스, 메서드 이름에 비해 덜 명확 + 덜 중요하다. API 설계 잘했으면 필드가 노출될 일이 거의 없기 때문이다.

• boolean 타입의 필드 : boolean 접근자 메서드에서 앞 단어를 뺀 형태다.
  • initialized, composite 등
• boolean이 아닌 다른 타입의 필드 : 명사나 명사구 사용한다.
  • height, digits, bodyStyle 등

(4) 지역변수 이름

• 필드와 비슷하게 지으면 되나, 조금 더 느슨하다.

3. 마치며

표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자.

철자 규칙은 직관적이라 모호한 부분이 적은 데 반해, 문법 규칙은 더 복잡하고 느슨하다.

자바 언어 명세[JLS, 6.1]의 말을 인용하자면, “오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안 된다” 상식이 이끄는 대로 따르자.