일반적으로 통용되는 명명 규칙을 따르라

자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다. 이 규칙을 어긴 API는 사용하기 어렵고, 유지보수하기 어렵다.

철자 규칙

패키지와 모듈

패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 요소들은 모두 소문자 알파벳 혹은 숫자로 이뤄진다. 조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다. edu.cmu, com.google, org.eff 식이다. 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. utilities 보다는 util처럼 의미가 통하는 약어를 추천한다. 여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 써도 좋다. 요소의 이름은 보통 한 단어 혹은 약어로 이뤄진다.

클래스와 인터페이스

열거 타입과 애너테이션을 포함해 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다. 여러 단어의 첫 글자만 딴 약자나 max, min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다. 약자의 경우도 첫 글자만 대문자로 하는 게 낫다. HttpUrl 처럼 여러 약자가 혼합된 경우라도 각 약자의 시작과 끝을 명확히 알 수 있기 때문이다.

메서드와 필드

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

지역변수

다른 멤버와 비슷한 명명 규칙이 적용된다. 단, 약어를 써도 좋다. 약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문이다. 입력 매개변수도 지역변수의 하나다. 하지만 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수보다는 신경을 써야 한다.

타입 매개변수

보통 한 문자로 표현한다. 대부분은 다음의 다섯 가지 중 하나다.
임의의 타입 T, 컬렉션 원소의 타입 E, 맵의 키와 값 K와 V, 예외 X, 메서드의 반환 타입 R을 사용한다. 그 외에 임의 타입의 시퀀스에는 T, U, V 혹은 T1, T2, T3를 사용한다.

문법 규칙

클래스와 인터페이스

• 객체를 생성할 수 있는 클래스의 이름은 보통 단수 명사나 명사구를 사용한다.
• 객체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다.
• 인터페이스 이름은 클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다.
• 애너테이션은 워낙 다양하게 활용되어 지배적인 규칙 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다.

메서드

• 메서드의 이름은 동사나 동사구로 짓는다.
• boolean 값을 반환하는 메서드라면 보통 is나 has로 시작하고 명사나 명사구, 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.
• 반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.

특별한 메서드 이름이 몇 가지 있다.

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

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

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

• 정적 팩터리 from, of, valueOf, instance, getInstance, newInstance, getType, newType

필드

필드 이름에 관한 문법 규칙은 덜 중요하다. API 설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다. boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다. 다른 타입의 필드라면 명사나 명사구를 사용한다.
지역변수 이름도 필드와 비슷하게 지으면 되나, 조금 더 느슨하다.