본문 바로가기
springboot

[springboot] Controller, Service, Repository 메서드명 규칙

by 개발LOG 2024. 2. 20.

Contoller

  • 컨트롤러의 메소드명은 해당 메소드가 수행하는 작업을 설명하는 동사로 시작합니다.
  • 주로 HTTP 요청 메소드(GET, POST, PUT, DELETE 등)와 관련된 동사를 사용합니다.
  • 예를 들어, 데이터를 조회하는 메소드의 경우 get으로 시작하고, 데이터를 생성하는 메소드의 경우 create로 시작합니다.
  • 예시: getUserById, createUser, updateUser, deleteUser 등

Service의 메서드

  • 서비스의 메소드명은 해당 메소드가 제공하는 기능이나 업무를 명확하게 설명하는 동사로 시작합니다.
  • 비즈니스 로직이나 특정 업무 처리를 담당하는 메소드의 이름을 지을 때 주로 사용됩니다.
  • 예를 들어, 주문을 처리하는 메소드의 경우 processOrder와 같이 설명적인 동사를 사용합니다.
  • 예시: processOrder, calculateTotalPrice, cancelReservation 등

Repository의 메서드

  • 레포지토리의 메소드명은 데이터베이스와 관련된 작업을 수행하는데, 주로 데이터베이스에서 데이터를 조회, 삽입, 갱신, 삭제하는 동작을 나타냅니다.
  • 주로 CRUD(Create, Read, Update, Delete) 기능과 관련된 동사를 사용합니다.
  • 예를 들어, 사용자를 검색하는 메소드의 경우 findByUsername과 같이 시작합니다.
  • 예시: findById, save, delete, findByUsername, findAllByCategory 등