자바 플랫폼은 명명 규칙이 잘 정립되어 있으며, 그중 많은 것이 자바 언어 명세[JLS, 6.1]에 기술되어 있다.
자바의 명명 규칙은 크게 철자 규칙 과 문법 규칙, 두 범주로 나뉜다.
철자 규칙
철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.
패키지와 모듈
각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이루어진다.
조직 바깥에서도 사용될 패키지라면 조직의 인테넷 도메인 이름을 역순으로 사용한다. (ex. edu.cmu, com.google, org.eff)
예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java 와 javax 로 시작한다.
패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이루어진다.
각 요소는 일반적으로 8글자 이하의 짧은 단어로 한다.
긴 이름보다는 의미가 통하는 약어를 추천한다. (ex. utilities → util)
여러 단어로 구성된 이름이라면 각 단어의 첫 글자만 따서 써도 좋다. (ex. awt)
클래스(열거 타입과 애너테이션 포함)와 인터페이스
하나 이상의 단어로 이루어지며, 각 단어는 대문자로 시작한다.
여러 단어의 첫 글자만 딴 약자나 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.
약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지는 살짝 논란이 있다. 전체를 대문자로 쓰는 프로그래머도 있지만 첫 글자만 대문자로 하는 쪽이 훨씬 많다. HttpUrl처럼 여러 약자가 혼합된 경우라도 각 약자의 시작과 끝을 명확히 알 수 있기 때문이다. (HTTPURL은 혼합된 약자를 한 눈에 보기 어렵다)
메서드와 필드
첫 글자를 소문자로 쓴다는 점을 제외하고 클래스 명명 규칙과 같다.
첫 단어가 약자라면 단어 전체가 소문자여야 한다. (ex. remove, ensureCapacity)
상수 필드
상수 필드의 경우 일반적인 필드와는 다르게, 모든 문자를 대문자로 쓰며 단어 사이는 밑줄로 구분한다. (ex. VALUES, NEGATIVE_INFINITY)
상수 필드는 값이 불변(기본 타입이나 불변 참조 타입)인 static final 필드를 말한다.
지역변수
다른 멤버와 비슷한 명명 규칙이 적용된다. 단, 약어를 써도 좋다.
약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문이다.
입력 매개변수도 지역변수의 일종이다. 하지만 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수보다는 신경써야 한다.
타입 매개변수
보통 한 글자로 표현한다. 대부분은 다섯 가지 중 하나다.
- 임의의 타입 T
- 컬렉션 원소의 타입 E
- 맵의 키와 값 K,V
- 예외 X
- 메서드의 반환 타입 R
- 그 외에 임의 타입의 시퀀스 T,U,V 혹은 T1,T2,T3
문법 규칙
문법 규칙은 철자 규칙과 비교하면 더 유연하고 논란도 많다.
패키지
패키지에 대한 규칙은 따로 없다.
클래스
객체를 생성할 수 있는 클래스(열거 타입 포함)의 이름은 보통 단수 명사나 명사구를 사용한다. (ex. Thread, PriorityQueue)
객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다. (ex. Collectors, Collections)
인터페이스
클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다. (ex. Runnable, Iterable)
애너테이션
워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.
메서드
동작을 수행하는 메서드의 이름은 동사나 동사구로 짓는다.
boolean 값을 반환하는 메서드는 보통 is나 드물게 has로 시작하고 명사나 명사구 혹은 형용사로 가능한 아무 단어나 구로 끝나도록 짓는다. (ex. isDigit, isProbablePrime, isEmpty, isEnabled)
반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구 혹은 get으로 시작하는 동사구로 짓는다. (ex. size, hashCode, getTime)
객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다. (ex. toString, toArray)
객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType 형태로 짓는다. (ex. asList)
객체의 값을 기본 타입값으로 반환하는 메서드의 이름은 보통 typeValue 형태로 짓는다. (ex. intValue)
정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType을 흔히 사용한다. (아이템 1)
필드
클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다. API 설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다.
boolean 타입의 필드 이름은 보통 접근자 메서드에서 앞단어를 뺀 형태다. (ex. initinalized, composite)
다른 타입의 필드라면 명사나 명사구를 사용한다.
지역변수
필드와 비슷하게 지으면 되나, 조금 더 느슨하다.
📌 핵심 정리
표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자.
철자 규칙은 직관적이라 모호한 부분이 적은 데 반해, 문법 규칙은 더 복잡하고 느슨하다.
자바 언어 명세[JLS, 6.1]의 말을 인용하자면 "오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안 된다." 상식이 이끄는 대로 따르자.
