자바의 명명 규칙은 크게 철자와 문법 두 범주로 나뉜다.
철자 규칙
철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.
패키지와 모듈
각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다. 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. utilities
보다는 util
처럼 의미가 통하는 약어가 좋다.
클래스와 인터페이스
열거 타입과 애너테이션을 포함해 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다(List
, FutherTask
). 여러 단어의 첫 글자만 딴 약어나 max,min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 말자
메서드와 필드
메서드와 필드 이름은 첫 글자를 소문자로 쓰고 나머지는 클래스의 명명 규칙을 따라간다. (remove
, ensureCapacity
) 단, 상수 필드를 구성하는 단어는 모두 대문자로 쓰면 단어 사이는 밑줄로 구분한다. (VALUES
, NEGATIVE_INFINITY
)
지역변수
지역변수도 다른 멤버와 비슷한 명명 규칙이 적용된다. 단, 약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있다면 약어를 사용해도 된다.
타입 매개변수
타입 매개변수 이름은 보통 한 문자로 표현하며 대부분은 다음 다섯 가지 중 하나이다.
- T : 타입
- E : 컬렉션 원소 타입
- K, V : 키와 값
- X : 예외
- R : 메서드 반환
문법 규칙
패키지
패키지에 대한 문법 규칙은 따로 존재하지 않는다.
클래스
- 객체를 생성할 수 있는 클래스(열거 타입 포함) : 보통 단수 명사나 명사구를 사용한다. (
Thread
,PriorityQueue
) - 객체를 생성할 수 없는 클래스 : 보통 복수형 명사로 짓는다. (
Collectors
,Collections
)
인터페이스
클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다. (Runnable
, Iterable
, Accessible
)
메서드
- 어떤 동작을 수행하는 메서드 : 동사나 (목적어를 포함한) 동사구로 짓는다. (
append
,drawImage
), boolean 값을 반환하는 메서드라면 is로 시작하고 명사 또는 형용사를 쓴다.(isDigit
,isEmpty
) - 인스턴스의 속성을 반환하는 메서드 : 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.
특별한 메서드 이름
- 객체의 타입을 바꿔서 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드 : toType (
toString
,toArray
) - 객체의 내용을 다른 뷰로 보여주는 메서드 : asType (
asList
) - 객체의 값을 기본 타입 값으로 반환하는 메서드 이름 : typeValue (
intValue
) - 정적 팩터리의 이름 : from of, valueOf, instance, getInstance, newInstance, getType, newType 등
필드 이름
- 필드 이름에 대한 문법 규칙은 덜 명확하고 덜 중요하다. (필드가 직접 노출되는 경우는 거의 없기 때문)
- boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다(
initialized
,composite
) - 다른 타입은 명사나 명사구를 사용한다. (
height
,digits
,bodyStyle
)