Files
clean-architecture-backend-…/docs/manual/09-outbox-events.md
T
DongHyeonka aef713b3c5 docs(manual): 본문의 이력 ID를 걷어내고 근거를 evidence로 옮긴다
docs/manual/ 본문 9줄에 리뷰 ID(RR-, RR3-, RR5-, RR6-), 설계 결정 번호(D4),
번호만 쓴 소유자 결정("소유자 결정 5")이 있었다. 지난 리뷰를 모르는
독자는 이 괄호를 따라갈 수 없고, docs-writing.md 4절 6단계가 금지한다.

괄호 안의 ID만 걷어내고 문장의 뜻은 바꾸지 않았다. 지난 일을 근거로 든
곳은 날짜와 내용으로 바꿨다(2026-11-05 확인 리뷰, 2026-09-25 소유자 결정).
D4는 규칙 이름 대신 "쓰기 유스케이스의 권한 선언 검사"로 풀었다. 걷어낸
ID와 원래 괄호, 원래 리뷰 문서는 docs/work/evidence.md 8절에 모았다.
리뷰 문서로 링크를 거는 안은 본문이 다시 이력을 가리키게 되어 버렸다.

검사 스크립트 패턴이 못 잡는 "리뷰 NN-NN", "1라운드 NN-NN" 꼴의 ID는
이 커밋 범위 밖이라 남겼다.

검증: python3 scripts/check-work-docs.py --history docs/manual
(lines with history IDs: 0, rc=0), check-work-docs.py 전체 rc=0,
--links docs 깨진 링크 0. document-contract lane은 desktop에서 돌린다.
2026-11-06 21:44:33 +09:00

198 lines
14 KiB
Markdown

# 09. outbox·이벤트
## 핵심
업무 저장과 이벤트 발행을 **같은 DB 트랜잭션**에 묶는다. 유스케이스는 broker에 직접 보내지 않고,
이벤트를 outbox 테이블에 업무 행과 함께 쓴다. 별도 relay가 커밋된 outbox 행을 broker로 옮긴다.
```text
use case ── tx.inWrite ─┬─▶ repository.save(aggregate) ┐ 한 커밋
└─▶ OutboxAppendPort.append(validated) ┘
▲
IntegrationEventDraft ──▶ IntegrationEventEncoderPort (계약으로 검증·인코딩)
(커밋 뒤, 따로) composition:outbox-relay ─▶ OutboxStorePort.claim(lease) ─▶ broker ─▶ 완료/재시도/DEAD
```
DB 저장과 broker 발행을 따로 하면(dual write) 둘 중 하나만 성공하는 순간이 생긴다. outbox는 그 순간을
없앤다. 대가는 **적어도 한 번** 전달이다 — 소비자는 event id로 중복을 걸러야 한다.
정본: `src/application-core/CLAUDE.md`(이벤트 타입 표), `docs/messaging/outbox-inbox.md`,
`docs/messaging/delivery-guarantees.md`.
## 순서
1. 계약을 정한다: 계약 id(`<service>.<aggregate>.<event>`), 버전, payload record, JSON schema 파일과 해시.
예: `src/sample-portfolio/src/main/java/dev/caskeleton/sample/portfolio/application/worklog/WorkLogReservedContractContribution.java`,
`src/sample-portfolio/src/main/resources/contracts/messaging/portfolio.worklog.reserved/v1.schema.json`(+ `.sha256`).
2. payload record(`IntegrationPayload`)를 만든다.
3. 유스케이스의 `tx.inWrite` 안에서 저장 뒤 draft → encode → append. 예:
`CreateWorkLogUseCase`(sample)와 그 헬퍼 `PortfolioEventOutbox`.
4. 계약 contribution을 조립에서 `@Bean`으로 등록한다. encoder는 컨텍스트의 계약 bean으로 만들어진다.
등록을 빠뜨리면 append 때 실패한다. 예: `DurableOperationAutoConfiguration.durableOperationSubmittedContract()`.
5. 테스트: 계약 contribution 테스트(해시 고정), 유스케이스가 append했는지(`InMemoryOutboxStore`),
소비자 중복 제거 계약(sample `WorkLogReservedConsumerDedupeContractTest`).
6. schema를 출시한다: `src/test/resources/contracts/released-payload-schemas.sha256`에 새 version 파일의
해시를 한 줄 더한다. 출시한 version 파일은 고치지 않는다 — 바뀌면 `ReleasedPayloadSchemaContract`
테스트가 실패한다. 필드를 바꾸는 변경은 새 version으로 낸다. 절차: `src/application-core/README.md`
"payload version 올리기"(리뷰 06-10).
## 판단 지점
### 도메인 이벤트가 필요한가, 통합 이벤트만인가
- **고르는 기준**: 같은 서비스 안에서 이 사실에 반응하는 코드가 있는가.
- **기본값**: 통합 이벤트만. 유스케이스가 저장 뒤 바로 payload를 만든다.
- **예외**: aggregate 안에서 일어난 사실을 여러 유스케이스가 같은 방식으로 내보내면 domain
`@DomainEvent` record를 두고 유스케이스가 그것을 payload로 옮긴다(sample `WorkLogReserved`).
### payload에 무엇을 넣나
- **기본값**: id만(+ 소비자가 라우팅에 필요한 최소 값). 상태 전체를 넣으면 계약이 aggregate 변경마다 깨진다.
- **예외**: 소비자가 원 서비스를 다시 조회할 수 없는 경우(외부 파트너)는 필요한 상태를 넣고 버전을 올린다.
### event id·correlation·순서
draft는 `IntegrationEventDrafts.draft(contract, eventId, aggregate, order, occurredAt, requestCorrelationId, payload)`로
만든다(`src/application-core/src/main/java/dev/caskeleton/application/messaging/event/IntegrationEventDrafts.java`).
계약 id·payload 버전·목적지는 계약에서 오고, 기능이 정하는 것은 aggregate·순서·payload뿐이다.
`new IntegrationEventDraft<>(…)`를 직접 쓰면 빌드가 막는다(`INTEGRATION_EVENT_DRAFTS_ARE_BUILT_BY_THE_SHARED_HELPER`).
예: sample `PortfolioEventOutbox`, `SubmitDurableOperationUseCase`.
- event id: 정규 소문자 UUIDv7, 소비자 중복 제거 키. draft(`IntegrationEventDraft`)가 다른 값(대문자,
v4, `event-1` 같은 문자열)을 거부하므로 업무 쓰기에서 바로 실패한다 — 커밋된 뒤 relay에서 DEAD가 되지
않는다(리뷰 06-06). 같은 작업의 재시도가 같은 event id를 내야 하면(durable operation) 작업 id를 쓰고,
작업 id가 UUIDv7이 아니면 작업 id와 접수 시각에서 UUIDv7을 파생한다.
- correlation: 헬퍼가 정한다. 요청의 correlation id가 `IntegrationIdentity` 문법·길이에 맞으면 그것,
아니면 event id. 문법 밖 헤더가 업무 쓰기를 실패시키지 않는다. 값을 미리 검사해야 하면 문법을 베끼지
말고 `IntegrationIdentity.isCanonical(value, IntegrationIdentity.CORRELATION_MAX_LENGTH)`를 부른다
(aggregate id는 `AGGREGATE_ID_MAX_LENGTH`).
- tenant 범위: tenant가 없는 기능은 `IntegrationEventDrafts.SINGLE_TENANT_SCOPE`(`global`).
- aggregate 순서: `OutboxAggregateSequencePort.nextSequence(aggregate)`로 같은 `tx.inWrite` 안에서
받는다(V21 카운터, 커밋 순서를 따른다). 이벤트가 하나뿐인 aggregate는 `AggregateOrder.first()`. 발생
시각(벽시계)은 쓰지 않는다 — 서버 시계가 어긋나면 순서가 뒤집힌다(리뷰 06-07). 벽시계 번호를 쓰던
서비스가 포트로 옮기면 V21 floor 덕분에 새 번호는 옛 번호 뒤에서 시작한다. 그래서 첫 번호가 1이
아니라 약 1.7×10¹⁵일 수 있다. 소비자는 번호를 "마지막으로 본 값보다 큰가"로만 비교하고 연속성을
가정하지 않는다. 비교는 aggregate identity(tenant scope 포함) 단위다. tenant scope를 바꾸는 배포는 옛
버전 인스턴스를 모두 멈춘 뒤 새 버전을 띄운다 — 섞여 돌면 새 scope의 번호가 옛 버전이 방금 쓴 번호보다
작을 수 있다(runbook `outbox-dead-letter.md` §8).
## relay와 실패
- relay는 `composition:outbox-relay`가 `new`로 조립해 스케줄러에만 준다. relay는 `@SystemInvoked`라 권한
선언이 없어서, bean이 되면 전송 계층이 **권한 검사 없이** 닿는다. 그래서 bean으로 등록하면
`PermissionEnforcementGuard`가 기동을 실패시킨다(07장 「시스템이 부르는 쓰기」).
- broker의 **재시도 가능한** 거부와 응답 없음은 DEAD가 아니라 backoff 재시도다. broker가 멈춰도 대량
DEAD가 되지 않는다(1라운드 06-01·06-03). 대신 끝이 없다: 진짜 인증 오류, Kafka adapter가 이름을 모르는
broker 거부도 영원히 재시도된다. 행의 `last_failure_code`와 로그의 `error.reason`이 원인 코드를 남기고,
`outbox.retry.long.size`가 오래 재시도 중인 행을 센다. 처분(보류·재개·skip)은 publish-failed runbook
§4.1이다.
- 발행 응답을 못 받으면 결과 불명(`OutboxPublishAmbiguousException`) — 05장 규칙과 같다.
- 운영: `docs/runbooks/outbox-dead-letter.md`, `docs/runbooks/outbox-publish-failed.md`.
## 소비 — 이벤트를 받는 쪽
같은 메시지는 두 번 이상 올 수 있다. 소비 쪽은 **inbox 예약과 업무 쓰기를 한 트랜잭션**에 묶어 효과를
한 번으로 만든다.
```text
Kafka ─▶ platform consumer ─▶ (INBOX_TRANSACTIONAL이면) InboxMessageHandler
└─ 한 트랜잭션: messaging_inbox 예약 + handler ─▶ use case 쓰기
성공 → 커밋 → offset 커밋
예외·Retry → 예약과 쓰기가 함께 롤백 → 같은 메시지 재전달 → 다시 처리
이미 예약된 메시지 → handler를 부르지 않고 성공으로 넘김
```
### 순서
1. 조립에 한 줄 추가: `runtimeOnly project(':adapter:inbound:messaging')`(app-bootstrap). Kafka
capability(`adapter:outbound:messaging-kafka`)와 persistence-jpa가 함께 있어야 한다. 이 leaf가 inbox
저장소와 트랜잭션 runner를 서비스의 DataSource·트랜잭션 위에 조립한다.
2. inbox 테이블은 따로 만들지 않는다: 1번 줄의 leaf가 기동 중에 platform의
`db/migration/messaging/V1101__messaging_inbox.sql`을 자기 history 표(`flyway_messaging_inbox_history`)로
적용한다. `app.runtime.migration-on-startup=false`로 마이그레이션을 밖에서 돌리는 배포만 이 파일을 직접
적용한다.
3. destination을 선언한다: `guarantees.external-side-effect: INBOX_TRANSACTIONAL`, `consumer.group`,
`retry.mode`·`retry.max-attempts`, `dlq.destination`. 예: `src/adapter/inbound/messaging/README.md`.
4. 쓰기 use case와 handler를 만든다. 소비 스레드에는 인증이 없어서 `@RequiresPermission` use case는
매번 거부된다. 그래서 handler가 부르는 쓰기 use case는 `@SystemInvoked`이고, handler는 그 use case를
**직접 `new`로 만들어 혼자 들고 있는** `@SystemCaller`다(07장 「시스템이 부르는 쓰기」). 이 방법 하나만
기동 가드와 빌드 규칙을 모두 통과한다.
- use case: `@SystemInvoked(reason = ...)` + `@UseCaseCapability(WRITE, …, WRITE_REPOSITORY)`. 평소처럼
`tx.inWrite`로 쓰고, 바깥 inbox 트랜잭션에 합류한다. 업무 규칙은 여기에 둔다.
- handler(`MessageHandler<T>`): `adapter:inbound:messaging`(또는 서비스의 `..adapter.inbound.messaging..`
패키지)에 두고 `@SystemCaller(reason = ...)`를 단다. 생성자가 port를 받아 use case를 만든다.
delivery 하나를 use case 호출 하나로 바꾼다.
- bean은 handler 하나다. use case를 bean으로 등록하면 `PermissionEnforcementGuard`가 기동을 막는다.
표시 없이 use case에 의존하면 `ONLY_SYSTEM_CALLERS_REACH_SYSTEM_INVOKED_USE_CASES`가 빌드를 막는다.
```java
@SystemCaller(reason = "order-events 소비자: platform consumer 스레드만 부른다")
public final class OrderCreatedHandler implements MessageHandler<OrderCreatedEnvelope> {
private final ProjectOrderUseCase useCase; // @SystemInvoked, bean 아님
public OrderCreatedHandler(TransactionPort tx, OrderProjectionPort projections) {
this.useCase = new ProjectOrderUseCase(tx, projections);
}
// destination(), handle(delivery) → useCase.project(...)
}
@Bean // 이 leaf의 설정 클래스
OrderCreatedHandler orderCreatedHandler(TransactionPort tx, OrderProjectionPort projections) {
return new OrderCreatedHandler(tx, projections);
}
```
같은 쓰기를 사용자 요청(HTTP 등)도 부르면 use case를 둘로 나눈다. 사용자용은 `@RequiresPermission`,
소비용은 `@SystemInvoked`이고 업무 규칙은 domain에 둔다. payload는 다른 서비스가 보낸 입력이므로 use
case가 검증한다 — 권한 검사가 없다는 것이지 검증이 없다는 것이 아니다.
5. payload 타입을 정한다. 템플릿 relay가 보낸 메시지의 payload는 canonical envelope JSON 전체다
(`eventId`, `payload` 등). handler의 record는 그 모양이다. 등록 코드는 쓰지 않는다: handler의
`destination()`(계약 id, record class)과 `schemaVersions()`(읽는 payloadVersion, 기본 v1)가 decode
목록이 된다. 발행 쪽이 v2를 보내기 시작하면 handler가 `schemaVersions()`에 v2를 더한다 — 선언하지 않은
버전은 `SCHEMA_VERSION_NOT_REGISTERED`로 DLQ에 간다.
6. 테스트 본보기: `SystemInvokedConsumePathTest`(단위, 4단계 모양이 권한 가드 아래에서 기동하고 delivery가
use case에 한 번 닿는지, use case를 bean으로 두면 기동이 막히는지)와 `InboxRedeliveryIntegrationTest`
(lane `messagingInboxRedeliveryIntegrationTest`, 실제 Kafka + PostgreSQL, 같은 handler 모양). offset을
되감아 다시 전달해도, 처리 중 예외 뒤 재전달돼도 효과와 inbox 행이 하나인지 본다.
### 판단 지점
#### 멱등 키
- **기본값**: inbox가 message id(발행 쪽 event id)와 `consumer.group`으로 거른다. handler가 따로 할
일은 없다.
- `consumer.group`은 바꾸지 않는다. 이름이 바뀌면 이미 처리한 메시지도 처음 보는 것으로 본다.
- **예외**: 발행 쪽이 재시도마다 다른 event id를 낸다면 inbox가 못 거른다. 그때는 use case가 업무
키(주문 id + 상태 등)로 멱등하게 쓴다.
- 쓰기는 handler를 부른 스레드에서 끝낸다. 다른 스레드로 넘긴 쓰기는 inbox 트랜잭션 밖이다.
- 메일·외부 API 같은 DB 밖 부작용은 롤백되지 않는다. handler 안에서는 DB 쓰기와 outbox append만 하고,
외부 호출은 그 이벤트를 받는 별도 소비자가 한다.
#### inbox 보존 기간
- inbox 행은 broker가 같은 메시지를 다시 줄 수 있는 기간보다 오래 남아야 한다. 먼저 지우면 늦게 온
재전달이 효과를 한 번 더 낸다.
- **기본값**: `InboxRetentionPolicy` — 보존 7일, 재전달 창 1일. topic 보존 기간이나 offset을 되감는 운영
범위가 1일보다 길면 이 bean을 덮어쓴다. 너무 짧은 조합은 기동 때 `INBOX_RETENTION_TOO_SHORT`로 거부된다.
- 정리 job(`InboxCleanupJob`)은 bean만 있다. 어느 replica에서 언제 돌릴지는 서비스가 스케줄한다.
#### 실패 시 재처리
- handler가 예외를 던지거나 `Retry`로 답하면 예약과 쓰기가 함께 롤백되고, platform이 같은 메시지를
다시 준다. 다시 처리될 때 효과는 한 번이다.
- **기본값**: destination retry는 `NONE`(시도 1회)이라 실패하면 바로 DLQ로 간다. 일시 장애가 있는
소비자는 `retry.mode: PAUSE_PARTITION`과 `max-attempts`를 정한다. partition 순서는 유지된다.
- 다시 해도 소용없는 입력(검증 실패)은 예외 대신 `Reject`·`DeadLetter`로 답한다. 예외는 시도를 다 쓴
뒤에야 DLQ로 간다.
- DLQ가 없는 destination은 실패한 메시지 뒤에서 partition이 멈춘다. 운영 소비자는 DLQ를 둔다.
- offset을 되감아 다시 읽혀도 보존 기간 안의 메시지는 inbox가 건너뛴다.
## 지금 이해하면 되는 것
- 저장과 append는 같은 `tx.inWrite` 안.
- 계약(id·버전·schema·해시)을 먼저 정하고 계약 bean을 등록한다.
- 전달은 적어도 한 번. 소비자는 inbox(`INBOX_TRANSACTIONAL`)로 예약과 업무 쓰기를 한 트랜잭션에 묶는다.
- 실패한 처리는 예약까지 롤백되어 재전달에서 다시 처리된다. inbox 보존 기간은 재전달 창보다 길게.
- 소비 handler = `@SystemCaller` + `@SystemInvoked` use case를 직접 `new`. use case는 bean이 아니다.