📌 명명 규칙
- 크게 철자와 문법, 두 범주로 나뉜다.
- 철자 규칙은 패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수의 이름을 다룬다.
- 특별한 이유가 없는 한 반드시 따라야 한다.
- 이 규칙을 어긴 API는 사용이 어렵고, 유지보수가 힘들다.
- 문법 규칙은 좀 더 유연하고 논란도 많다.
📌 철자 규칙
| 식별자 타입 | 예 |
| 패키지와 모듈 | org.junit.jupiter.spi, 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 |
🟡 패키지와 모듈
- 각 요소를 점(.)으로 구분하여 계층적으로 짓는다.
- 요소들은 모두 소문자 알파벳 혹은 드물게 숫자로 이루어진다.
- 조직 바깥에서도 사용될 패키지라면 인터넷 도메인 이름의 역순으로 사용한다.
- edu.cmu, com.google, org.eff 식이다.
- 예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다.
- 도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세에 적혀있다.
- 패키지의 이름
- 하나 이상의 요소로 이루어진다.
- 일반적으로 8자 이하의 짧은 단어로 한다. (utilities보다는 util)
- 여러 단어로 구성된 이름이라면 awt처럼 각 단어의 첫글자만 따서 써도 좋다.
- 요소의 이름은 보통 한 단어 혹은 약어로 이루어진다.
- 인터넷 도메인 이름 뒤에 많은 기능을 제공한다면 계층을 나누어 더 많은 요소로 구성해도 좋다.
🟡 (열거타입과 어노테이션을 포함한) 클래스와 인터페이스
- 하나 이상의 단어로 이루어진다.
- 각 단어는 대문자로 시작(Camel)한다.
- 여러 단어의 첫 글자만 딴 약자나 max, min처럼 통용되는 줄임말을 제외하고 줄여쓰지 마라.
- 약자를 첫 글자만, 혹은 전체를 대문자로 할 지는 의견의 차이가 있으나 전자가 대체로 보기 좋다.
🟡 메서드와 필드
- 첫 글자를 소문자로 쓰는 것 외에 클래스 명명 규칙과 같다.
- 첫 단어가 약자라면 단어 전체가 소문자여야 한다.
1️⃣ 상수 필드
- 모두 대문자로 작성하며, 구분자는 언더바(_)를 사용한다.
- static fianl인 필드 타입이 기본 타입이나 불변 참조 타입(Item 17)이라면 상수 필드에 해당한다.
- 가변이더라도 참조하는 객체가 불변이라면 상수 필드에 해당한다.
- 구분자로 언더바를 사용하는 요소는 상수 필드가 유일하다.
2️⃣ 지역 변수
- 다른 멤버와 비슷한 명명 규칙이 적용된다.
- 약어를 사용해도 좋다.
- 입력 매개변수의 경우엔 method 설명 문서에도 나오는 만큼 지역 변수보다는 신경 써야 한다.
3️⃣ 타입 매개변수
- 보통 한 문자로 표현한다.
- T : 임의의 타입
- E : 컬렉션 원소의 타입
- K, V : 맵의 키와 값
- X : 예외
- R : 메서드 반환 타입
- T, U, V 혹은 T1, T2, T3 : 임의 타입의 시퀀스
📌 문법 규칙
🟡 패키지
- 따로 없다.
🟡 클래스(열거 타입 포함)와 인터페이스와 어노테이션
- 객체를 생성할 수 있는 경우
- 단수 명사나 명사구를 사용한다. (Thread, PriorityQueue, ChessPiece 등)
- 객체를 생성할 수 없는 경우
- 복수형 명사로 짓는다. (Collectors, Collections 등)
- 인터페이스는 클래스와 똑같이 짓거나, able 혹은 ible로 끝나는 형용사로 짓는다.
- Collection, Comparator 등
- Runnable, Iterable, Accessible 등
- 어노테이션은 너무 다양해서 지배적인 규칙이 없다.
🟡 메서드
- 어떤 동작을 수행하는 메서드
- 동사나 (목적어를 포함한) 동사구로 짓는다.
- append, drawImage 등
- boolean 값을 반환하는 메서드
- is나 드물게 has로 시작한다.
- 명사나 명사구, 혹은 형용사로 기능하는 아무 단어나 구로 끝나도록 짓는다.
- isDigit, isProbablePrime, isEmpty, isEnabled, hasSiblings 등
- 해당 인스턴스의 속성을 반환하는 메서드
- 보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.
- size, hashCode, getTime 등
- "get~" 형식을 지켜야 한다고 주장하는 사람이 있으나 근거가 부족하다.
- car.getSpeed()보다는 car.speed()가 가독성이 좋다.
- 자바빈즈(JavaBeans) 명세에 뿌리를 두는 형태다
- 해당 명명 규칙을 따르는 도구와 어우러지는 코드를 작성할 때는 이 규칙을 따라도 좋다.
- 객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드
- toType 형태로 짓는다.
- toString, toArray 등
- 객체의 내용을 다른 뷰로 보여주는 메서드
- asType 형태로 짓는다.
- asList 등
- 객체의 값을 기본 타입 값으로 반환하는 메서드 이름
- typeValue 형태로 짓는다.
- intValue 등
- 정적 팩터리 메서드 이름은 from, of, valueOf, instance, getInstance, newInstance, getType, newType을 흔히 사용한다. (Item 1)
🟡 필드
- 문법 규칙이 클래스, 인터페이스, 메서드에 비해 덜 중요하다.
- API를 잘 설계했다면 애초에 필드가 직접 노출될 일이 거의 없기 때문이다.
- boolean 타입의 필드
- 보통 boolean 접근자 메서드에서 앞의 단어를 뺀 형태다.
- initialized, composite 등
- 다른 타입의 필드
- 명사나 명사구를 사용한다
- height, digits, bodyStyle 등
- 지역 변수 이름도 필드와 비슷하게 지으면 되나, 조금 더 느슨하다.