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

2021-09-01

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

철자 규칙

철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.

이 규칙을 어긴 API는 사용하기 어렵고, 유지보수하기 어렵다.

철자 규칙이나 뭄법 규칙을 어기면 다른 프로그래머들이 그 코드를 읽기 번거로울 뿐 아니라 다른 뜻으로 오해할 수 있다.

패키지와 모듈

패키지와 모듈 이름은 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.

소문자 알파벳 혹은 숫자로 이뤄진다.

조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다.

예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.

com.google

패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄 진다.

각 요소는 일반적으로 8자 이하의 짧은 단어로 한다.

utilities보다는 util처럼 의미가 통하는 약어가 좋다. 여러 단어라면 awt처럼 각 단어의 첫 글자만 따면 좋다.

com.google.util 에서 util

인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만, 많은 기능을 제공하는 경우 계층을 더 나눠서 구성하면 좋다.

java.util 안에는 더 세부적으로 나누기 위해 java.util.concurrent.atomic 과 같은 수많은 패키지로 나눠져 있다.

클래스와 인터페이스

클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며 각 단어는 대문자로 시작한다. List , FutherTask

여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제회하고는 단어를 줄여 쓰지 않도록 한다.

약자의 경우 첫글자만 대문자로 하는 것이 좋다. HttpUrl 처럼 여러 약자가 혼합된 경우라도 각 약자의 시작과 끝을 명확히 알 수 있기 때문이다.

메서드와 필드 이름

메서드와 필드 이름은 첫글자를 소문자로 쓴다는 점만 빼며 클래스 규칙과 같다.

첫 단어가 약자라면 단어 저체가 소문자여야 한다.

상수 필드

상수필드는 모두 대문자로 쓰며, 단어 사이는 밑줄로 구분한다. NEGATIVE_INFITINIY

지역 변수

지역변수에도 다른 멤버와 비슷한 명명 규칙이 적용된다. 단 약어를 써도 좋다.

약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문이다. (i ,denom, houseNum )

입력 매개변수도 지역변수의 하나다.

특히 입력 매개변수는 메서드 설명 문서에도 등장하니, 신경을 많이 써야 한다.

타입 매개변수

타입 매개변수 이름은 보통 한 문자로 표현한다. 대부분은 다음 중 하나다.

  • T : 임의의 타입
  • E : 컬렉션 원소 타입
  • K : 맵의 키
  • V : 맵의 값
  • X : 예외
  • R : 메서드 반환 타입

그 외의 임의 타입 시퀀스에는 T,U,V 또는 T1, T2 ,T3를 사용한다.

문법 규칙

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

패키지와 모듈

이거에 관한 규칙은 따로 없다

클래스

클래스의 이름은 보통 단수 명사나 명사구를 사용한다.

Thread , PriorityQueue , ChessPiece

객체를 생성할 수 없는 클래스 의 이름은 보통 복수형 명사로 짓는다. Collectors ,Collections

인터페이스

인터페이스 이름은 클래스와 똑같이 짓거나 (Collection ,Comparator ) 아니면 ,able 혹은 ible 로 끝나는 형용사로 짓는다. (Runnable,Iterable)

어노테이션은 워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다 Inject , ImplementedBy

메서드

어떤 동작을 수행하는 메서드의 이름은 동사나 목적얼르 포함한 동사구로 짓는다. append , drawImage

boolean 값을 반환하는 메서드라면 is나 hash로 시작하고 명사구 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.

isDigit , isProbablePrime , isEmpty , isEnabled

반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름은 보통

  • 명사
  • 명사구
  • get으로 시작하는 동사구

로 짓는다.

다른 타입으로 바꾸는 메서드 이름

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

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

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

정적 팩터리의 이름은 다양하지만, from, of, valueOf, instance, getInstance 을 흔히 사용 한다.

필드 이름

필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하고 덜 중요하다.

API 설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다.

boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다. initialized , composite

다른 타입의 필드라면 명사나 명사구를 사용한다. height ,digits ,bodyStyle

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