Code Convention (SpringBoot) - Ureca-Middle-Project-Team4/4EVER0-BE GitHub Wiki

🧾 Code Convention (SpringBoot)

📁 프로젝트 구조

src/main/java/com/team4ever/backend/
├── BackendApplication.java
├── global/                 # 전역 설정 및 예외, 응답 등 공통 모듈
│   ├── config/             # Swagger 등 설정 클래스
│   ├── exception/          # 전역 예외 처리
│   └── response/           # 공통 응답 포맷
├── domain/                 # 도메인 별 폴더 분류
│   └── plan/               # 도메인 명
│       ├── controller/     # REST 컨트롤러
│       ├── service/        # 비즈니스 로직
│       ├── repository/     # JPA 리포지토리
│       └── entity/         # JPA 엔티티
└── common/                 # 공용 유틸, 상수 등

---

🛠 개발 규칙

✅ Java 버전 및 빌드

• Java 17
• Gradle 사용 (8.14 기준)
• Spring Boot 3.5.x
• JAR 빌드 시 버전 구분 없이 backend.jar로 고정

✅ 의존성 관리

• spring-boot-starter-web, data-jpa, data-redis, springdoc-openapi
• lombok, h2, mysql-connector-j
• .env 로컬 환경 관리 (dotenv-java 사용)

✅ 환경 분리

• application.yml 에서 ${ENV_VAR} 형태 사용
• .env + GitHub Actions Secrets 로 환경 변수 관리

📄 Swagger 설정

• 위치: global/config/SwaggerConfig.java
• springdoc-openapi-starter-webmvc-ui:2.2.5 사용
• Swagger UI 접속법: /swagger-ui.html

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI().info(new Info()
            .title("4EVER0 API")
            .description("4EVER0 Swagger 문서")
            .version("v1.0"));
    }

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
            .group("public-api")
            .pathsToMatch("/**")
            .build();
    }
}

🚨 예외 및 응답 처리

• 전역 예외 핸들러: global/exception/GlobalExceptionHandler
• 공통 응답 포맷: global/response/ApiResponse.java
• 실패 응답도 ApiResponse.fail(...) 형태 사용

🧪 테스트

• 기본 테스트 클래스: BackendApplicationTests
• 테스트용 DB: application-test.yml → H2 메모리 DB
• CI에서는 .env 또는 GitHub Secrets 기반으로 테스트
• 실패 시 :test 제외해도 무방 (./gradlew build -x test)

🧬 GitHub Actions (CI)

• 브랜치: main, dev push/pull 시 동작
• 테스트, 빌드, 캐시, 아티팩트 업로드 포함

📌 네이밍 규칙

• 클래스명: PascalCase
• 메서드/변수명: camelCase
• 엔티티: 단수형 (User, Plan)
• 리포지토리: PlanRepository
• 서비스: PlanService
• 컨트롤러: PlanController

🙅‍♀️ 금지 사항

• 하드코딩된 DB URL, 비밀번호 등
• 한 줄에 여러 책임을 지는 메서드
• 공통된 응답 포맷 없이 ResponseEntity 직접 반환

📚 참고

• Spring Boot 공식 문서
• GitHub Actions 공식 문서
• https://start.spring.io/