(코딩 컨벤션) Predicate Methods에서 'should', 'must', 'need' 는 어떻게 써야 좋을지에 대한 고찰

개요

 코드를 짜다보면 Boolean 값을 반환하는 프레디케이트 메소드(Predicate Methods)를 굉장히 많이 작성하게 된다. 이때 메소드 이름을 통해 그 의도를 분명히 전달하는 것이 굉장히 중요한데, 이러한 메소드에 should, must, need와 같은 동사를 어떻게 사용할지 애매모호한 경우가 많다. 이렇게 순간의 직관에 의존하여 느낌대로 단어를 선택하게 되면 코드의 일관성을 해치면서 유지 보수 용이성도 떨어지고 자연스레 프로덕트 품질도 떨어지게 된다. 이번 고찰에서는 should, must, need와 같은 동사를 프레디케이트 메소드에 어떻게 효과적으로 사용할 수 있는지 이야기해보자.

 

내용

프레디케이트 메소드란?

 프레디케이트 메소드(Predicate Methods)는 Boolean 값을 반환하는 메소드로, 주로 객체의 상태를 확인하거나 특정 조건을 만족하는지를 검사하는 데 사용된다. 예를 들어, isEmpty(), hasNext(), canExecute() 등이 프레디케이트 메소드의 대표적인 예이다. 

 

'should'의 사용 상황과 예시

 should는 메소드가 특정 동작이나 상태를 권장하거나 바람직한지 여부를 나타낼 때 사용된다. 이는 필수가 아닌, 권장 사항임을 암시하며, 조건이 참일 때 어떤 행동을 취하는 것이 좋다는 의미를 전달한다.

 

• 사용 상황
  • 특정 조건이 권장되거나 바람직한지 확인할 때
  • 실행 여부가 선택적이지만 권장될 때
  • 코드의 의도나 행동을 안내할 때

// shouldUpdateUI(): UI를 업데이트하는 것이 권장되는지 여부를 확인한다.
boolean shouldUpdateUI();

// shouldRetryConnection(): 연결을 재시도하는 것이 바람직한지 여부를 판단한다.
boolean shouldRetryConnection();

// shouldLogEvent(): 이벤트를 로깅하는 것이 좋을지 여부를 결정한다.
boolean shouldLogEvent();

 

'must'의 사용 상황과 예시

must는 메소드가 특정 조건을 필수적으로 충족해야 함을 나타낼 때 사용된다. 이는 강한 필수성을 의미하며, 조건이 거짓일 경우 반드시 처리해야 할 필요가 있음을 암시한다.

 

• 사용 상황
  • 특정 조건이 반드시 충족되어야 할 때
  • 필수적인 검증이나 확인이 필요할 때
  • 시스템의 안정성과 보안을 위해 필수적인 조건을 검사할 때

// mustAuthenticateUser(): 사용자가 인증되었는지 반드시 확인해야 한다.
boolean mustAuthenticateUser();

// mustValidateInput(): 입력값을 반드시 검증해야 한다.
boolean mustValidateInput();

// mustHavePermission(): 권한이 반드시 있어야 하는지를 확인한다.
boolean mustHavePermission();

 

'need'의 사용 상황과 예시

 need는 메소드가 특정 조건이나 리소스의 필요성을 나타낼 때 사용된다. 이는 특정 기능이나 작업을 수행하기 위해 반드시 필요한 조건임을 강조한다.

• 사용 상황
  • 특정 리소스나 조건이 필요한지 확인할 때
  • 작업 수행을 위해 필수적인 요소의 존재 여부를 검사할 때
  • 특정 기능을 사용하기 위한 사전 조건을 확인할 때

// needConfiguration(): 구성 설정이 필요한지 여부를 확인한다.
boolean needConfiguration();

// needPermission(): 권한이 필요한지 여부를 판단한다.
boolean needPermission();

// needData(): 데이터를 필요로 하는지 여부를 검사한다.
boolean needData();