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

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

---

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

• 자바의 명명 규칙은 크게 철자와 문법으로 나뉜다
• 철자 규칙이나 문법 규칙을 어기면 다른 개발자들이 코드를 읽기도 번거롭고 잘 못 이해하는 경우도 발생한다

철자 규칙

• 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다루며 이 규칙들은 특별한 이유가 없으면 반드시 지켜야 한다
  • 이 규칙을 어긴 API는 사용도 어렵고 유지보수도 어렵다
• 패키지와 모듈 이름은 각 요소를 점(.)으로 구분해서 계층적으로 짓는다
• 요소들은 모두 소문자 알파벳이나 숫자로 이루어진다
• 조직 바깥에서도 사용될 패키지는 조직의 도메인 이름을 역순으로 사용한다
  • ex) edu.cmu, com.google, org.eff
  • 표준 라이브러리와 선택적 패키지들은 예외적인 케이스로 java , javax로 시작한다
• 패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이루어진다
  • 각 요소는 보통 8자 이하의 짧은 단어로 하며 utilities 보다 util 같은 의미가 통하는 약어를 사용한다
  • 여러 단어로 구성된 이름이면 awt 처럼 각 단어의 첫 글자만 따는것도 좋다
  • 요소 이름은 보통 한 단어나 약어로 이루어진다
  • 인터넷 도메인 이름 뒤에 요소 하나만 붙인 패키지가 많지만 많은 기능을 제공한다면 계층을 나눠 더 많은 요소로 구성해도 좋다
• 열거 타입과 애너테이션을 포함하여 클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄진다
  • 각 단어는 대문자로 시작한다
  • 여러 단어의 첫 글자만 딴 약자거나 max, min 같이 널리 쓰이는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다
  • 약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지의 논란이 있다
    • 전체를 대문자로 하는 사람도 있지만 첫 글자만 대문자로 하는 경우가 더 많다
• 메서드와 필드 이름은 첫 글자를 소문자로 쓰는걸 제외하곤 클래스 명명 규칙과 같다
  • 첫 단어가 약자라면 단어 전체가 소문자여야 한다
  • 단 상수 필드는 예외적으로 구성하는 단어 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다
    • 이름에 밑줄을 사용하는건 상수필드가 유일하다
• 지역변수에도 다른 멤버와 비슷한 명명 규칙이 적용된다
  • 약어를 사용해도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추 가능하기 때문에 약어를 사용해도 괜찮다
  • 입력 매개변수도 지역변수의 하나이며 메서드 설명 문서에까지 등장하는 만큼 일반 지역변수보다 신경 써야 한다
• 타입 매개변수 이름은 보통 한 문자로 표현한다
  • 대부분 아래의 5가지중 하나다
    • 임의의 타입엔 T
    • 컬렉션 원소 타입은 E
    • 맵의 키와 값에는 K와 V
    • 예외에는 X
    • 메서드 반환 타입에는 R
    • 그 외 임의 타입의 시퀀스에는 T, U, V, T1, T2, T3 을 사용한다

문법 규칙

• 철자 규칙과 비교하면 더 유연하며 논란도 많다
• 패키지에 대한 규칙은 따로 없다
• 객체를 생성할 수 있는 클래스, 열거타입의 이름은 보통 단수 명사나 명사구를 사용한다
• 겍체를 생성할 수 없는 클래스의 이름은 보통 복수형 명사로 짓는다
• 인터페이스의 이름은 클래스와 똑같이 짓거나 able, ible로 끝나는 형용사로 짓는다
• 애너테이션은 워낙 다양하게 활용되어 지배적인 규칙이 없이 명사, 동사, 전치사, 형용사가 두루 쓰인다
• 어떤 동작을 수행하는 메서드의 이름은 동사나 목적어를 포함한 동사구로 짓는다
  • boolean 값을 반환하는 메서드는 보통 is나 has로 끝난다
  • 명사나 명사구, 형용사로 기능하는 아무 단어나 구로 끝나지 않도록
• 반환 타입이 boolean이 아니거나 해당 인스턴스의 속성을 반환하는 메서드의 이름
  • 보통 명사, 명사구, get으로 시작하는 동사구로 짓는다
  • get으로 시작하는 형태만 써야 한다는 주장도 있었지만 그에 따른 근거가 빈약했다
• 특별한 메서드 이름
  • 객체의 타입을 바꿔 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다
  • 객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType 형태로 짓는다
  • 객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 보통 typeValue 형태로 짓는다
  • 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType 을 흔히사용한다
• 필드 이름에 관한 문법 규칙은 클래스, 인터페이스, 메서드 이름에 비해 덜 명확하며 덜 중요하다
  • API 설계를 잘 했다면 필드가 직접 노출될 일이 거의 없기 때문이다
  • boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다
  • 다른 타입 필드라면 명사나 명사구를 사용한다
    • 지역변수 이름도 필드와 비슷하게 지어지긴 하지만 조금 더 느슨하다

표준 명명 규칙을 체화하여 자연스럽게 베어 나오도록 하자

철자 규칙은 직관적이라 모호한 부분이 적은 데 반해 문법 규칙은 더 복잡하고 느슨하다

자바 언어 명세의 말을 인용하자면 "오랫동안 따라온 규칙과 충돌한다면 그 규칙을 맹종해서는 안된다" 상식이 이끄는대로 따르자