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

자바의 명명규칙

자바 플랫폼은 명명 규칙이 잘 정립되어 있으며, 그중 많은 것이 자바 언어 명세에 기술되어있다. 자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다. 

 

 

철자 규칙

패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다. 이 규칙들은 특별한 이유가 없는 한 무조건 따라야한다. 

 

1) 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이뤄진다.

 

2) 표준 라이브러리와 선택적 패키지들은 각각 java, javax로 시작한다.

 

3) 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. 

utilities -> util

 

4) 패키지명이 너무 길다면 각 단어의 첫 글자만 따서 써도 좋다.

awt

 

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

java.util.concurrent.atomic

 

 

6) 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.

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

 

7) 메서드와 필드 이름은 첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙은 같다. 첫 단어가 약자라면 단어 전체가 소문자여야한다.

 

8) 상수 필드는 예외다. 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄(_)로 구분한다. 밑줄 사용은 상수 필드가 유일하다.

static final TEST_URL = "devfunny.tistory.com";

 

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

단, 약어를 써도 좋다. 약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있다면 말이다. 입력 매개변수도 마찬가지지만, 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수보다는 신경을 써야한다.

 

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

임의의 타입 : T
컬렉션 원소의 타입 : E
맵의 키 : K
맵의 값 : V
예외 : X
메서드의 반환 타입 : R
그 외의 임의 타입의 시퀀스 : T, U, V, 혹은 T1, T2, T3

 

 

철자규칙 정리

식별자 타입	예
패키지와 모듈	org.junit.jupiter.api com.google.common.collect
클래스와 인터페이스	Stream FutureTask LinkedHashMap
메서드와 필드	remove groupingBy
상수 필드	MIN_VALUE
지역변수	i denom houseNum
타입 매개변수	T, E, K, V, X, R,  U, V, T1, T2

 

 

문법 규칙

1) 패키지에 대한 문법 규칙은 없다.

 

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

Thread, PriorityQueue, ChessPriece

 

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

Collectors, Collections

 

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

Runnable, Iterable, Accessible

 

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

 

6) 어떤 동작을 수행하는 메서드의 이름은 동사나 동사구로 짓는다. 

append, drawImage

 

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

isDigit, isProbablePrime, isEmpty

 

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

size, hashCode, getTime

 

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

toString, toArray

 

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

asList

 

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

intValue

 

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

 

 

정리

필드 이름에 대한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다. API 설계를 잘 했다면 필드가 직접 노출될일이 거의 없기 때문이다.