StackUp Core Server. Java 21 + Spring Boot 4.0 + JPA + QueryDSL + PostgreSQL. 시스템에서 PostgreSQL에 직접 접근하는 유일한 컴포넌트.
상위 컨텍스트: /CLAUDE.md · 횡단 관심사: /docs/
| 영역 | 기술 |
|---|---|
| Language | Java 21 (toolchain) |
| Framework | Spring Boot 4.0.4 |
| Web | Spring Web (REST) |
| ORM | Spring Data JPA + Hibernate |
| Query | QueryDSL 5.1 (jakarta classifier) |
| DB | PostgreSQL + pgvector |
| Build | Gradle (Groovy DSL) |
| Test | JUnit 5 + Spring Boot Test |
| 추가 예정 | Spring Security, RabbitMQ starter, Flyway, springdoc-openapi, ArchUnit (의존성 검증) |
신규 의존성 추가 시
/docs/coding-conventions.md §6절차 +build.gradle갱신.
com.stackup.stackup
├── StackupApplication.java
├── auth/ # 인증 (GitHub OAuth, JWT)
│ └── domain/
├── user/ # 사용자
│ └── domain/
│ └── consent/ # 개인정보처리동의
├── github/ # GitHub API 연동·레포 메타
│ └── domain/
├── resume/ # 이력서
│ └── domain/
├── document/ # 분석 문서 (analyzed_documents)
│ └── domain/
├── session/ # 면접 세션·메시지·피드백
│ └── domain/
├── log/ # 로깅 도메인
│ ├── activity/
│ │ └── domain/
│ └── ai/
│ └── domain/
└── common/ # 횡단 (Base entity, exceptions, util)
└── entity/
Spring Boot 표준 (
config/,controller/,service/,repository/,dto/)이 아니라 도메인 패키지 우선 구조. 각 도메인 내부에서 layered 분리한다 (§3).
com.stackup.stackup.{domain}/
├── domain/ # Entity, Enum, Value Object, Repository (interface)
│ ├── {Aggregate}.java
│ ├── {Aggregate}Repository.java
│ └── ...
├── application/ # Service, UseCase, DTO (도입 예정)
│ ├── {Aggregate}Service.java
│ └── dto/
├── presentation/ # Controller, Request/Response (도입 예정)
│ └── {Aggregate}Controller.java
└── infrastructure/ # 외부 연동 (GitHub API client, S3, RabbitMQ pub/sub)
└── ...
- 현재는
domain/하위 패키지만 존재. 기능 구현 시application/,presentation/,infrastructure/차례로 추가. - 패키지명을 entity 명사로 (소문자), 클래스는 PascalCase.
| 패키지 | 책임 | 관련 US |
|---|---|---|
auth |
GitHub OAuth flow, JWT 발급/갱신/검증, refresh token, JWT 필터 | US-01 |
user |
사용자 CRUD, 회원 탈퇴, 프로필 조회 | US-02, US-04 |
user.consent |
개인정보처리동의 기록·조회·철회 | US-03 |
github |
GitHub API 연동, 레포 목록/등록/메타 동기화 | US-07, US-08 |
resume |
이력서 업로드(S3)·메타 저장·목록·삭제 | US-05, US-06 |
document |
분석 문서(이력서/레포 공통) 메타 + S3 경로 | US-09~12 |
session |
면접 세션·메시지·피드백 (가장 큰 도메인) | US-13 |
log.activity |
사용자 행동 로그 | US-31 |
log.ai |
AI 요청/응답 로깅 | US-30 |
common |
BaseEntity, 글로벌 예외 핸들러, util | — |
각 도메인 패키지에 자체 CLAUDE.md를 두는 것을 권장 (현재 미생성, 도메인 코드 작성 시 함께 추가).
다른 서비스(AI/RealTime)는 PG 직접 접근 금지. 본 서버 API 또는 RabbitMQ 경유. 자세한 이유는 /docs/architecture.md §4.1.
횡단 기술(controller/service/repository) 분리 대신 도메인 단위 응집. 도메인 내부에서만 layered 분리.
LLM 직접 호출 X. 항상 RabbitMQ로 작업 발행 + 콜백 수신.
@Transactional은 service layer에서만 (controller/repository에서 사용 X)- 외부 API 호출은 트랜잭션 밖에서 (DB 락 길어짐 방지)
- 메시지 발행은 commit 이후 (transaction outbox 패턴 또는
TransactionalEventListener(AFTER_COMMIT))
- 단순 CRUD →
JpaRepository메서드 (findById,findByUserIdAndIsDeletedFalse) - 동적 조건/조인 → QueryDSL custom repository
- N+1 방지:
@EntityGraph또는 fetch join, 측정 후 적용 @OneToManycascade는 신중 (의도 없는 삭제 방지)- 비식별자 ENUM은
@Enumerated(EnumType.STRING)강제, ORDINAL 금지
QueryDSL Q-class 생성 위치: build/generated/sources/annotationProcessor/... (자동, 커밋 X).
- 입력:
XxxRequest(record 권장) - 출력:
XxxResponse(record 권장) - Entity는 controller까지 노출 X — service에서 DTO 변환
@Valid+@NotBlank등 validation은 Request DTO에
public record SessionCreateRequest(
String title,
@NotNull SessionMode mode,
@NotNull InterviewType interviewType,
@NotNull JobCategory jobCategory,
@Min(1) @Max(30) Integer maxQuestions,
@Min(5) @Max(180) Integer maxDurationMinutes,
List<Long> contextDocumentIds
) {}public class SessionNotInProgressException extends DomainException {
public SessionNotInProgressException(Long sessionId) {
super(ApiErrorCode.SESSION_INVALID_STATE,
"세션이 진행 중이 아닙니다. (id=%d)".formatted(sessionId));
}
}common/exception/GlobalExceptionHandler.java 에서 @RestControllerAdvice로:
DomainException→ 4xx + 표준 에러 응답 (/docs/api-conventions.md §4.2)MethodArgumentNotValidException→ 400 + details에 field 목록- 그 외
Exception→ 500 + traceId 노출 (사용자에게 메시지 노출은 generic하게)
- 발행자: 각 도메인의
infrastructure/(예:session/infrastructure/SessionEventPublisher.java) - 소비자:
*/infrastructure/{X}MessageHandler.java - 메시지 envelope·routing key·재시도 정책:
/docs/messaging.md
common/storage/ObjectStorageClient.java단일 추상화- AWS SDK v2 사용, endpoint를 환경변수로 분기 (local: MinIO, prod: AWS S3)
- 키 컨벤션:
/docs/storage.md §2 - bucket은 환경변수, key만 DB 저장
github/infrastructure/GithubApiClient.java- WebClient 기반,
Authorization: Bearer {github_access_token} - 토큰은
GithubTokenCipher로 복호화한 평문을 메모리에서만 사용 - rate-limit 응답(403 + remaining=0) 처리: 429로 변환 + retry-after 응답
src/main/resources/db/migration/V{n}__{snake_case}.sql- 적용 후 수정 절대 금지 (수정 시 새 V 추가)
- DDL과 DML 분리
- 상세:
/docs/database.md §8
application.properties + application-{profile}.properties + 환경변수.
spring.application.name=stackup
spring.datasource.url=jdbc:postgresql://${POSTGRES_HOST:localhost}:${POSTGRES_PORT:5432}/${POSTGRES_DB:stackup}
spring.datasource.username=${POSTGRES_USER:stackup}
spring.datasource.password=${POSTGRES_PASSWORD:stackup}
spring.jpa.hibernate.ddl-auto=validate # Flyway 사용 → validate전체 변수 목록: /docs/environment.md §3.
- Logback JSON 포맷 (운영) / human-readable (로컬)
- MDC에
traceId,userId - 민감정보 마스킹:
common/log/PiiMasker.java - 자세한 정책:
/docs/observability.md
- 단위:
*Test.java(Spring 컨텍스트 X, 빠름) - 통합:
*IT.java또는*IntegrationTest.java+ Testcontainers (PG/RabbitMQ) - 아키텍처:
*ArchTest.java(ArchUnit) — 의존성 방향·패키지 규칙 검증 (§16) - Builder 패턴으로 fixture (
UserBuilder.aUser()) - 자세한 전략:
/docs/testing-strategy.md
도메인 우선 패키지 구조 + 레이어 의존성 방향(§3)을 빌드 단계에서 강제한다. 사람의 리뷰가 놓치기 쉬운 위반을 컴파일/테스트로 차단.
testImplementation 'com.tngtech.archunit:archunit-junit5:1.3.0'@AnalyzeClasses(packages = "com.stackup.stackup",
importOptions = ImportOption.DoNotIncludeTests.class)
class ArchitectureTest {
// 1. 도메인 패키지 의존 방향 (presentation → application → domain)
@ArchTest
static final ArchRule domain_should_not_depend_on_application_or_presentation =
noClasses().that().resideInAPackage("..domain..")
.should().dependOnClassesThat().resideInAnyPackage(
"..application..", "..presentation..", "..infrastructure..");
@ArchTest
static final ArchRule application_should_not_depend_on_presentation =
noClasses().that().resideInAPackage("..application..")
.should().dependOnClassesThat().resideInAPackage("..presentation..");
// 2. 컨트롤러는 서비스만 의존 (Repository 직접 호출 금지)
@ArchTest
static final ArchRule controllers_should_not_use_repositories =
noClasses().that().resideInAPackage("..presentation..")
.should().dependOnClassesThat().areAssignableTo(JpaRepository.class);
// 3. Entity setter 노출 금지
@ArchTest
static final ArchRule entities_should_not_have_public_setters =
noMethods().that().areDeclaredInClassesThat()
.areAnnotatedWith(Entity.class)
.should().bePublic().andShould().haveNameStartingWith("set");
// 4. 도메인 간 순환 의존 금지
@ArchTest
static final ArchRule no_cyclic_dependencies_between_domains =
slices().matching("com.stackup.stackup.(*)..").should().beFreeOfCycles();
// 5. @Transactional은 application(service) 레이어에서만
@ArchTest
static final ArchRule transactional_only_in_application_layer =
classes().that().areAnnotatedWith(Transactional.class)
.should().resideInAPackage("..application..");
// 6. JPA 엔티티는 domain 패키지에만
@ArchTest
static final ArchRule entities_should_reside_in_domain_package =
classes().that().areAnnotatedWith(Entity.class)
.should().resideInAPackage("..domain..");
// 7. Native query 사용 금지 (필요시 specific 케이스만 화이트리스트)
@ArchTest
static final ArchRule no_native_query_outside_whitelist =
noClasses().that().resideOutsideOfPackages(
"..document.infrastructure..") // pgvector 검색은 예외
.should().dependOnClassesThat().haveNameMatching(".*NativeQuery.*");
}./gradlew test에 자동 포함됨 (별도 task 분리 불필요)- 위반 발견 시 빌드 실패 → PR 머지 차단
- 신규 룰 추가 시 기존 코드를
freeze(당장 위반은 허용, 신규는 차단)할 수도 있음 (FreezingArchRule)
- 합의된 규약만 코드화. 본 문서/도메인 패키지 가이드에 적힌 것만 ArchUnit에 옮긴다.
- 위반이 정당화될 때는 룰을 풀기보다 예외 패키지 명시 (위 §7 native query처럼)
- 룰 추가 PR은 본 문서·도메인 가이드 동시 갱신
./gradlew bootRun # 개발 실행
./gradlew test # 단위·통합 테스트
./gradlew build # JAR 생성
./gradlew dependencyCheckAnalyze # 취약점 스캔 (도입 후)
java -jar build/libs/stackup-0.0.1-SNAPSHOT.jar로컬 의존성(PG/RabbitMQ/MinIO):
docker compose up -d- Lombok 적극 사용 OK (
@Getter,@RequiredArgsConstructor,@Builder). 단 entity는@Setter금지. - record는 DTO/응답에 우선 사용
- final 필드 + 생성자 주입
- 상수는 도메인 클래스 내부
private static final - 자세한 공통 규약:
/docs/coding-conventions.md
- springdoc-openapi (도입 시):
/api/v3/api-docs— OpenAPI JSON/api/swagger-ui.html— UI
- 신규 endpoint는
@Operation,@ApiResponse작성 - API 규약:
/docs/api-conventions.md
- 도메인 패키지 골격만 존재, 실제 구현 거의 없음
- Spring Security 미도입 → US-01 작업 시 도입
- RabbitMQ starter 미도입 → US-09 작업 시 도입
- Flyway 미도입 → 첫 entity 작성 PR에서 도입
- Spring AI 미사용 — LLM·임베딩 호출은 모두 AI 서버 위임. Core는 RabbitMQ 발행만 담당.
- Redis 미사용 — 휘발성 데이터는 DB short-lived 레코드 또는 인메모리로.
각 도입 시 본 문서 §1, 관련 도메인 CLAUDE.md 갱신.