[EffectiveJava] item68 - 일반적으로 통용되는 명명 규칙을 따르라

10 Jul 2023

자바 플랫폼은 명명 규칙이 잘 정립되어 있으며. 그중 많은 것이 자바 언어 명세에 기술 되어있다.

자바의 명명 규칙은 크게 철자와 문법, 두 범주로 나뉜다.

자바의 명명 규칙

철자

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다. 이 규칙들은 특별한 이유가 업슨한 반드시 따라야 한다.

규칙을 어긴 API는 사용하기 어렵고, 유지보수하기 어려운 등 여러 불편한점이 따라온다.

패키지와 모듈

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

패키지

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다.
각 요소는 일반적으로 8자 이하의 짧은 단어로 한다.
utilities 보다는 util 같은 약어를 추천한다. 여러 단어로 구성시 awt와 같이 각 단어의 첫글자만 따서 써도 좋다.
도메인 이후 하나만 붙인 패키지 외에 많은 기능을 제공하는 경우엔 계층을 더 많은 요소로 구성해도 좋다. ex) java.util의 java.util.concurrent.atomic

클래스와 인터페이스

하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.(List, FutherTask 등)
여러 단어의 첫 글자만 딴 약자나 max, min과 같은 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다.

메서드와 필드

첫 글자르 소문자를 쓴다는 점만 빼면 클래스 명명 규칙과 같다. ex) remove, ensureCapacity
첫 단어가 약자라면 단어 전체가 소문자 여야한다.

상수 필드

상수 필드는 값이 불변인 static final 필드를 말한다.
예외적으로 필드를 구성하는 단어는 모두 대문자로 쓰이며, 단어 사이는 밑줄로 구분한다 ex) VALUES, NEGATIVE_INFINITY

지역 변수

다른 멤버와 비슷한 명명 규칙이 적용된다.
약어를 써도 좋다. 약어를 써도 그 변수가 사용되는 문맥에서 쉽게 유추가 가능하다. 단, 일반 지역변수보다는 신경 써야한다.

타입 매개변수

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

이상 위의 정리된 내용을 표로 정리해보면 아래와 같다.

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

문법 규칙

문법 규칙은 철자 규칙과 비교하면 더 유연하고 논란도 많다.

패키지

패키지에 대한 규칙은 따로 없다.

클래스

객체를 생성할 수 있는 클래스(열거 타입 포함): 보통 단수 명사나 명사구를 사용한다. ex) Thread, PriorityQueue, ChessPiece
객체를 생성할 수 없는 클래스: 보통 복수형 명사로 짓는다. ex) Collectors, Collections
인터페이스: 클래스와 똑같이 짓거나 ex) Collection, Comparator. 또는 able, idle로 끝나는 형용사로 짓는다. ex) Runnable, Iterable, Accessible
애너테이션: 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다 ex) BindingAnnotation, Inject, Singleton

메서드

어떤 동작을 수행하는 메서드의 이름은 동사나 동사구로 짓는다 ex) append, drawImage
boolean 값을 반환하는 메서드라면 보통 is나 (드물게) has로 시작하고 명사나 명사구, 혹은 형용사로 기능하는 아무 단어로 끝나도록 짓는다 ex) isDigit, isEmpty, hasSiblings
반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통 명사, 명사구 혹은 get을 시작하는 동사구로 짓는다 ex) size, hashCode, getTime

get 메서드

get으로 시작하는 형태는 주로 자바빈즈(javaBeans) 명세에 뿌리를 두고있다. 자바빈즈는 재사용을 위한 컴포턴트 아키텍처의 초기버전이지만, 최근의 도구중에도 이 명명 규칙을 따르는 경우가 제법 많다. 따라서 이 규칙을 따라도 상관 없다.

그 외 메서드 명명 규칙

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

객체의 타입을 바꿔서, 다른 타입의 또다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다 ex) toString, toArray
객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType 형태로 짓는다 ex) asList
객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 typeValue 형태로 짓는다 ex) intValue
정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType 을 흔히 사용한다.

필드

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

지역 변수 이름도 필드와 비슷하게 지으면 되나, 조금더 느슨하다.

DEV ℧ Developer Diary