문제: 모듈 README·AGENTS·매뉴얼·Javadoc이 옮기거나 이름을 바꾼 타입,
지운 샘플, 다른 repo로 옮긴 플랫폼을 그대로 가리켰다.
- 옮기거나 바꾼 타입: OutboxConfig(지금 :composition:outbox-relay의
OutboxRelayAutoConfiguration), IdempotencyProviderSelectionConfig(지금
:composition:idempotency의 IdempotencyAutoConfiguration),
TracingProperties·GraphQlPlatformProperties(지금 *Settings), SecretSource
(지금 application-core SecretSourcePort), JsonNullableModule(지금
JsonNullableJackson3Module), PeriodTest·OutboxEventIdFactory(샘플과 함께
지움).
- 지운 샘플: SampleDemoProfilesStartupSystemTest, 「sample 테스트」,
IdempotencyAutoConfiguration·ManagementSecurityConfig Javadoc의 샘플.
- 옮긴 플랫폼: graphql AGENTS·README가 messaging 플랫폼과 「두 패턴 공존」을
적었지만 그 플랫폼은 2026-11-08 messaging-library로 옮겼다. gRPC 문서는
grpc-library로 옮긴 플랫폼을 「vendored」·「벤더 starter」로 불렀다.
- leaf CLAUDE.md를 가리키던 곳(지금 AGENTS.md), 복사한 숫자(httpclient
java 파일 수, graphql systemTest 수), manual 06의 registry 머리말 옛 영어 인용.
고른 방법: 문장이 가리키는 대상만 지금 이름으로 바꾼다. 동작 설명은 그대로
둔다. 숫자는 지운다(레지스트리·빌드가 정한다).
검증:
- 노트북: check-docs.py rc=0. check-work-docs.py는 main의 operate.md 151줄
때문에만 rc=1.
- desktop(--no-build-cache, 트리 310eb524): 이 문서들을 읽는 시험
(:app-bootstrap:documentContractTest, repositoryContractTest —
DeveloperExperienceContractTest 포함, MongoNamespaceContractTest,
AwsQualificationClaimHonestyTest)과 Javadoc을 고친 두 leaf의
compileJava·spotlessCheck. 134건 실패 0, skip 1.
67 lines
4.3 KiB
Markdown
67 lines
4.3 KiB
Markdown
# 06. 오류 모델
|
|
|
|
## 핵심
|
|
|
|
실패마다 먼저 **클라이언트 탓인가 서버 탓인가**를 정한다. 클라이언트 탓이면 안정된 오류 코드를 가진
|
|
예외를 던지고, 서버 탓이면 코드 없이 던진다. 어느 쪽이든 기능 코드는 던지기만 하고, 전송별 핸들러
|
|
하나가 wire 모양으로 바꾼다.
|
|
|
|
```text
|
|
domain XInvariantException(Reason) ← 코드 없음. domain-core는 shared-contract를 못 본다
|
|
│ 유스케이스가 잡아서 감싼다
|
|
application XRejectedException implements ApiErrorCarrier → XErrorCode.X_INVALID (VALIDATION, 400)
|
|
XNotFoundException implements ApiErrorCarrier → XErrorCode.X_NOT_FOUND (NOT_FOUND, 404)
|
|
│ 던진다
|
|
web GlobalExceptionHandler: ApiErrorCarrier → errorCode() → status + Envelope{error{code, category, retryable}}
|
|
gRPC/GraphQL/WebSocket: 같은 ApiErrorCarrier를 자기 status 모양으로
|
|
```
|
|
|
|
정본: `src/shared-contract/src/main/java/dev/caskeleton/shared/error/ApiErrorCarrier.java`,
|
|
`ApiErrorCode.java`, `OperationalError.java`, `docs/registries/error-codes.yaml`, wire 모양은
|
|
`docs/web/http-contract.md` 1절(null 필드는 내보내지 않는다).
|
|
|
|
## 판단: 오류 코드를 어디에 두나
|
|
|
|
- **고르는 기준**: 같은 유스케이스를 여는 전송이 둘 이상이 될 수 있는가.
|
|
- **기본값**: application 기능 패키지의 `XErrorCode implements ApiErrorCode` enum + 예외가
|
|
`ApiErrorCarrier` 구현. 전송마다 핸들러를 만들 필요가 없다. 생성 명령 출력이 이 모양이다
|
|
(`<F>ErrorCode`, `<F>NotFoundException`, `<F>RejectedException`).
|
|
- **예외**: 한 전송에서만 의미가 있는 실패(HTTP 헤더 형식 등)는 그 전송 adapter에 둔다.
|
|
|
|
## 판단: 어떤 예외 타입으로 던지나
|
|
|
|
| 상황 | 던질 것 | 결과 |
|
|
| --- | --- | --- |
|
|
| 도메인 불변식 위반 | domain `XInvariantException(Reason)` → 유스케이스가 `XRejectedException`으로 감쌈 | 400 기능 코드 |
|
|
| 찾는 것이 없음 / 남의 것 | `XNotFoundException`(carrier) | 404. 남의 것도 404로 존재를 숨긴다(07장) |
|
|
| 상태 충돌(이미 있음, 버전 불일치) | 기능 carrier(Category.CONFLICT, 409) | 409 |
|
|
| 요청 파라미터 형식 오류(경로 id 문법 등) | `IllegalArgumentException` | 400 `BAD_PARAMETER` |
|
|
| 서버 조립·설정 오류, 있을 수 없는 상태 | `IllegalStateException` | 500, 로그 남음 |
|
|
| DB·외부 의존 실패 | adapter가 shared-contract carrier(`PersistenceFailureException`, `DependencyFailureException`)로 | 분류표대로(04·05장) |
|
|
|
|
- `IllegalArgumentException`을 "서버 조립이 틀렸다"에 쓰지 않는다. web은 그것을 400으로 바꾸고 WARN
|
|
한 줄만 남긴다(`GlobalExceptionHandler`). 서버 결함이 클라이언트 오류 통계에 섞여 경보가 울리지 않는다.
|
|
서버 쪽 잘못은 `IllegalStateException`(500, 로그)이다.
|
|
- 메시지는 로그용이다. 클라이언트에는 코드와 category별 고정 문구(`ClientErrorMessages`)만 간다.
|
|
메시지에 SQLState·내부 경로·토큰을 넣어도 클라이언트에 새지 않지만, 로그 정책은 지킨다.
|
|
|
|
## 판단: `retryable`을 무엇으로
|
|
|
|
- **기본값**: `false`. 기능 오류 대부분은 같은 요청을 다시 보내도 결과가 같다.
|
|
- **예외**: 시간이 지나면 성공할 수 있고 **다시 보내도 안전한** 경우만 `true`(일시적 의존 실패,
|
|
`IDEMPOTENT_IN_FLIGHT`). `true`인 코드는 runbook 링크가 필요하다(registry 규칙).
|
|
|
|
## 코드 등록
|
|
|
|
- 템플릿 운영 코드: `OperationalError` + `docs/registries/error-codes.yaml`을 같은 변경에서 고친다.
|
|
`ErrorCodeRegistryMappingTest`(app-bootstrap)가 status 일치를 검사한다.
|
|
- 서비스 기능 코드: 그 registry에 넣지 않는다(registry 머리말 「제품·fork의 ApiErrorCode enum은 자기 레지스트리·계약을
|
|
가진다」). 서비스 자기 registry를 만들고 같은 모양의 대조 테스트를 둔다. 모양은 위
|
|
`ErrorCodeRegistryMappingTest`(`src/bootstrap/app/src/test/java/dev/caskeleton/bootstrap/contract/ErrorCodeRegistryMappingTest.java`)다.
|
|
|
|
## 지금 이해하면 되는 것
|
|
|
|
- 클라이언트 탓 = carrier 예외 + 기능 코드. 서버 탓 = `IllegalStateException`.
|
|
- 기능 코드는 application에 두고, 전송 핸들러는 기능을 모른다.
|
|
- `retryable=true`는 다시 보내도 안전할 때만.
|