Item_68._naming_convention.md

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

자바의 철자 규칙

패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름 철자에 대한 특징

패키지/모듈

• 점(.)으로 구분, 계층적 구조
• 소문자와 숫자로만 구성하며 대문자 특수문자는 사용하지 않는 것을 권장
  • 스네이크 케이스, 카멜 케이스 등을 쓰지 않도록 주의해야 함
• 인터넷 도메인 이름의 역순으로 구성
  • com, org 등으로 시작하는 경우가 많음
  • java, javax와 같은 표준 라이브러리는 예외
• 최상위 도메인명 이후로는 그룹을 잘 나타낼 수 있는 요소 이름을 사용
  • 대문자와 특수문자(하이픈, 언더바 등)를 사용할 수 없는 만큼 약어를 사용하거나 여러 단어로 이루어질 경우 각 단어의 앞글자만 따서 사용하는 것을 추천

클래스/인터페이스/특수클래스(열거 타입, 어노테이션)

• 첫 단어를 대문자로 시작하며 단어 간 대문자 연결 (파스칼 케이스)
• 통용되는 줄임말(max, min 등)을 제외하고는 줄임말을 쓰지 않는 것이 좋음
• 약자의 경우에도 모두 대문자로 쓰기보다는 첫 글자만 대문자로 쓰는 편이 해당 약자의 처음과 끝을 명확히 알 수 있어서 좋음
  • HttpURL (X), HttpUrl (O)

메서드/필드

• 첫 단어를 소문자로 시작하며 단어 간 대문자 연결 (카멜 케이스)
• 상수 필드는 예외적으로 불변성을 나타내기 위해 대문자와 언더바를 사용
• 클래스/인터페이스와 마찬가지로 약어를 사용하지 않는 것이 좋으나, 지역변수는 해당 스코프 내에서 쉽게 문맥을 유추할 수 있는 경우 약어를 써도 좋음

타입 매개변수

• 한 문자로 표현하며, 아래 5가지 중 하나를 사용해 의미를 표현하기 쉬움
  • T(type): 임의의 타입
  • E(element): 컬렉션의 원소
  • K, V(key, value): 맵의 키와 값
  • X(exception): 예외
  • R(return): 메서드의 반환 타입

자바의 문법 규칙

클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름에 사용되는 문법적 특징

클래스, 열거 타입

• 단순 명사, 명사구
• 객체를 생성할 수 없는 클래스(상태값이 없는, 단순히 특정 기능만을 수행하는 클래스)의 경우 복수형 명사 사용을 권장
  • Collections, StringUtils 등

인터페이스

• 클래스와 동일한 규칙을 따르거나, 특정 행동이 가능함을 나타내는 형용사(able, ible) 사용
  • Runnable, Accessible

어노테이션

• 정해진 규칙이 없으며 명사, 동사, 형용사 등이 다양하게 사용됨

메서드

• 동사, 동사구
• boolean을 반환하는 경우 is, has 등으로 시작
• 인스턴스 내 필드값을 반환하는 메서드는 다음과 같은 형식을 선택
  1. get~
     • 자바빈즈(JavaBeans)에서 주로 사용하는 명명 규칙 (getter, setter)
  2. 반환하는 필드명과 동일한 명사(구)
• 객체의 타입을 변경해 다른 타입의 새 객체를 반환하는 인스턴스의 경우 toType 형태로 명명
  • toString, toArray 등
• 객체의 내용을 다른 타입의 뷰로 보여주는 메서드는 asType 형태로 명명
  • asList 등
• 정적 팩터리의 이름은 from, of, valueOf 등 정해진 규약 내에서 선택
  • 아이템 1 참조

필드

• (API를 잘 설계했다면) 외부에 노출될 일이 없는 경우가 많으므로 가장 명명 규칙의 영향을 덜 받음
• 명사, 명사구를 사용
• boolean 필드의 경우 해당 필드의 접근자 메서드에서 is, has를 제외한 형태