[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -4,112 +4,164 @@ title: C4 Modeling Framework
|
||||
category: 10_Wiki/Topics
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-REINFORCE-WIKI-ARCH-C4-MODEL, C4 Model, 계층적 아키텍처 모델링, 시스템 시각화]
|
||||
aliases: [C4 Model, C4 Diagrams, Simon Brown C4]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 1.0
|
||||
tags: [Architecture, Modeling, C4_Model, Visualization, Documentation]
|
||||
raw_sources: [Datacollector_Export_2026-05-02]
|
||||
last_reinforced: 2026-05-02
|
||||
confidence_score: 0.9
|
||||
verification_status: applied
|
||||
tags: [architecture, c4, diagram, structurizr, documentation]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: DSL
|
||||
framework: Structurizr
|
||||
---
|
||||
|
||||
# [[C4 모델 아키텍처 시각화 프레임워크]]
|
||||
# C4 Modeling Framework
|
||||
|
||||
## 1. 개요
|
||||
C4 모델은 소프트웨어 아키텍처를 **컨텍스트(Context), 컨테이너(Container), 컴포넌트(Component), 코드(Code)**의 4가지 추상화 수준으로 계층화하여 표현하는 접근법이다. 지도를 확대(Zoom-in)하듯 상위 수준의 시스템 개요부터 세부 구현까지 점진적으로 시각화하여 다양한 이해관계자와 일관된 어휘로 소통할 수 있게 돕는다.
|
||||
## 매 한 줄
|
||||
> **"매 software architecture = 4 zoom levels (Context → Container → Component → Code)."**. 매 Simon Brown 이 2006년경 제안한 lightweight visualization framework. 매 2026 현재 Structurizr DSL + Mermaid C4 plugin 으로 diagram-as-code 가 standard, 매 audience-specific abstraction level 이 핵심 가치.
|
||||
|
||||
## 2. 4단계 계층 (Four Levels)
|
||||
1. **L1: 시스템 컨텍스트 (Context)**: 시스템을 블랙박스로 취급하며, 사용자 및 외부 시스템과의 상호작용 경계를 정의. (경영진/비기술자 대상)
|
||||
2. **L2: 컨테이너 (Container)**: 시스템 내부의 실행/배포 가능한 단위(웹 앱, DB, 모바일 앱 등)와 기술 스택, 통신 채널 명시. (개발자/운영자 대상)
|
||||
3. **L3: 컴포넌트 (Component)**: 컨테이너 내부의 주요 구조적 구성 요소와 그들 간의 책임 및 의존성 기술. (개발자 대상)
|
||||
4. **L4: 코드 (Code)**: 클래스 다이어그램 등 가장 낮은 수준의 뷰. 코드가 실제로 어떻게 구성되어 있는지 상세 표현. (선택적 사용)
|
||||
## 매 핵심
|
||||
|
||||
## 3. 핵심 이점
|
||||
- **인지적 부하 감소**: 필요한 만큼의 정보만 단계적으로 제공하여 복잡한 코드베이스 탐색을 용이하게 함.
|
||||
- **의사소통 효율화**: 청중의 지식 수준에 맞춰 다이어그램의 깊이를 조절 가능.
|
||||
- **지속 가능성**: Structurizr와 같은 도구를 통해 '코드로서의 다이어그램(Diagrams as Code)'으로 관리하여 문서 최신화 보장.
|
||||
### 매 4 levels
|
||||
- **L1 — System Context**: 매 system + users + external systems. 매 non-technical stakeholder 용.
|
||||
- **L2 — Container**: 매 deployable unit (web app, API, DB, queue). 매 technical lead 용.
|
||||
- **L3 — Component**: 매 container 내부 logical grouping (controller, service, repo). 매 dev team 용.
|
||||
- **L4 — Code**: 매 class diagram (UML). 매 거의 안 그림 — IDE 가 대신.
|
||||
|
||||
## 4. 트레이드오프 및 주의사항
|
||||
- **장점**: 명확한 추상화 수준 분리, 이해관계자 간 정렬 용이.
|
||||
- **단점**: 고도로 정밀한 시맨틱 명세(UML 대비)나 물리적 클라우드 인프라(VPC, 서브넷 등) 표현에는 한계가 있음.
|
||||
### 매 supplementary diagrams
|
||||
- **Deployment diagram**: 매 container → infrastructure node mapping.
|
||||
- **Dynamic diagram**: 매 runtime sequence/collaboration.
|
||||
- **System landscape**: 매 enterprise-wide multi-system view.
|
||||
|
||||
## 5. 지식 연결 (Related)
|
||||
- [[UML_Unified_Modeling_Language]]: C4의 L4(Code) 레벨에서 주로 사용되는 상세 모델링 언어.
|
||||
- [[Architecture_Diagramming_Standards]]: 시스템을 시각화하는 일반적인 원칙과 기법.
|
||||
- [[Hexagonal_Architecture]]: C4 모델을 통해 시각화하기 좋은 대표적인 내부 아키텍처 패턴.
|
||||
### 매 응용
|
||||
1. **Onboarding doc**: 매 새 dev 의 codebase orientation.
|
||||
2. **ADR illustration**: 매 architecture decision record 의 visual aid.
|
||||
3. **Stakeholder communication**: 매 PM/exec 에게 system scope 설명.
|
||||
4. **Compliance audit**: 매 data flow / boundary 시각화.
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
- **정보 상태**: 검증 완료 (Verified)
|
||||
- **출처 신뢰도**: A
|
||||
- **검토 이유**: 시스템 구조의 명확한 전달과 문서화를 위한 현대적 시각화 표준 정립.
|
||||
## 💻 패턴
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
### Structurizr DSL (canonical)
|
||||
```dsl
|
||||
workspace "Banking System" {
|
||||
model {
|
||||
customer = person "Customer"
|
||||
bankSystem = softwareSystem "Internet Banking" {
|
||||
webApp = container "Web Application" "Spring Boot" "Java"
|
||||
mobileApp = container "Mobile App" "React Native" "TypeScript"
|
||||
api = container "API" "Spring Boot" "Java"
|
||||
db = container "Database" "PostgreSQL" "RDBMS"
|
||||
|
||||
> *(TODO: 한 문장으로 핵심 통찰을 작성. "X는 Y 조건에서 Z 효과를 낸다" 구조 권장.)*
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
|
||||
**추출된 패턴:**
|
||||
> *(TODO)*
|
||||
|
||||
**세부 내용:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
|
||||
- **과거 데이터와의 충돌:** 없음
|
||||
- **정책 변화:** 없음
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
|
||||
- **Parent:** [[10_Wiki/Topics]]
|
||||
- **Related:** *(TODO: 최소 2개)*
|
||||
- **Opposite / Trade-off:** *(TODO)*
|
||||
- **Raw Source:** 직접 입력
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
webApp -> api "uses" "JSON/HTTPS"
|
||||
mobileApp -> api "uses" "JSON/HTTPS"
|
||||
api -> db "reads/writes" "JDBC"
|
||||
}
|
||||
mainframe = softwareSystem "Mainframe" "External"
|
||||
customer -> bankSystem "uses"
|
||||
bankSystem -> mainframe "fetches account data" "MQ"
|
||||
}
|
||||
views {
|
||||
systemContext bankSystem { include * autolayout }
|
||||
container bankSystem { include * autolayout }
|
||||
theme default
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Mermaid C4 (in-repo markdown)
|
||||
```mermaid
|
||||
C4Context
|
||||
title System Context — Banking
|
||||
Person(customer, "Customer")
|
||||
System(bank, "Internet Banking", "Allows customers to view accounts")
|
||||
System_Ext(mainframe, "Mainframe", "Legacy core banking")
|
||||
Rel(customer, bank, "Uses")
|
||||
Rel(bank, mainframe, "Fetches data", "MQ")
|
||||
```
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Component-level decomposition
|
||||
```dsl
|
||||
api = container "API" {
|
||||
signInController = component "SignIn Controller" "Spring MVC"
|
||||
accountsController = component "Accounts Controller" "Spring MVC"
|
||||
authService = component "Auth Service" "Spring Bean"
|
||||
accountsRepo = component "Accounts Repository" "Spring Data JPA"
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
signInController -> authService "uses"
|
||||
accountsController -> accountsRepo "reads"
|
||||
authService -> db "verifies credentials"
|
||||
}
|
||||
```
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
### Deployment view
|
||||
```dsl
|
||||
deploymentEnvironment "Production" {
|
||||
deploymentNode "AWS us-east-1" {
|
||||
deploymentNode "EKS Cluster" {
|
||||
containerInstance webApp
|
||||
containerInstance api
|
||||
}
|
||||
deploymentNode "RDS" {
|
||||
containerInstance db
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### Generated docs pipeline
|
||||
```bash
|
||||
# CI step — render diagrams from DSL
|
||||
docker run --rm -v $PWD:/usr/local/structurizr structurizr/cli \
|
||||
export -workspace workspace.dsl -format plantuml/c4plantuml
|
||||
plantuml -tsvg *.puml
|
||||
mv *.svg docs/architecture/
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### ADR + C4 link
|
||||
```markdown
|
||||
# ADR-007: Move auth to dedicated service
|
||||
**Status**: Accepted
|
||||
**Context**: See [Container diagram](../diagrams/banking-containers.svg)
|
||||
**Decision**: Extract `authService` component into its own container.
|
||||
**Consequences**: New diagram in `diagrams/v2-containers.svg`.
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Diagram level |
|
||||
|---|---|
|
||||
| Pitch to exec / new joiner intro | L1 Context |
|
||||
| Tech selection / deployment plan | L2 Container |
|
||||
| Code review / refactor discussion | L3 Component |
|
||||
| Inheritance question | IDE (skip L4) |
|
||||
| Multi-system enterprise view | System Landscape |
|
||||
|
||||
**기본값**: L1 + L2 (둘만 있어도 90% communication 충족).
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Software_Architecture]] · [[Architecture_Documentation]]
|
||||
- 변형: [[arc42]] · [[4+1_View_Model]] · [[UML]]
|
||||
- 응용: [[ADR]] · [[Diagram_as_Code]] · [[Structurizr]]
|
||||
- Adjacent: [[Mermaid]] · [[PlantUML]] · [[DDD]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: greenfield architecture 문서화, legacy reverse-engineering, ADR illustration.
|
||||
**언제 X**: real-time runtime monitoring (observability tool 영역).
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **All 4 levels for every system**: 매 L4 거의 무의미 — IDE 대체.
|
||||
- **Mixing levels in one diagram**: 매 abstraction 깨짐 → audience 혼란.
|
||||
- **No legend / inconsistent shapes**: 매 reader 가 element type 못 구분.
|
||||
- **Diagram drift**: 매 DSL 없이 manual draw → 6개월 후 stale.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (c4model.com — Simon Brown, Structurizr DSL spec 2024).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — C4 levels, Structurizr DSL, Mermaid C4 examples |
|
||||
|
||||
Reference in New Issue
Block a user