[Effective Java] Item 68. 일반적으로 통용되는 명명 규칙을 따르라

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

철자 규칙 : 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수

 

철자 규칙이나 문법 규칙을 어기면 다른 프로그래머들이 그 코드를 읽기 번거로울 뿐 아니라 다른 뜻으로 오해할 수도 있다.

 

철자 규칙

 

철자 규칙은 특별한 이유가 없는 한 반드시 따라야 한다.

이 규칙을 어긴 API는 사용하기 어렵고, 유지보수하기 어렵다.

 

 

패키지

• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
• 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이루어진다.
• 각 요소는 일반적으로 8 자 이하의 짧은 단어로, 그 단어의 약어 또는 첫 글자만 따서 지어도 좋다.
• 인터넷 도메인 이름을 역순으로 사용한다.
• 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.
• ex) com.google, edu.cmu

 

 

클래스, 인터페이스 (열거 타입, 애너테이션)

• 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.
• 단어를 줄여 쓰지 않도록 한다. (max나 min처럼 널리 통용되는 줄임말을 제외하고)
• ex) Stream, LinkedHashMap

 

 

메서드, 필드

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

 

 

상수 필드

• 값이 불변인 static final 필드를 상수 필드라고 한다.
• 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.
• 이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다.
• ex) MIN_VALUE, NEGATIVE_INFINITY

 

 

지역 변수

• 약어를 써도 그 변수가 사용되는 문맥에서 의미를 유추할 수 있기 때문에 약어를 써도 좋다.
• 입력 매개변수도 지역변수의 하나인데, 일반 지역변수보다는 신경 써야 한다.
• ex) i, houseNum

 

 

타입 매개변수

• 보통 한 문자로 표현한다.
• 임의의 타입 : T
• 컬렉션 원소의 타입 : E
• 키와 값 : K, V
• 예외 : X
• 메서드의 반환 타입 : R
• 임의 타입의 시퀀스 : T, U, V 혹은 T1, T2, T3

 

 

문법 규칙

 

문법 규칙은 철자 규칙에 비해 더 유연하고 논란이 많다.

패키지에 대한 규칙은 없다.

 

 

객체를 생성할 수 있는 클래스

• 단수 명사나 명사구 (Thread, PriorityQueue, ChessPiece)
  
  

객체를 생성할 수 없는 클래스

• 복수형 명사 (Collectors, Collections)

 

인터페이스

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

 

애너테이션

• 지배적인 규칙 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.
• ex) BindingAnnotation, Inject, ImplementedBy, Singleton

 

어떤 동작을 수행하는 메서드의 이름

• 동사나 목적어를 포함한 동사구 (append, drawInage)

 

boolean 값을 반환하는 메서드

• is나 has로 시작하고 명사나 명사구, 혹은 형용사 끝나도록 한다.
• ex) isDigit, isProbablePrime, isEmpty, hasSiblings

 

반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드

• 명사, 명사구, 혹은 get으로 시작하는 동사구 (size, hashCode, getTime)

 

 

객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드

• toType 형태 (toString, toArray)

 

객체의 값을 기본 타입 값으로 반환하는 메서드의 이름

• typeValue 형태 (intValue)

 

정적 팩터리

• from, of, valueOf, instance, getInstance, newInstance, getType, newType을 흔히 사용한다.

 

필드

• 클래스, 인터페이스, 메서드에 비해 덜 중요하다.
• API를 잘 설계했다면 필드가 직접 노출될 일이 없기 때문이다.

 

 

결론

 

• 표준 명명 규칙을 체화해서 자연스럽게 베어 나오도록 하자.
• 철자 규칙은 직관적이라 모호한 부분이 적은 데 반해, 문법 규칙은 더 복잡하고 느슨하다.