다양한 코딩 컨벤션을 제공하는 문서입니다.
본 프로젝트 또한 해당 컨벤션을 준수하며 개발되었습니다.
디렉토리 구조
프로젝트 디렉토리 구조에 관한 규칙
네이밍 컨벤션
파일, 디렉토리, 함수, 변수 등의 네이밍 규칙
API 페칭 아키텍처
API 페칭 아키텍처에 관한 규칙
성능 최적화
React와 TypeScript 애플리케이션의 성능 최적화를 위한 규칙
React와 TypeScript 일반 규칙
React와 TypeScript 프로젝트의 일반적인 모범 사례 및 규칙
TypeScript 활용
TypeScript 타입 시스템의 효과적인 활용을 위한 규칙
애플리케이션 로직 설계
마이크로서비스 컨텍스트에서의 애플리케이션 레이어 책임과 데이터 흐름
엔티티 클래스 표준
JPA 엔티티 설계 표준 (@Entity, @Data, ID 생성, 지연 로딩, 유효성 검사)
리포지토리 인터페이스 표준
Spring Data JPA 리포지토리 설계 표준 (JPQL, @EntityGraph, N+1 방지)
서비스 레이어 표준
서비스 레이어 구조, 생성자 주입, DTO 사용, @Transactional 관리
DTO 표준
데이터 전송 객체 표준 (Java Records, 유효성 검사)
REST 컨트롤러 표준
RestController 클래스 표준 (@RequestMapping, HTTP 메서드, 중앙화된 오류 처리)
API 응답 구조
컨트롤러에서 반환되는 ResponseEntity에 사용되는 ApiResponse 래퍼 클래스
전역 예외 처리기
중앙화된 오류 처리를 위한 @RestControllerAdvice 기반 예외 처리기
Java 및 Spring Boot 모범 사례
Java (JDK 21+), Spring Boot 3+, Gradle 표준 및 모범 사례