[CleanCode] 의미있는 네이밍 하는법(JAVA)

들어가며

모든 개발자가 이해하기 쉽게 의미있는 네이밍 하는방법을 다룬 포스트입니다.

Google Java Style Guide 문서를 기반으로 작성되었습니다.

🍊 공통 규칙

• 패키지와 클래스를 제외한 모든 코드는 lowerCamelCase로 작성한다.
• 모든 코드는 ASCII 문자와 숫자만 사용한다.
• 접두사와 접미사를 사용하지 않는다.
  ex)kName, name_ (❌)
  
  

🍓 패키지 이름

• 패키지 이름은 모두 소문자이며 연속된단어도 소문자로 작성한다
  ex) com.example.deepspace
  
  

🥭 클래스 이름

• 클래스의 이름은 UpperCamelCase로 작성한다.
• 클래스의 이름은 꼭 명사 or 명사구 여야 한다.
  인터페이스의 경우 형용사구를 사용할 때도 있다.
  ex)Readable
• 테스트 클래스의 이름은 테스트중인 클래스의 이름 + Test 형식이다.
  ex)NameTest
  
  

🍑 메서드 이름

• 메서드 이름은 일반적으로 동사 or 동사구 이다.
  기본적으로 동사로 시작하고, 타입변환 메서드나 빌더 패턴클래스의 메서드에는 전치사를 쓸 수있다.

//전치사
public String toString(){}
public User of(){}

🍋 메서드 이름으로 자주 사용되는 동사

• get/set
  getter/setter 에서 사용한다.(getter/setter의 사용은 지양하는것이 좋다.)

• init
  데이터를 초기화하는 메서드 명에 쓰인다.

• is/has/can
  위의 3개는 boolean 값을 리턴한다.
  is = 맞는지 틀린지 판단하는 메서드 명에 쓰인다.
  has = 데이터를 가지고 있는지 확인하는 메서드 명에 쓰인다.
  can = 할 수 있는지 없는지 확인하는 메서드 명에 쓰인다.

• create
  새로운 객체를 만든 후 리턴해주는 메서드 명에 쓰인다.
  ex) 팩토리 패턴 메서드 반환

• find
  데이터를 찾아 반환하는 메서드 명에 쓰인다

• to
  해당 객체를 다른 형태의 객체로 변환해주는 메서드 명에 쓰인다.

• A-By-B
  B를 기준으로 A를 하겠다는 메소드명에 쓰인다.
  ex) getUserByName(String name)
  
  

🍎 상수 이름

상수란 내용이 불변하는 static final 필드이다.

• 모두 대문자로 작성하고 띄워쓰기는 언더바 (_) 를 사용합니다.
  예시👇

private static final String OUR_PLANET_NAME = "Earth";