제너럴한 명명규칙 정리

명명규칙을 알아보기 전에

1. [1주차] 문서 분석 - Google Java Style Guide & 우테코 자바 스타일 가이드 이거 한 번 더 읽는 게 나을 수도 있겠다.

그냥 앞으로 코드 작성 전에 한 번씩 정독하고 들어가는 게 나을지도

2. 클래스 이름은 카멜케이스 명사,
인터페이스는 명사 또는 형용사,
테스트클래스 이름은 테스트 대상 클래스명 뒤에 Test를 붙인 것,
메서드 이름은 소문자 시작 카멜케이스 동사,
상수는 전체 대문자 + 언더스코어 명사

3. 스태틱 클래스 멤버에 한정자(Qualifier)를 사용해야 할 경우
클래스 이름으로 한정 O, 그 클래스 타입의 참조나 표현식 사용 X

제너럴한 명명규칙

1. 자주 사용되는 접두사

접두사	용도	예시
is	boolean 변수나 메서드	isActive() isEmpty() isValid()
has	특정 속성이나 요소의 존재 여부를 확인하는 boolean 메서드	hasChildren() hasAccess() hasErrors()
get	속성의 값을 반환하는 getter 메서드	getName() getAge() getItems()
set	속성의 값을 설정하는 setter 메서드	setName(String name) setAge(int age) setItems(List<Item> items)
add	컬렉션에 요소를 추가하는 메서드	addItem(Item item) addUser(User user)
remove	컬렉션에서 요소를 제거하는 메서드	removeItem(Item item) removeUser(User user)
update	기존 객체의 속성을 수정하는 메서드	updateUser(User user) updateProfile(Profile profile)
init / initialize	객체나 설정을 초기화하는 메서드	init() initializeSettings()
load	데이터를 불러오는 메서드	loadConfiguration() loadData()
save	데이터를 저장하는 메서드	saveUser(User user) saveFile(File file)

2. 자주 사용되는 접미사

접미사	용도	예시
Handler	특정 이벤트나 작업을 처리하는 클래스	EventHandler RequestHandler
Manager	리소스나 기능을 관리하는 클래스	ConnectionManager UserManager
Service	비즈니스 로직을 처리하는 클래스	UserService OrderService
Factory	객체 생성을 담당하는 클래스	ConnectionFactory ShapeFactory
Controller	MVC 패턴에서 요청을 처리하고 응답을 반환하는 클래스	UserController ProductController

👉 적절한 명명 규칙 사용은 주석 없이도 메서드나 변수, 클래스의 사용처를 짐작할 수 있게 함

비고

1. 이번주차 과제에서 활용해 보는 걸 목표로 가자.

레퍼런스

1. Google Java Style Guide, Wooteco Java Style Guide, 내 개발 경험