[Feat] 프로젝트 구조 통일 위한 리팩터링 / 통일된 기준으로 기능 구현

[kor-Chipmunk]

⚠️ Issue

• 코드 구조를 변경하고 코드를 리팩터링합니다.

✏️ ToDoList

• [x] 구조 변경
• [x] 코드 리팩터링
• [x] 변경된 구조 문서화

[kor-Chipmunk]

코드는 다음 규칙으로 작성됩니다. 우선, 대략적으로 소개하는 의미로 생각나는 대로 정리했습니다. 성능은 다소 포기하면서 최대한 코드를 통일하면서 기능 추가 시 구조를 유지하기 쉽도록 리팩터링했습니다. 자세한 사항은 따로 노션으로도 정리할 예정입니다.

• 변수명 / 클래스명 모두 축약 없이 최대한의 인식 정보를 담도록 명확하게 작성
  • SportEventRes -> SportEventResponseDTO : Controller 에서 Response 응답을 내려주는 DTO 임을 명시
  • FindUniversitiesResponseDTO : 복수의 University 엔티티를 담은 DTO 임을 명시
  • FindEmailRequestDTO & FindEmailResponseDTO : 서로 관련된 객체임을 명시
• model -> dto 으로 폴더명 변경
• DTO 는 엔티티를 담는 DTO 를 최우선으로 작성 -> 따라서 컨트롤러에서 사용하는 ResponseDTO 에서 필드를 새로 생성 또는 분리하는 것 보다 엔티티 DTO 를 그대로 사용하는 걸 지향 ( 쿼리 최적화는 추후 문제 )
• 엔티티를 생성 / 수정하는 ResponseDTO 에선 message 뿐 아니라 최신 리소스 DTO 를 전달 ( 불필요한 조회 네트워크 호출 방지 목적 )
  • 리소스를 전달하지 않아도 되는 API 의 경우 결과 메시지만 넣고 리소스 DTO 는 생략해도 무방 ( ex. 비밀번호 찾기 시 비밀번호 재설정 -> 유저 엔티티까지 모두 줄 필요 없음, 그 결과 유무만 알면 됨 )
• 복잡한 쿼리는 JPA 보다 QueryDSL 이용, 코드 재사용 가능하도록 BooleanExpression 을 활용하여 작성
• Controller 에선 Service 으로 UserId 와 RequestDTO 를 그대로 넘기고 ResponseDTO 를 받아 바로 반환해주는 로직으로 통일
  • 필드 검증은 Spring Bean Validation 어노테이션과 서비스 단에서 검증
• 공통 조회 로직 (findById 등) 은 UserUtils, CompetitionUtils 등으로 static method 로 분리 ( 불필요한 공통 orElseThrow 코드 반복 방지 )
• 페이지네이션 시 필드를 통일하기 위해 공통 페이지 BasePageable<xxxxxResponseDTO> 클래스 사용
• @Transactional 어노테이션은 클래스에 붙이는 것보다 메서드에 바로 붙임 (메서드 코드 조각만 보고도 바로 파악하기 위함)
  • 조회는 @Transaction(readOnly = true), 그 외 생성 / 변경은 @Transactional 으로 통일
  • 다른 스프링 트랜잭션 전략이 꼭 필요하면 작성 가능
• 코드가 여러 곳에서 재사용 된다면 분리
• Service 에서 검증하는 로직은 다른 메서드 validateXXX(XXX : 보통 Service 메서드명) 으로 분리
  • 해당 메서드 밑에 작성하여 한 눈에 검증 로직이 들어오도록 메서드 위치 조정
• 어노테이션은 클래스와 직접적이고 밀접한 어노테이션일 수록 클래스명과 가깝게 위치 ( 선택 )
  • @Entity 의 경우 핵심 어노테이션이므로 클래스명 바로 위에 작성
  • 우선순위를 매겨 클래스명과 먼 어노테이션은 보통 Lombok 의 어노테이션
• TODO 주석을 제외하고 개발 중에 일어난 모든 불필요한 주석은 최종 커밋에 반드시 삭제 ( 타인이 그 주석을 삭제하기가 판단 내리기 어려움 )
  • 필요한 주석은 충분한 부연 설명을 포함시키고 코드 가독성을 해치지 않는 선에서 작성
• 코드 개행은 가로가 너무 길거나, 세로로 읽기가 편할 때 작성
  • Builder 패턴의 경우 Competition.builder() 까지만 작성하고 모든 체이닝 메서드는 개행으로 구분
• 변수가 선언하는 위치와 사용하는 위치는 최대한 가깝게 위치