C4 Model là gì
Mô hình C4 để trực quan hóa kiến trúc phần mềm C4 = Context + Container + Component + Code. Website: https://c4model.comMô hình C4 là một phương pháp mô tả kiến trúc phần mềm một cách tinh gọn nhất. Nó bao gồm một tập hợp 4 sơ đồ mô tả cấu trúc tĩnh của một hệ thống phần mềm.
Nhìn chung, C4 cố gắng tạo ra sự rõ ràng để truyền đạt câu chuyện thiết kế đến người đọc, đồng thời làm theo câu “thần chú” của Shneiderman: “Tổng quan trước tiên, phóng to thu nhỏ và lược bớt, cuối cùng là sự chi tiết theo yêu cầu nếu cần“
Nhưng mà C4 là gì?
Chữ C được lấy từ 4 hình vẽ chính trong mô hình này đó là: Context, Container, Component, Code (hay còn được gọi là Class).
System Context: Sơ đồ này mô tả tổng quát về hệ thống theo hướng che đi thành phần bên trong mà chỉ làm nổi bật thành phần bên ngoài (blackbox); bao gồm các yếu tố phụ thuộc chính (dependencies) của hệ thống, các giao thức (interfaces) để giao tiếp giữa những hệ thống với nhau và con người (người dùng / theo vai trò / theo phòng ban / v.v). Biểu đồ ngữ cảnh này là tiêu chuẩn trong kỹ thuật phần mềm.
Container: Sơ đồ này mô tả về hệ thống theo hướng hiển thị thành phần bên ngoài cùng với việc phóng to những thành phần bên trong của hệ thống (whitebox); do đó hiển thị được các container (building block), mục đích và nhiệm vụ của từng container này, cùng với giao thức giao tiếp giữa những container đó. Sơ đồ này thường được gọi là sơ đồ khối cấp 1 (first level building block). Vậy container cụ thể là cài vẹo gì? Tuỳ theo phạm vi hệ thống các bạn đang làm (có thể là hệ thống, có thể là 1 component, cũng có thể là 1 hệ thống con), container có thể là cái máy tính, vi xử lý, cũng có thể là 1 dịch vụ (service) nào đó gởi email, lưu trữ, APIs…
Component: Sở đồ này phóng to container để mô tả về thành phần bên trong; do đó hiển thị được các components (building block), mục đích và nhiệm vụ, mối quan hệ của từng component cũng như là những giao thức kết nối. Sơ đồ này thường được gọi là sơ đồ khối cấp 2.
Code (hay class): Sơ đồ này mô tả bên trong một component; theo đó hiển thị được các phần hiện thực như là class, package… cùng với mối quan hệ giữa những thành phần này
Cài đặt
Để thiết lập C4 model plantUML trong visual studio code, bạn cần làm theo các bước sau:
- Cài đặt Java Runtime Environment (JRE) để chạy plantUML.
- Cài đặt Graphviz để tạo ra các biểu đồ từ mã nguồn plantUML. Bạn có thể tải xuống Graphviz từ https://graphviz.gitlab.io/download/ hoặc sử dụng chocolatey để cài đặt nó: choco install plantuml.
- Cài đặt PlantUML extension cho visual studio code
- Tải xuống thư viện C4 plantUML từ https://github.com/RicardoNiepel/C4-PlantUML và lưu nó vào thư mục của dự án của bạn.
- Tạo một tệp mới với phần mở rộng .puml và nhập thư viện C4 plantUML vào đầu tệp: !include <./.../C4.puml>.
- Viết mã nguồn plantUML để mô tả kiến trúc của bạn theo các khối xây dựng của C4 model: System Context, Container, Component và Code.
- Để xem trước biểu đồ, nhấn Alt + D (Windows) hoặc Option + D (Mac) trong khi con trỏ nằm giữa @startuml và @enduml.
!include ./C4-PlantUML/C4.puml
@startuml C4_Elements
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
Person(personAlias, "Label", "Optional Description")
Container(containerAlias, "Label", "Technology", "Optional Description")
System(systemAlias, "Label", "Optional Description")
Rel(personAlias, containerAlias, "Label", "Optional Technology")
@enduml
Nhận xét
Đăng nhận xét