| name | java-code-style |
| description | Java / Spring Boot 프로젝트의 코드 작성 시 반드시 이 스킬을 사용하세요. Controller, Service, Repository, DTO, Entity, Mapper, Exception, Enums 등 모든 계층의 코드를 생성하거나 수정할 때, 네이밍 컨벤션, 주석 스타일, 에러 처리, 응답 포맷, 패키지 구조, 테스트 코드 작성 등 팀 컨벤션을 자동으로 적용합니다. "Controller 만들어줘", "Service 로직 짜줘", "DTO 생성해줘", "에러코드 추가해줘" 등 Spring Boot 관련 코드 작업이라면 무조건 이 스킬을 참조하세요.
|
Java / Spring Boot 코드 스타일 가이드
📁 전체 패키지 구조
com.example.project
├── domain
│ └── {도메인명}
│ ├── controller
│ │ ├── XXXControllerDocs.java
│ │ └── XXXController.java
│ ├── service
│ │ └── XXXService.java
│ ├── repository
│ │ ├── XXXRepository.java
│ │ ├── XXXRepositoryCustom.java # QueryDSL 사용 시
│ │ └── XXXRepositoryCustomImpl.java # QueryDSL 사용 시
│ ├── dto
│ │ ├── XXXReqDto.java
│ │ └── XXXResDto.java
│ ├── entity
│ │ └── XXX.java
│ ├── mapper
│ │ └── XXXMapper.java
│ ├── exception
│ │ └── XXXErrorCode.java
│ └── enums
│ └── XXXType.java
└── global
├── exception
│ ├── model
│ │ └── BaseErrorCode.java # 인터페이스 (변경 금지)
│ ├── CustomException.java # (변경 금지)
│ └── GlobalExceptionHandler.java # (변경 금지)
├── response
│ ├── GlobalResponse.java # 공통 API 응답 포맷 (변경 금지)
│ └── SliceResponse.java # 무한스크롤 응답 포맷 (변경 금지)
└── enums
└── GlobalResponseCode.java # SUCCESS / FAIL (변경 금지)
📖 작업 유형별 참조 파일
작업 요청이 들어오면 아래 표를 보고 해당하는 references/ 파일을 읽은 뒤 코드를 작성하세요.
| 작업 유형 | 읽어야 할 파일 |
|---|
Controller, ControllerDocs 생성 또는 수정 | references/controller.md |
Service 생성 또는 수정 | references/service.md |
Repository, QueryDSL 생성 또는 수정 | references/repository.md |
DTO, Entity, Mapper 생성 또는 수정 | references/dto-entity-mapper.md |
ErrorCode, 예외 처리, GlobalResponse, SliceResponse 관련 | references/exception-response.md |
| 테스트 코드 생성 또는 수정 | references/test.md |
| AI 주석 삽입 및 작업 완료 후 변경 요약 | references/ai-authorship-tracking.md |
여러 계층에 걸친 작업(예: "User CRUD 전체 만들어줘")은 해당하는 파일을 모두 읽고 작성하세요.
✅ 공통 체크리스트 (코드 생성 후 반드시 확인)
