--- kind: REFERENCE slug: messaging-cloudevents-f05 title: 문서가 범위를 제한하면 그 제한을 누가 강제하는지 같이 적는다 topic: declaration-and-document-drift project: clean-architecture-backend-template status: 게시 전 sourceRevision: 21234e38cdb9a926cbc92bb97a2aee2e4a7d2916 rootTreeNode: reference:messaging-cloudevents-f05 verifiedOn: # 이 기록은 이번 회차에 실행 확인을 하지 않았다 source: - analysis/messaging/messaging-cloudevents.md#L556 --- # 문서가 범위를 제한하면 그 제한을 누가 강제하는지 같이 적는다 ## 관계 - **배포 아티팩트가 싣지만 아무도 부르지 않는다** 이 규칙의 근거는 같은 분석 리프의 판정이 소유한다. - **상호운용을 위한 매퍼가 명세 준수 이벤트를 분류되지 않은 예외로 거절한다** 이 규칙의 근거는 같은 분석 리프의 판정이 소유한다. ## 목적 javadoc 이 적용 범위를 좁혀 놓고 코드에 그 분기가 없으면, 제한은 읽는 사람의 기억에만 존재한다. 지금은 소비자가 0 이라 무해하고, 배선되는 순간 범위 밖 봉투가 그대로 통과한다. ## 규칙 1. 범위를 제한하는 문장을 찾으면 그 옆에 강제 주체를 적는다 CloudEventMapper 는 "Offered for domain and integration events only. Commands and work items are not forced through CloudEvents." 라고 적는다. 2. 코드에 그 분기가 있는지 확인한다 DefaultCloudEventMapper 전문에 DestinationKind 를 보는 분기가 없다. 3. 강제하지 않기로 했다면 호출자 책임임을 명시한다 강제할 것이면 toCloudEvent 가 DestinationKind 를 받아 검사한다. ## 적용 조건 javadoc·README·계약 문서가 적용 대상을 열거하는 모든 자리. ## 예외 호출 지점이 하나뿐이고 그 호출자가 범위를 이미 좁히는 경우는 예외다. 이 매퍼는 호출자가 0 이라 그 예외에 해당하지 않는다. ## 예시 CloudEventMapper.java:11-13 의 범위 진술과, git grep -n 'DestinationKind' -- 'src/messaging/messaging-cloudevents/**' 가 매치를 돌려주지 않는다는 것.