Item68. 일반적으로 통용되는 명명 규칙을 따르라!
Intro
- 자바 플랫폼은 명명 규칙이 잘 정립되어 있다.
- 그중 많은 것이 자바 언어 명세에 기술되어 있다.
- 자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다.
- 철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입변수의 이름을 다룬다.
- 이 규칙들은 특별한 이유가 없는 한 반드시 따라야 한다.
패키지와 모듈
- 패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
- 요소들은 모두 소문자 알파벳 혹은 (드물게) 숫자로 이뤄진다.
- 조직의 인터넷 도메인의 역순을 패키지명으로 사용한다.
- 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java, javax로 시작한다.
- 도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세를 살펴보자.
- 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄지는데, 보통 8자 이하의 짧은 단어를 사용한다.
- 예를 들어 utilities 보다는 util처럼 의미가 통하는 약어를 사용한다.
- 많은 기능을 제공하는 경우 계층을 더 많이 나눠 패키지 명에 요소를 추가해도 된다.
- 예를 들어 java.util과 java.util.concurrent.atomic과 같이 그 밑에 수많은 패키지를 가지고 있는 경우
클래스와 인터페이스
- 이름은 하나 이상의 단어로 이뤄진다. 각 단어는 대문자로 시작한다.
- 여러 단어가 혼합된 경우, 첫 글자만 대문자로 사용하는 경우가 많다. (ex, HttpUrl)
- 여러 단어의 첫 글자만 딴 약자나 max, min 처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여쓰지 않는다.
메서드와 필드
- 첫 글자를 소문자로 쓴다.
- 이 외의 규칙은 클래스 명명 규칙과 같다.
- 첫 단어가 약자라면 단어 전체가 소문자여야 한다.
- 상수 필드는 예외로, 구성하는 단어 모두를 대문자로 사용한다. 단어 사이는 밑줄로 구분한다. 상수필드는 유일하게 밑줄을 사용한다.
변수
- 지역변수도 다른 멤버와 비슷한 명명 규칙이 적용된다. 약어를 사용해도 좋다.
- 입력 매개변수도 지역변수 중 하나지만 메서드 설명 문서에 등장하는 만큼 일반 지역변수보다는 네이밍에 신경써야 할 것이다.
- 타입 매개변수는 보통 한 문자로 표현되고, 대게 다음 다섯 가지 중 하나다.
- 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을 흔히 사용한다.
핵심 정리
- 표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자.
- 철자 규칙은 직관적이라 모호한 부분이 적다. 하지만 문법 규칙은 더 복잡하고 느슨하다.
- “오랫동안 따라온 규칙과 충돌한다면 그 규칙을 무조건 따라서는 안 된다.” 상식이 이끄는 대로 따르자.
Comments powered by Disqus.