Giới thiệu

Biểu đồ lớp PlantUML mô tả cấu trúc tĩnh của một hệ thống: các lớp, thuộc tính, phương thức và mối quan hệ của chúng. Bạn viết một bản mô tả bằng văn bản và chuyển đổi nó thành biểu đồ, giúp mã nguồn dễ dàng chỉnh sửa và quản lý dưới hệ thống kiểm soát phiên bản.
1. Một biểu đồ tối thiểu
Một biểu đồ lớp bắt đầu bằng @startuml và kết thúc bằng @enduml:

@startuml
class User
class Order
User --> Order : places
@enduml
PlantUML có thể suy luận các lớp từ các khai báo mối quan hệ, nhưng việc khai báo chúng một cách tường minh sẽ giúp các biểu đồ lớn hơn dễ dàng quét và bảo trì hơn.
2. Các lớp, thuộc tính và phương thức
Đặt các thuộc tính và phương thức trong dấu ngoặc nhọn. Dấu hai chấm phân tách tên thành viên với kiểu của nó; dấu ngoặc đơn đánh dấu một phương thức.

@startuml
class User {
-id: int
-email: String
+login(password: String): boolean
+logout(): void
}
@enduml
Các dấu hiệu hiển thị là:
-
+public -
-private -
#protected -
~package-private
Bạn cũng có thể viết kiểu trước tên thành viên—ví dụ, +String email hoặc +void logout(). PlantUML hỗ trợ cả ký hiệu thành viên giống mã quen thuộc và các dấu hiệu hiển thị này.
Thành viên tĩnh và trừu tượng
Sử dụng {static} hoặc {classifier} cho thành viên tĩnh và {abstract} cho thành viên trừu tượng:

@startuml
abstract class PaymentMethod {
{abstract} +authorize(amount: Decimal): boolean
{static} +supportedCurrencies: String[]
}
class CardPayment {
+authorize(amount: Decimal): boolean
}
PaymentMethod <|-- CardPayment
@enduml
Một lớp trừu tượng cũng có thể được khai báo bằng lớp trừu tượng.
3. Mối quan hệ
Hình mũi tên biểu thị loại mối quan hệ. Hướng của đường được chọn dựa trên thứ tự của các tên; hãy sử dụng nhãn để làm rõ ý nghĩa của nó.
| Mối quan hệ | Ký hiệu PlantUML | Ý nghĩa điển hình |
|---|---|---|
| Kế thừa / tổng quát hóa | `Parent < | — Child` |
| Hiện thực hóa giao diện | `Interface < | .. Class` |
| Tổng hợp | Toàn bộ *-- Bộ phận |
Vòng đời của bộ phận được sở hữu bởi toàn bộ |
| Tụ hợp | Toàn bộ o-- Bộ phận |
Toàn bộ nhóm hoặc tham chiếu đến các bộ phận có thể tồn tại độc lập |
| Liên kết có hướng | A --> B |
A có mối quan hệ có thể điều hướng đến B |
| Phụ thuộc | A ..> B |
A sử dụng hoặc phụ thuộc vào B |
Đây là các ký hiệu mối quan hệ tiêu chuẩn của PlantUML.

@startuml
interface Repository
class SqlRepository
class OrderService
class Order
class OrderLine
Repository <|.. SqlRepository
OrderService ..> Repository : uses
Order *-- "1..*" OrderLine : contains
@enduml
Hãy chọn cẩn thận:Thành phần và tập hợp biểu thị các ngữ nghĩa vòng đời khác nhau. Chỉ sử dụng thành phần khi phần đó được toàn bộ sở hữu một cách có ý nghĩa; hãy sử dụng một liên kết đơn giản khi không có cách giải thích nào về sở hữu phù hợp.
4. Số lượng, tên vai trò và nhãn
Số lượng xác định có bao nhiêu đối tượng có thể tham gia ở mỗi đầu của một liên kết. Các dạng phổ biến bao gồm "1", "0..1", "*", và "1..*".

@startuml
class Customer
class Order
Customer "1" --> "0..*" Order : places
@enduml
Ở đây, mỗi Đơn hàng được liên kết với một Khách hàng, trong khi một Khách hàng có thể đặt không hoặc nhiều đơn hàng. Đọc các số lượng từ đầu đối diện: số gần “Đơn hàng mô tả số lượng đơn hàng có thể được liên kết với một khách hàng.
Để tăng độ chính xác, hãy thêm tên vai trò hoặc ràng buộc:

@startuml
class Team
class Player
Team "1" o-- "0..*" Player : thành viên
ghi chú trên liên kết
Một cầu thủ có thể chuyển giữa các đội.
end note
@enduml
5. Giao diện, liệt kê, biệt danh và gói
PlantUML hỗ trợ các khai báo như giao diện, liệt kê, lớp trừu tượng, và biệt danh được viết giữa << và >>.

@startuml
package "Đặt hàng" {
interface Cổng thanh toán {
+charge(amount: Decimal): Kết quả thanh toán
}
enum Trạng thái đơn hàng {
MỚI
ĐÃ THANH TOÁN
ĐÃ HỦY
}
class Đơn hàng <<Thực thể>> {
+id: UUID
+status: Trạng thái đơn hàng
}
class Dịch vụ thanh toán <<Dịch vụ>> {
+checkout(order: Đơn hàng): Kết quả thanh toán
}
Dịch vụ thanh toán ..> Cổng thanh toán : gọi
Đơn hàng --> Trạng thái đơn hàng
}
@enduml
Các gói nhóm trực quan các loại liên quan. Sử dụng các phần chú thích như “<<Entity>>" hoặc “<<Service>>"khi chúng cung cấp ngữ cảnh hữu ích; tránh thêm nhãn chỉ lặp lại những gì tên lớp đã nói.
6. Ghi chú, biệt danh và bố cục
Ghi chú có thể giải thích các quyết định thiết kế hoặc làm rõ một ràng buộc mà không làm quá tải tên lớp. Biệt danh hữu ích khi tên hiển thị chứa khoảng trắng hoặc dấu câu.

@startuml
class "External Payment API" as PaymentApi
class CheckoutService
CheckoutService ..> PaymentApi : submits payment
note right of CheckoutService
Retries transient failures.
Does not retry declined payments.
end note
left to right direction
@enduml
hướng từ trái sang phải thay đổi hướng bố cục tổng thể; mặc định là từ trên xuống dưới. Bạn cũng có thể sử dụng các hướng quan hệ như “-left->" hoặc “-up-|>" để hướng dẫn vị trí cục bộ.
7. Một ví dụ đầy đủ hơn
Ví dụ này kết hợp tính khả dụng, loại, phương thức, enum, số lượng, thành phần và phụ thuộc:

@startuml
left to right direction
package "Sales" {
class Customer {
-id: UUID
+name: String
+placeOrder(): Order
}
class Order {
-id: UUID
-status: OrderStatus
+addLine(product: Product, quantity: int): void
+total(): Decimal
}
class OrderLine {
-quantity: int
+lineTotal(): Decimal
}
class Product {
+sku: String
+price: Decimal
}
enum OrderStatus {
NEW
PAID
CANCELLED
}
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
class CheckoutService {
+checkout(order: Order): PaymentResult
}
Customer "1" --> "0..*" Order : places
Order *-- "1..*" OrderLine : contains
OrderLine "*" --> "1" Product : refers to
Order --> OrderStatus
CheckoutService ..> PaymentGateway : uses
}
@enduml
8. Công cụ: Visual Paradigm VPasCode
VPasCode là trình soạn thảo chuyển đổi văn bản thành sơ đồ dựa trên trình duyệt của Visual Paradigm. Nó hỗ trợ sơ đồ lớp PlantUML và cung cấp trình soạn thảo mã với chế xem trước trực tiếp, cho phép bạn viết hoặc dán PlantUML và kiểm tra kết quả được render khi đang làm việc.

Quy trình làm việc điển hình:
-
Mở VPasCode và chọn trình soạn thảo PlantUML hoặc một ví dụ PlantUML.
-
Thay thế văn bản mẫu bằng sơ đồ của bạn, bao gồm
@startumlvà@enduml. -
Kiểm tra chế xem trước trực tiếp; nếu việc render thất bại, hãy xem xét lỗi cú pháp được làm nổi bật và dòng tương ứng.
-
Tinh chỉnh sơ đồ, sau đó xuất hoặc chia sẻ theo nhu cầu. VPasCode mô tả các tùy chọn xuất SVG, PNG và PDF.
VPasCode cũng cung cấp giao diện chọn chủ đề cho PlantUML, bao gồm các chủ đề Visual Paradigm và Rose. Để đảm bảo kết quả nhất quán trong nhóm, hãy giữ nguồn PlantUML cùng với tài liệu hoặc mã của bạn thay vì chỉ dựa vào hình ảnh đã xuất.
9. Những lỗi phổ biến và thực hành tốt

-
Đừng nhầm lẫn giữa quan hệ kết nối (association) và phụ thuộc (dependency).Một sự phụ thuộc thường có nghĩa là “sử dụng”; trong khi một quan hệ kết nối thường biểu thị mối quan hệ cấu trúc bền vững hơn.
-
Tránh lạm dụng quan hệ tổng hợp (composition).Nó đưa ra tuyên bố mạnh mẽ hơn về vòng đời so với một kết nối đơn giản.
-
Gán nhãn đa số lượng từ phía đối diện.Số bên cạnh một lớp cho biết có bao nhiêu thể hiện của lớp đó có thể liên quan đến một thể hiện ở đầu kia.
-
Giữ cho sơ đồ tập trung.Chia một mô hình rất lớn thành các gói hoặc các sơ đồ riêng biệt cho các mối quan tâm khác nhau.
-
Hiển thị các chi tiết phục vụ đối tượng người xem.Một cái nhìn tổng quan khái niệm có thể chỉ cần tên lớp và các mối quan hệ; trong khi một sơ đồ ở mức thiết kế có thể cần kiểu, phạm vi truy cập và các phương thức.
-
Xem nguồn là tài liệu được duy trì.Xem xét các thay đổi đối với văn bản, render lại sau khi chỉnh sửa và tạo lại các bản xuất khi nguồn thay đổi.
Tham khảo nhanh

@startuml
class A {
+publicField: String
-privateField: int
#protectedMethod(): void
~packageMember(): boolean
}
interface I
abstract class Base
enum State { READY; DONE }
Base <|-- A
I <|.. A
A *-- B : composition
A o-- C : aggregation
A --> D : association
A ..> I : dependency
@enduml
PlantUML hỗ trợ các tính năng bổ sung cho sơ đồ lớp—bao gồm nhóm thành viên, ghi chú, màu sắc và hơn thế nữa—khi sơ đồ cần được tinh chỉnh thêm.










