Files
clean-architecture-backend-…/docs/manual/04-persistence.md
T
DongHyeonka bbe944bd3c fix!: 재리뷰가 찾은 결함과 색인에서 빠졌던 발견 5건을 고친다
문제: 성숙도 리뷰 수정을 다시 읽은 재리뷰(Critical 0, 회귀 0)가
Important 27건·Minor 41건을 찾았다. 수정이 새로 만든 결함이 많았다.
@SystemInvoked가 권한 규칙의 탈출구가 됐고, 데모 계정 거부가 정확히
prod일 때만 걸렸고, outbox 순서 번호가 업그레이드 때 뒤로 갔고,
GraphQL union 아래 복잡도가 0이었고, 서블릿 오류 응답이 success:true로
나갔고, 호출자 deadline이 breaker를 열었다. 원래 리뷰 색인이 06 영역
발견 5건(06-10~14)을 빠뜨려 그동안 처리되지 않았다.

방법: 영역별 7묶음이 test-driven-development 절차로 실패 테스트를
먼저 쓰고 고쳤다. 결정은 재리뷰 README 4절에 적었다: 순서 번호는 V21이
기록한 전역 floor부터, 데모 계정은 local·test·demo 허용 목록,
@SystemInvoked bean은 기동 실패, complete 단계 실패는
IDEMPOTENCY_COMPLETION_UNKNOWN(결과 불명), 캐시 조건부 쓰기는 별도
SCRIPT lane, strict lane 정책은 build cache 입력, 끝나지 않는 재시도
행은 원인 코드·지표·PARKED 절차. 레지스트리가 선언만 하고 아무 코드도
내보내지 않던 redis.capability.* 지표 6개는 빼고 runbook을 실제
지표(redis.lane.*) 기준으로 고쳤다.

위험·한계: V21을 V22 없이 직접 고쳤다(어느 배포에도 아직 없음). 이
브랜치의 V21을 적용한 개발 DB는 다시 만들어야 한다. 서블릿 오류
디스패치를 보안 체인이 허용한다. 발행·저장소 포트 시그니처가 바뀌어
파생 서비스 코드가 깨진다. prod에서 fixture-로 시작하는 설정값은
기동을 막는다. httpclient failure-injection lane의 main 단계 중복
실행은 이전 결정대로 남겼다. 실제 CI runner 실행은 확인하지 못했다.

검증: ci, mainCheck, :integrationCheck, -p optional-platforms ci
integrationCheck performanceCheck, :performanceCheck, :releaseCheck
(-PgitRevision), verify-compose-profile-contracts(18 lane) 통과.
첫 실행의 실패 2건(FindSecBugs 1, sample 동시 생성 테스트의 v4 event
id)은 고친 뒤 ci·integrationCheck·mainCheck를 다시 돌려 통과했다.

Refs: docs/reviews/2026-11-03-rereview/README.md 3·4·6·7절
BREAKING CHANGE: outbox 발행 포트와 저장소 포트 시그니처, 순서 번호
첫 값(V21 floor 다음), 샘플 데모 계정 프로필 허용 목록, 새 오류 코드
IDEMPOTENCY_COMPLETION_UNKNOWN, prod의 fixture- 값 거부, 기동 rule은
static·의존 없음이어야 한다.
2026-11-03 23:29:35 +09:00

10 KiB

04. 영속성

핵심

저장 adapter는 생성 명령이 만들지 않는다. 이 장의 순서로 만든다. 세 가지를 지킨다.

  1. 엔티티 연관관계는 한쪽에서만 맵핑한다. 빌드가 막는다.
  2. 중복·경쟁은 코드 순서가 아니라 DB 제약이 막고, 위반은 기능의 오류로 바꾼다.
  3. 마이그레이션은 템플릿 운영 스트림과 번호가 겹치지 않는 자기 스트림에 둔다.
use case ── tx.inWrite ──▶ XRepository (domain 포트)
                               │
                               ▼
                         JpaXRepository (adapter)  ── CallerTransaction.require
                               │  엔티티 ↔ aggregate 변환(mapper)
                               ▼
                         Spring Data / EntityManager ──▶ PostgreSQL (제약·인덱스)
                               │
                  위반·장애 ──▶ PersistenceExceptionTranslator ──▶ OperationalError 또는 기능 예외

순서

  1. 계약 테스트부터: 생성된 XRepositoryContract(domain-core testFixtures)에 필요한 동작을 더한다. in-memory fake가 먼저 통과해야 한다.
  2. 마이그레이션을 쓴다(아래 번호 규칙).
  3. 엔티티·Spring Data repository·mapper·adapter를 쓴다. adapter는 aggregate만 주고받는다 (OUTBOUND_ADAPTER_METHOD_RETURNS_ONLY_DOMAIN_OR_PRIMITIVES).
  4. JpaXRepositoryContractTest extends XRepositoryContract를 실 PostgreSQL lane에 둔다(08장 lane). adapter는 호출자 트랜잭션 밖의 호출을 거부하므로(아래 「트랜잭션 안에서만 쓴다」), 계약의 inTransaction(Supplier)을 재정의해 거기서 트랜잭션을 열고 커밋한다. 계약은 모든 저장소 호출을 그 hook으로 부른다. fake는 기본값(그냥 실행)을 쓴다. 예: src/sample-portfolio/src/integrationTest/java/dev/caskeleton/sample/portfolio/adapter/outbound/persistence/repository/WorkLogRepositoryAdapterContractTest.java.
  5. adapter를 bean으로 등록하는 자동 설정을 쓰고, 기능의 XConfig에 afterName으로 그 순서를 적는다.

판단: 저장 adapter를 둘 leaf

  • 고르는 기준: upstream 템플릿 leaf에 서비스 코드가 섞이는가.
  • 기본값: 서비스 전용 persistence leaf 하나(adapter:outbound:persistence-<service>)를 registry에 등록하고 업무 기능의 adapter를 모두 거기 둔다. 모양은 src/adapter/outbound/persistence-notification (persistence-jpa에 의존, 자기 엔티티 scan·자기 Flyway 스트림·자기 자동 설정).
  • 예외: 하나도 없다고 보는 편이 낫다. persistence-jpa에 업무 패키지를 넣으면 ① capability 규칙 7 ("모듈을 아는 곳은 모듈 자신뿐")을 어기고, ② 그 leaf의 공개 API 기준선 (docs/architecture/jpa-api-surface.txt)과 엔티티 scan 목록(PersistenceJpaConfig, PersistenceEntityScanCoverageTest)을 고쳐야 하며, ③ upstream 병합 충돌 면이 넓어진다. sample은 자기 leaf 안에 adapter를 둔다(③ 수직 슬라이스라서).
  • 새 leaf는 modules.json 등록, lockfile 생성, app-bootstrap/build.gradle 한 줄이 필요하다(10장).

엔티티 매핑

정본: docs/jpa/entity-mapping-guide.md.

규칙 막는 곳
연관관계는 한쪽만. aggregate 사이는 id 참조, 같은 aggregate 안은 단방향 @ManyToOne(LAZY), 컬렉션은 쿼리 JpaArchitectureRules.associationsAreMappedFromOneSideOnly()(src/adapter/outbound/persistence-jpa/src/testFixtures/java/dev/caskeleton/adapter/outbound/persistence/testkit/arch/JpaArchitectureRules.java) — JpaProductionArchitectureTest가 운영 그래프 전체에 건다
엔티티는 adapter 밖으로 나가지 않는다 PERSISTENCE_ENTITIES_STAY_INSIDE_A_PERSISTENCE_ADAPTER, noEntityFromWeb
Long id 금지, id 컬럼 varchar(255) 금지 NO_LONG_ID_PK, NO_VARCHAR_255_FOR_ID_COLUMN
벤더 전용 columnDefinition 금지 PERSISTENCE_RDBMS_ENTITIES_DO_NOT_PIN_VENDOR_COLUMN_DEFINITIONS
감사 필드는 엔티티에만, 도메인에는 없다 DOMAIN_ENTITIES_DO_NOT_CARRY_AUDIT_FIELDS

판단: 단방향 @OneToMany(@JoinColumn)을 써도 되나

  • 기본값: 쓰지 않는다. 자식 목록은 repository 쿼리(findByParentId, 페이지는 SQL에서).
  • 예외: 루트만 바꾸는 자식(루트를 통해서만 생기고 지워짐). 규칙은 mappedBy만 막으므로 허용되지만 nullable join column이면 자식마다 UPDATE가 한 번 더 나간다(가이드 「Associations」).

트랜잭션 안에서만 쓴다

store는 자기 트랜잭션을 열지 않는다. 유스케이스가 연 트랜잭션에 합류해야 하는 쓰기는 시작 전에 CallerTransaction.require("<무엇>") (src/adapter/outbound/persistence-jpa/src/main/java/dev/caskeleton/adapter/outbound/persistence/transaction/CallerTransaction.java)를 부른다. 없으면 트랜잭션 밖 호출이 문장마다 따로 커밋되어, 같이 커밋돼야 할 행(업무 행 + outbox 행)이 갈라진다.

중복·경쟁은 DB가 막는다

  • 고르는 기준: "같은 X가 둘 있으면 안 된다", "한 작업을 두 인스턴스가 집으면 안 된다" 같은 규칙인가.
  • 기본값: DB 제약.
    • 중복 금지 → 유일성 제약/인덱스. 유스케이스의 사전 조회(existsBy…)는 빠른 거절일 뿐이다. READ COMMITTED에서 두 요청이 모두 "없음"을 보고 둘 다 insert한다.
    • adapter가 그 이름 붙은 제약의 위반만 잡아 기능 예외로 바꾼다. 다른 제약 위반은 그대로 둔다. 예: src/sample-portfolio/src/main/java/dev/caskeleton/sample/portfolio/adapter/outbound/persistence/repository/PosterRepositoryAdapter.java (DataIntegrityViolationException → 제약 이름 확인 → PosterTitleAlreadyExistsException 409), 제약은 src/sample-portfolio/src/main/resources/db/sample-migration/V8_1__poster_title_unique.sql.
    • 충돌을 바꾸는 곳은 하나다. 업무 규칙 충돌(같은 제목)은 포트 옆 domain 패키지의 예외 타입이고, 포트가 @throws로 선언하고 adapter가 던진다. 유스케이스의 사전 조회도 같은 타입을 던져 두 경로가 같은 409가 된다. application 예외를 domain 포트가 Javadoc으로만 가리키면 fake·mock은 그 약속을 지킬 수 없다. 기술 충돌(버전 불일치·교착)은 adapter가 프레임워크 예외 그대로 두고 아래 PersistenceExceptionTranslator가 DB_* 코드로 바꾼다(WorkLog의 ObjectOptimisticLockingFailureException → DB_OPTIMISTIC_CONFLICT).
    • 그 약속은 포트 소유자 testFixtures의 공유 계약 테스트로 고정한다. fake와 adapter가 같은 계약을 상속한다. 예: PosterRepositoryContract(InMemoryPosterRepository, PosterRepositoryAdapterContractTest).
    • 여러 인스턴스가 집는 작업 → FOR UPDATE SKIP LOCKED는 트랜잭션 안에서, 그리고 lease(만료 시각)와 fence 값을 함께 저장한다. 예: ReconciliationJobStorePort.claimDue(application-notification), gRPC operation ledger의 claim.
    • 수정 충돌 → 버전 열(낙관적 잠금). 예: UpdateWorkLogUseCase의 version 비교와 @Version.
  • 예외: DB가 볼 수 없는 규칙(외부 시스템 상태)은 분산 락(DistributedLockPort)이나 멱등성 키(05장).
  • 동시성 테스트는 실 DB lane에서 동시 요청 N개 → 행 1개를 단언한다(sample integrationTest 참고).

기술 실패는 공통 코드로 나간다

어떤 기능 예외로도 바꾸지 않은 DB 실패는 PersistenceExceptionTranslator (src/adapter/outbound/persistence-jpa/src/main/java/dev/caskeleton/adapter/outbound/persistence/failure/PersistenceExceptionTranslator.java)가 SQLState로 OperationalError를 고른다. DB_UNIQUE_VIOLATION 409, DB_SERIALIZATION_FAILURE·DB_DEADLOCK 409(retryable), 커밋 중 연결 끊김은 DB_COMPLETION_UNKNOWN 500(05장). 분류표는 이 한 곳이다. adapter가 SQLState 표를 복사하지 않는다.

마이그레이션 번호

템플릿 운영 스트림      classpath:db/migration/postgresql      V1 … V19 …  (upstream이 계속 늘린다)
capability 스트림        db/migration/jpa/<capability>          각자 history table
샘플 스트림              db/sample-migration                    flyway_sample_schema_history
서비스 스트림(권장)      db/migration/<service>                 flyway_<service>_schema_history
  • 고르는 기준: upstream 템플릿을 계속 받을 것인가.
  • 기본값: 서비스 마이그레이션은 자기 위치 + 자기 history table 스트림에 둔다. 모양은 SamplePostgreSqlPersistenceConfig.sampleMigrationStrategy (src/sample-portfolio/src/main/java/dev/caskeleton/sample/portfolio/bootstrap/persistence/SamplePostgreSqlPersistenceConfig.java)와 NotificationSchemaStream(persistence-notification). 그러면 번호가 템플릿 스트림과 독립이라 V1부터 쓴다.
  • 예외: 템플릿 운영 스트림(db/migration/postgresql)에 직접 넣으면 upstream이 다음에 쓸 번호와 겹친다. 어쩔 수 없으면 upstream이 쓰지 않을 큰 번호대를 정해 문서에 적는다.
  • 이미 적용된 파일은 고치지 않는다. 고치면 체크섬 불일치로 기동이 멈추고, repair는 쓰지 않는다 (docs/jpa/migration-guide.md).
  • 같은 스트림 안에서 기존 두 버전 사이에 끼워야 하면 소수 버전(V8_1)을 쓴다. 샘플 테스트 일부가 운영 스트림과 샘플 스트림을 한 목록으로 합치는데, 정수 V9 이상은 운영이 이미 쓰고 있어서 V8_1을 골랐다 (리뷰 README 13.2, 09-02).
  • 기존 데이터가 새 제약을 어기면 마이그레이션이 이유를 남기고 멈추게 쓴다(V8_1의 DO $$ 블록). 조용히 지우지 않는다.

지금 이해하면 되는 것

  • 저장 adapter는 서비스 전용 persistence leaf에. persistence-jpa에 업무 코드를 넣지 않는다.
  • 중복은 유일성 제약, 경쟁은 트랜잭션 안 claim + lease, 수정 충돌은 버전 열.
  • 마이그레이션은 자기 스트림(자기 history table). 적용된 파일은 고치지 않는다.