아이템 68. 일반적으로 통용되는 명명 규칙을 따르라. - ksw6169/effective-java GitHub Wiki

자바의 명명 규칙

• 자바의 명명 규칙은 크게 철자 규칙과 문법 규칙으로 나뉜다.

철자 규칙

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

패키지와 모듈의 이름

• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
• 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이뤄진다.
• 조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다.
• 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java, javax로 시작한다.
• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.
• 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. (의미가 통하는 약어 추천)
• 의미가 통하는 약어를 추천하며, 여러 단어로 구성된 이름이라면 각 단어의 첫 글자만 따서 써도 좋다.
• 요소의 이름은 보통 한 단어 혹은 약어로 이뤄진다.
• 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우엔 계층을 나눠 더 많은 요소로 구성해도 좋다. (subpackage)

클래스와 인터페이스의 이름

• 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다. (Camel case)
• 여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.
• 약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지는 논란이 있으나 첫 글자만 대문자로 하는 쪽이 훨씬 많다.

메소드와 필드 이름

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

상수 필드 이름

• 상수 필드는 값이 불변인 static final 필드를 말한다.
• static final 필드이면서 가리키는 객체가 불변이라면 그 타입은 가변이더라도 상수 필드다.
• 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.

지역 변수 이름

• 다른 멤버와 비슷한 명명 규칙이 적용된다.
• 지역 변수는 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문에 약어를 써도 좋다.

타입 매개변수 이름

• 보통 한 문자로 표현한다.

타입 매개변수	타입
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, V, T1, T2

문법 규칙

• 철자 규칙과 비교하면 더 유연하고 논란도 많다.
• 패키지에 대한 규칙은 따로 없다.

클래스(열거 타입 포함)의 이름

• 보통 단수 명사나 명사구를 사용한다.
• ex. Thread, PriorityQueue, CheesePiece 등

인터페이스 이름

• 클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다.
• ex. Collectors, Collections / Runnable, Iterable, Accessible

어노테이션의 이름

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

메소드의 이름

• 동사나 목적어를 포함한 동사구로 짓는다. (ex. append, drawImage)

boolean을 반환하는 메소드의 이름

• 보통 is 혹은 드물게 has로 시작하고 명사나 명사구, 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.
• ex. append, drawImage / isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings 등

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

• 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.
• ex. size, hashCode, getTime 등

기타 - 관례에 따른 메소드의 이름

(객체의 타입을 바꿔서 다른 타입의 객체를 반환하는 인스턴스 메소드의 이름)

• 보통 toType 형태로 짓는다.
• ex. toString, toArray 등

(객체의 내용을 다른 뷰로 보여주는 메소드의 이름)

• 보통 asType 형태로 짓는다.
• ex. asList 등

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

• 보통 typeValue 형태로 짓는다.
• ex. intValue 등

(정적 팩토리의 이름)

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

필드 이름

(boolean 타입의 필드 이름)

• 보통 boolean 접근자 메소드에서 앞 단어를 뺀 형태다.
• ex. initialized, composite 등

(다른 타입의 필드 이름)

• 명사나 명사구를 사용한다.
• ex. height, digits, bodyStyle 등

핵심 정리

• 표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자.
• 철자 규칙은 직관적이라 모호한 부분이 적은 데 반해, 문법 규칙은 더 복잡하고 느슨하다.
• 규칙을 맹종하지는 말자. 상식이 이끄는 대로 따르라.

참고 자료

• Effective Java 3/E