Search

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

 자바의 명명 규칙은 크게 철자와 문법으로

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.
특별한 이유가 없다면 반드시 따라야한다.
그렇지 않으면 API를 사용하기 어렵고 유지보수도 힘들다.

 철자 규칙

 패키지

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 구성
패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 작성
요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이뤄짐
조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용
com.google, edu.cmu, org.eff
예외적으로 많은 기능을 제공하는 경우엔 계층을 나눠 많은 요소로 구성해도 좋다.
ex) java.util.concurrent.atomic
각 요소는 일반적으로 8자 이하의 짧은 단어로 한다.
여러 단어로 구성된 이름이라면 각 단어의 첫 글자만 따서 써도 좋다.
ex) utilities -> util, awt(Abstract Window Toolkit)

 클래스 & 인터페이스

이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작
여러 단어의 첫 글자만 딴 약자, max, min처럼 통용되는 줄임말 제외하고는 줄여쓰지 말자.
약자의 경우 첫글자만 대문자? 전체를 대문자? (Url vs URL)
첫 글자만 대문자로 쓰는 프로그래머가 많아 이를 권장함
전체 대문자는 시작과 끝을 명확히 알 수 없다.

 메서드, 필드

첫 글자를 소문자로 쓰는 것 외에 클래스와 동일하다.
다만 상수 필드는 예외다.
단어를 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.

 지역변수

지역변수는 다른 맴버와 명명 규칙이 비슷하게 적용된다.
약어를 써도 좋다. 지역 변수는 문맥상 쉽게 의미를 유추할 수 있다.
메서드로 예시를 들자면, 메서드의 크기가 크다면 의미를 유추하기 힘들 수 있다.

 타입 매개변수

타입 매개변수 이름은 보통 한 문자로 표현한다. 대부분 다음의 다섯 가지중 하나이다.
T : 임의의 타입
E : 컬렉션 원소의 타입
K, V : 맵의 키와 값
X : 예외(eXeption)
R : 메서드 반환 타입
Show All
철자 규칙 예시
식별자 타입
클래스와 인터페이스
Open
Stream, FutureTask, LinkedHashMap, HttpClient
메서드와 필드
Open
remove, groupingBy, getCrc
상수 필드
Open
MIN_VALUE, NEGATIVE_INFINITY
지역 변수
Open
i, denom, houseNum
타입 매개변수
Open
T, E, K, V, R, U, V, T1, T2

 문법 규칙

 클래스 & 인터페이스

객체를 생성할 수 있는 클래스(열거 타입 포함)의 이름은 보통 단수 명사나 명사구를 사용한다.
ex) Thread, PriorityQueue, ChessPiece
단, 상수 필드는 예외다. 단어를 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.
객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다.
ex) Collectors, Collections
인터페이스 이름은 클래스와 똑같이 짓거나 able, ible로 끝나는 형용사로 작성한다.
ex) Runnable, Iterable, Accessible

 어노테이션

어노테이션은 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.
ex) BindingAnnotation, Inject, ImplementedBy, Singleton

 메서드 규칙

동작을 수행하는 메서드의 이름은 동사나 (목적어를 포함한)동사구로 작성
ex) append, drawImage
boolean값을 반환하는 메서드라면 보통 is나 드물게 has를 사용하여 명사, 명사구, 형용사와 결합해서 사용
ex) isDigit, isProbablePrime, isEmpty, isEnabled, hasSibings
반환 타입이 boolean이 아니고 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구, get으로 시작하는 동사구로 작성
ex) size, hashCode, getTime

 특별한 메서드 규칙

객체의 타입을 다른 타입의 객체로 반환하는 메서드 이름은 보통 toType으로 작성된다.
ex) toString, toArray
객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType으로 작성된다.
ex) asList
기본 타입의 값으로 반환하는 메서드의 이름은 보통 typeValue로 작성된다.
ex) intValue
정적 팩터리의 이름은 아래와 같이 다양하게 쓰인다.
ex) from, of, valueOf, instance, getInstance, newInstance, getType, newType 등

 필드

클래스, 인터페이스, 메서드 이름에 비해 문법 규칙이 덜 명확하고 덜 중요하다.
API를 잘 설계했다면 필드가 직접 노출될 일이 없지 않을까?
boolean 타입의 필드명은 보통 앞의 단어를 제외한 형태
ex) isInitialized() -> initailized
다른 타입의 필드라면 명사나 명사구를 사용
ex) height, digits, bodyStyle

 지역 변수

필드와 비슷하게 지으면 되지만, 좀 더 느슨하게 지어도 된다.

 핵심 정리

표준 명명 규칙을 내 것으로 만들자.
철자 규칙은 직관적이라 모호한 부분이 적다.
문법 규칙은 복잡하고 느슨하다.
상식이 이끄는 대로 따르자.