Files
clean-architecture-backend-…/docs/manual/11-checklist.md
T
DongHyeonka 1444d1e0df
pr / gradle (pull_request) Failing after 7m18s
pr / vulnerabilities (pull_request) Successful in 1m1s
pr / done (pull_request) Canceled after 0s
docs(security): 요청률 제한은 기본 off·ingress 책임임을 명시한다
W4 red team BE-OBS-A 소유자 결정(2026-11-12): 요청 빈도 제한은 앱 기본 off로 두고
ingress/gateway 책임으로 명시한다. 앱은 크기/양 bound는 이미 강제하고, 빠진 축은
요청 빈도 하나이며 그것은 앞단이 서비스 전체 기준으로 보는 게 맞다.

docs/security/rate-limiting.md에 자세(기본 off·ingress 책임)와 앞단에서 안 거는
배포를 위한 앱 내 redis limiter 켜는 법(모듈·env·client-ip 주의)을 적는다. 운영
매뉴얼(docs/work/operate.md 파생 서비스 절)과 PR 체크리스트(docs/manual/
11-checklist.md inbound)에서 가리켜, 파생 서비스가 릴리스 전에 "요청률을 어디서
거는가"를 정하게 한다.

동작/코드 변경 없음(문서만).
2026-11-12 01:15:07 +09:00

3.5 KiB

11. 체크리스트 — PR 올리기 전

빠진 것이 있으면 해당 장으로 돌아간다. 검사 명령은 저장소 루트에서 실행한다.

배치·이름

  • 배치를 03장 기준표로 정했다(기본: 계층 leaf 안 <feature> 패키지).
  • 패키지 이름이 템플릿 패키지(src/application/core/README.md 「패키지 소유 (Package ownership)」)와 겹치지 않고, 업무 코드를 템플릿 패키지에 넣지 않았다.
  • 이름이 src/application/core/AGENTS.md 「Naming convention」을 따른다.

domain

  • 불변식은 aggregate 안에 있고, 위반은 XInvariantException(Reason)이다.
  • id 문법은 id 값 객체 생성자가 검사한다.
  • Spring·JPA·전송 타입을 import하지 않는다.

application

  • 모든 유스케이스에 @UseCaseCapability, 선언과 TransactionPort 호출이 맞다.
  • 쓰기 유스케이스: @RequiresPermission, non-final, bean으로 조립.
  • 외부 호출은 트랜잭션 밖이다.
  • 멱등성 선언을 05장 기준으로 골랐다(재전송될 쓰기는 KEYED).
  • 클라이언트 탓 실패는 carrier 예외 + 기능 코드, 서버 탓은 IllegalStateException.

persistence

  • 저장 adapter가 서비스 전용 persistence leaf에 있다(persistence-jpa 아님).
  • 연관관계는 한쪽만(mappedBy 없음).
  • 중복 규칙은 DB 유일성 제약이 막고, adapter가 그 제약 위반만 기능 예외로 바꾼다.
  • 여러 인스턴스가 집는 작업은 트랜잭션 안 claim + lease.
  • 마이그레이션은 자기 스트림(자기 history table)에 있고, 적용된 파일을 고치지 않았다.
  • adapter가 XRepositoryContract를 실 DB lane에서 상속한다.

inbound

  • 컨트롤러는 변환만 한다. repository·엔티티를 모른다.
  • 경로는 lowerCamel 복수형(AIP-122). 생성은 201 + Location.
  • 도메인 규칙을 DTO bean validation에 다시 쓰지 않았다.
  • 엔드포인트를 더했으면 요청률 제한을 어디서 거는지(ingress/app) 배포 설계에 있다. 앱 기본 off·켜는 법은 docs/security/rate-limiting.md.

조립·권한

  • XConfig가 @ConditionalOnBean(포트)이고 imports에 한 줄 있다. 포트가 다른 자동 설정에서 오면 afterName.
  • 역할 → 권한 매핑을 app.authz.role-permissions에 더했다.
  • 객체 단위 판정이 필요하면 유스케이스 안에서 하고, 남의 것은 404.

이벤트

  • 저장과 outbox append가 같은 tx.inWrite 안이다.
  • 계약 id·버전·schema·해시를 정했고 계약 bean을 등록했다.

테스트

  • 포트마다 fake 하나와 공유 계약이 포트 소유 leaf testFixtures에 있다.
  • 이름은 행동 문장, @DisplayName은 필요할 때만 한국어, GWT 주석, // when 하나.
  • Docker가 필요한 테스트는 strict lane이고 단계가 있다.

검사

./gradlew <owner-leaf>:check --console=plain        # 건드린 leaf마다
./gradlew architectureCheck --console=plain          # leaf 경계를 넘었으면
./gradlew verifyPublicPathSnapshot                   # 공개 경로가 바뀌었으면
./gradlew :app-bootstrap:verifyEnvKeys               # env 키가 바뀌었으면
./gradlew verifyDependencyLocks                      # 의존성이 바뀌었으면
  • 실행한 명령과 결과를 PR 본문 「검증」에 적었다. 못 돌린 것은 이유와 함께 적었다.