[ 아이템 68 ] 일반적으로 통용되는 명명 규칙을 따르라

 

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

패키지와 모듈 

 *철자

 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이우진다. 조직 바깥에서도 사용된다면 인터넷 도메인 이름을 역순으로 사용한다. edu.cmu, com.google, org.eff

 

 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. utilities보다는 util처럼 의미가 통하는 약어를 추천한다. 여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 써도 좋다.

 

 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우엔 계층을 나눠 더 많은 요소로 구성해도 좋다. java.util.concurrent.atomic

 

클래스와 인터페이스

 *철자

 (열거 타입과 애너테이션을 포함해) 클래스와 인터페이스의 이름은 하나 이상의 단어로 이루어지며, 각 단어는 대문자로 시작한다.(List, FutherTask) 여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다. 전체를 대문자로 쓰는 프로그래머도 있지만, 그래도 첫 글자만 대문자로 사용하는 쪽이 훨씬 많다.

 

*문법

 객체를 생성할 수 있는 클래스(열거 타입 포함)의 이름은 보통 단수 명사나 명사구를 사용한다.(Thread, PriorityQueue, ChessPiece) 객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다(Collectors, Collections). 인터페이스 이름은 클래스와 똑같이 짓거나 (Collection, Comparator), able 혹은 ible로 끝나는 형용사로 짓는다(Runnable, Iterable, Accessible). 애너테이션은 워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 사용된다. (BindigAnnotation, Inject, ImplementedBy, Singleton)

메서드와 필드, 상수필드

*철자

 메서드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명규칙과 같다.(remove, ensureCapacity) 첫 단어가 약자라면 단어 전체가 소문자여야 한다. 단, '상수 필드'는 예외다. 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이에 밑줄로 구분한다.(VALUES, NEGATIVE_INFINITY). 상수 필드는 값이 불변인 static final 필드를 말한다. 이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다는 사실도 기억해두자.

 

*문법

 어떤 동작을 수행하는 메서드의 이름은 동사나 (목적어를 포함한) 동사구로 짓는다.(append, drawImage) boolean 값을 반환하는 메서드라면 보통 is나 드물게 has로 시작하고 명사, 명사구 혹은 형용사로 가능하는 아무 단어나 구로 끝나도록 짓는다(isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings) 반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구, get으로 시작하는 동사구로 짓는다( size, hashCode, getTime) 세번째 양식, 즉 get으로 시작하는 형태만 써야 한다는 주장도 있지만 꼭 그렇지 않다.

if (car.speed() > 2 * SPPED_LIMIT)
	generatedAudibleAlert("경찰조심하세요!");

get으로 시작하는 형태는 주로 자바빈즈 명세에 뿌리를 두고 있다. 한편 클래스가 한 속성의 게터와 세터를 모두 제공할 때도 적합한 규칙이다. 이런 경우라면 보통 getAttribute와 setAttribute형태의 이름을 갖게 될 것이다.

 

 객체의 타입을 바꿔서, 다른 타입의 또다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다.(toString, toArray) 객체의 값을 기본 타입으로 바노한하는 메서드의 이름은 보통 typeValue 형태로 짓는다.(intValue) 마지막으로, 정적 팩토리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType을 사용한다.

 

 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다. API를 잘 설계했다면 직접 노출될 일이 거의 없다. boolean 타입의 필드 이름은 보통 boolean접근자 메서드에서 앞 단어를 뺀 형태다.(initialized, composite) 다른 타입의 필드라면 명사나 명사구를 사용한다.(height, digits, bodyStyle) 지역변수 이름도 필드와 비슷하게 지으면 되나, 조금 더 느슨한다.

지역변수

*철자

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

 

*문법

 

타입 매개변수

 타입 매개변수 이름은 보통 한 문자로 표현한다. 임의의 타입에는 T, 컬렉션 원소의 타입은 E, 맵의 키와 값에는 K와 V를, 예외에는 X를, 메서드의 반환 타입에는 R을 사용한다.

 

*느낀점

프로젝트들을 만들면서 한번씩은 고민해 봤을 부분들이었다. 기존에 아는 것도 있었으며 새롭게 안 사실도 있다. 메서드에서 get은 사용해도 안해도 되며, boolean 변수에 꼭 is, has를 사용하지 않아도 된다. 클래스에서 객체를 생성할 수 있는 경우와, 없는 경우를 나누어서 구분하는 것도 신기했다. 무조건이라는 규칙은 없지만 어떤 가이드에 따라서 만들어야 하는지 알 수 있었다.