[이펙티브자바] item68.일반적으로 통용되는 명명 규칙을 따르라

자바 플랫폼은 명명 규칙이 잘 정립되어 있으며, 그중 많은 것이 자바 언어 명세에 기술되어 있다.

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

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

 

철자 규칙

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

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

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

 

• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.

요소들은 모두 소문자 알파벳 혹은 숫자로 이뤄진다.

바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다. ex) com.google

예외적으로 표준 라이브러리와 선택적 패키지들은 java와 javax로 시작한다.

도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세에 적혀있다.

 

 

• 패키지의 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.

각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. ex) utilities 보다는 util

여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 써도 좋다.

요소의 이름은 보통 한 단어 혹은 약어로 이뤄진다.

 

 

• 많은 기능을 제공하는 경우엔 계층을 나눠 더 많은 요소로 구성해도 좋다.

인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우에는 계층을 나눠서 더 많은 요소로 구성하자. ex) java.util 은 java.util.concurrent.atomic 과 같이 그 밑에 수많은 패키지를 가지고 있다.

자바가 패키지 계층에 관해 언어 차원에서 지원하는 건 거의 없지만, 어쨋든 이처럼 하부의 패키지를 하위 패키지(subpackage)라 부른다.

 

 

• 클래스(열거타입, 애너테이션까지 포함)와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.

여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여쓰지 않도록 한다.

약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지는 살짝 논란이 있다. (그래도 첫 글자만 대문자로 하는 경우가 더 많다 -> HTTPURL보다는 HttpUrl이 각 약자의 시작과 끝을 명확히 알 수 있기 때문이다.)

 

 

• 메서드와 필드 이름은 첫 글자를 소문자로 사용한다.

첫 글자를 소문자로 작성한다는 점 외에는 클래스 명명 규칙과 같다.

첫 단어가 약자라면 단어 전체가 소문자여야 한다.

 

 

• '상수 필드'는 예외다.

상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다. ex) VALUES, NEGATIVE_INFINITY

상수 필드는 값이 불변인 static final 필드를 말한다. 달리 말하면 static final 필드의 타입이 기본 타입이나 불변 참조 타입이라면 상수 필드에 해당한다.

static final 필드이면서 가리키는 객체가 불변이라면 비록 그 타입은 가변이더라도 상수 핓ㄹ드다.

이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다.

 

 

• 지역변수에도 다른 멤버와 비슷한 명명 규칙이 적용 된다.

단, 약어를 사용해도 괜찮다는 점이 다르다.

약어를 써도 그 변수가 사용되는 문맥에서 그 의미를 쉽게 유추할 수 있기 때문이다. ex) i, denom, houseNum

입력 매개변수도 지역변수의 하나다. 하지만 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수 보다는 신경을 써야 한다.

 

 

• 타입 매개변수 이름은 보통 한 문자로 표현한다.

대부분은 다음의 다섯 가지 중 하나다.

• 임의의 타입 T
• 컬렉션의 원소의 타입 E
• 맵의 키와 값 K와 V
• 예외 X
• 메서드의 반환 타입 R

그 외에 임의 타입의 시퀀스에는 T, U, V 또는 T1, T2, T3를 사용한다.

 

철자 규칙 정리

식별자 타입	예
패키지와 모듈	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, T1, T2

 

 

문법 규칙

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

 

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

 

• 클래스는 객체를 생성할 수 있느냐 없느냐에 따라 나뉜다.

객체를 생성할 수 있는 클래스(열거 타입 포함)의 이름은 보통 단수 명사나 명사구를 사용한다. ex) Thread, PriorityQueue, ChessPiece

객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다. ex) Collectors, Collections

 

 

• 인터페이스 이름은 클래스와 똑같이 짓거나 able 혹은 ible로 끝나는 형용사로 짓는다.

클래스와 똑같이 짓는다. ex) Collection, Comparator 

able이나 ible로 끝나는 형용사로 짓는다. ex) Runnable, Iterable, Accesible

 

 

• 애너테이션은 지배적인 규칙 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.

ex) BingingAnnotation, Inject, ImplementBy, Singleton

 

 

• 어떤 동작을 수행하는 메서드의 이름은 동사나 목적어를 포함한 동사구로 짓는다.

ex) append, drawImage

 

boolean값을 반환하는 메서드라면 보통 is나 has로 시작하고 명사나 명사구 혹은 형용사로 기능하는 아무 단어나 구로 끝나게 짓는다. ex) isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings

 

반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드라면 이름을 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다. ex) size, hashCode, getTime

 

 

• 특별한 메서드 이름 몇가지

1. 객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다.

ex) toString, toArray

 

2. 객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType의 형태로 짓는다. ex) asList

 

3. 객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 typeValue 형태로 짓는다. ex) intValue

 

4. 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType을 흔히 사용한다.

 

 

• 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다.

API설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다.

 

boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞에 단어를 뺀 형태다. ex) initailized, composite

다른 타입의 필드라면 명사나 명사구를 사용한다. ex) height, digits, bodyStyle

지역변수 이름도 필드와 비슷하게 지으면 되나, 조금 더 느슨하다.

 

 

 

핵심 정리

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

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

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