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

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

 

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다. 철자 규칙은 특별한 이유가 없는 한 반드시 따라야한다. 그렇지않으면 API를 사용하기 어렵고 유지보수도 힘들다. (다른 프로그래머들이 코드를 읽기 어렵고 뜻을 오해하는 경우가 생길 수 있음)

 

*철자 규칙

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

 

패키지

 

• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 작성
• 요소들은 모두 소문자 알파벳 혹은 (드물게)숫자로 이뤄짐
• 조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용
• 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java, javax(표준 확장 패키지)로 시작

com.google, edu.cmu, org.eff

 

• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 구성
• 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다.
• 여러 단어로 구성된 이름이라면 각 단어의 첫 글자만 따서 써도 좋다.

utilities -> util, awt(Abstract Window Toolkit)

 

클래스, 인터페이스

 

• 클래스와 인터페이스의 의름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작
• 여러 단어의 첫 글자만 딴 약자나 max, min처럼 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.
• 약자의 경우 첫글자만 대문자로 할지 전체를 대문자로 할지 살짝 논란이 있다. 첫 글자만 대문자로 쓰는 프로그래머가 훨씬 많다. 전체가 대문자인경우 시작과 끝을 명확히 알 수 없다.

List, Map, ArrayList

AWT, Awt -> AWTUtils, AwtUtils
HTTPURL, HttpUrl

 

메서드, 필드 

 

• 메서드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스의 명명 규칙과 같다.
• 첫 단어가 약자라면 단어 전체가 소문자여야한다.
• 상수 필드는 예외다. 단어를 모두 대문자로 쓰며 단어 사이는 밑줄로 구분

remove, ensureCapacity

urlParser => urlparser

VALUES, NEGATIVE_INFINITY

상수는 값이 불변인 static final필드를 말한다. static final필드 이면서 가르키는 객체가 불변이라면 비록 그 타입은 가변이더라도 상수 필드이다. 

public class Paint {
	private static final Box box; 
    
    public Paint(Box box) {
		this.box = new Box(box.width, box.height); //방어적 복사 
	} 
    public void paintBox() {
		System.out.println("width : " + box.width); 
		System.out.println("height : " + box.height); 
	} 
}

(Box객체는 set메서드가 존재해 가변이지만 방어적 복사로 불변타입으로 만든 상황)

 

지역변수

 

• 지역변수는 다른 맴버와 명명 규칙이 비슷하게 적용된다.
• 약어를 써도 좋다. 지역 변수는 문맥상 쉽게 의미를 유추할 수 있다. 

타입 매개변수

 

타입 매개변수 이름은 보통 한 문자로 표현한다. 대부분 다음의 다섯 가지중 하나이다.

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

*문법 규칙

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

 

클래스, 인터페이스

 

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

Thread, PriorityQueue, ChessPiece

Collectors, Collections

Runnable, Iterable, Accessible

 

어노테이션

 

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

BindingAnnotation, Inject, ImplementedBy, Singleton

 

메서드 규칙

 

• 어떤 동작을 수행하는 메서드의 이름은 동사나 (목적어를 포함한)동사구로 작성
• boolean값을 반환하는 메서드라면 보통 Is나 드물게 has를 사용하여 명사, 명사구, 형용사와 결합해서 사용
• 반환 타입이 boolean이 아니고 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구 혹윽 get으로 시작하는 동사구로 작성

append, drawImage

 isDigit, isProbablePrime, isEmpty, isEnabled, hasSibings

size, hashCode, getTime

get으로 시작하는 형태만 사용해야한다는 주장이 있지만 근거가 빈약하다. get을 붙이지 않고 코드의 가독성이 더 좋아질 수 있다. 보통은 클래스의 속성을 getter, setter로 제공할 때 적합한 규칙이고, 이런 경우 일반적으로 getAttribute, setAttiribute의 형태의 이름을 갖는다.

 

*특별한 메서드 규칙

• 객체의 타입을 바꿔서, 다른 타읩의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType으로 작성
• 객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType으로 작성
• 객체의 값을 기본 타입의 값으로 반환하는 메서드의 이름은 보통 typeValue로 작성
• 마지막으로, 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType등을 흔히 사용

toString, toArray

asList

intValue

 

 

필드

 

• 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요
• API를 잘 설계했다면 필드가 직접 노출될 일이 거의 없음
• boolean 타입의 필드명은 보통 앞의 단어를 제외한 형태
• 다른 타입의 필드라면 명사나 명사구를 사용

isInitialized() -> initailized

height, digits, bodyStyle

 

지역 변수

 

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

 

-결론-

표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자. 철자 규칙은 직관적이라 모호한 부분이 적지만,  문법 규칙은 더 복잡하고 느슨하다. 자바 언어 명세는 이렇게 말한다. "오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안 된다." 상식이 이끄는 대로 따르자.