Sebelum memasuki tata letak arsitektur tertentu seperti model C4 atau timeline urutan, sangat penting untuk memahami aturan dasar yang mengatur Buku Panduan PlantUML. PlantUML mengandalkan sistem notasi teks yang bersih dan sangat intuitif. Setelah Anda memahami bagaimana mesin membuka dokumen, memberi nama komponen struktural, dan menentukan rute garis koneksi, menulis tata letak sistem yang kompleks menjadi sangat alami.
Panduan singkat ini membahas mekanisme sintaks struktural global yang berlaku di hampir semua jenis diagram PlantUML di dalam lingkungan kerja VPasCode.
1. Pembungkus Dokumen Wajib
Setiap blok kode PlantUML harus dimulai dan diakhiri dengan tag kerangka yang eksplisit. Tag-tag ini memberi tahu parser VPasCode untuk mengaktifkan mesin rendering yang benar di kanvas pratinjau Anda:
@startuml— Baris ini harus ditempatkan tepat di bagian paling atas skrip Anda. Tidak ada yang boleh mendahului baris ini.@enduml— Baris ini harus ditempatkan tepat di bagian paling bawah skrip Anda, menandai akhir dari blok data diagram Anda.
Setiap kode yang ditulis di luar dua tanda ini akan diabaikan dengan aman oleh kompilator, atau dapat memicu peringatan validasi sintaks di panel diagnostik lingkungan kerja Anda.
2. Deklarasi Elemen: ID vs. Label Tampilan
Ketika memodelkan sistem perangkat lunak, Anda akan membuat berbagai elemen struktural seperti komponen, basis data, aktor, atau mikroservis. Dalam PlantUML, Anda dapat mendeklarasikan suatu elemen secara eksplisit dengan menentukan jenisnya, ID singkat internal, dan nama tampilan yang ramah pengguna yang dibungkus dengan tanda kutip:
komponen microservice_id sebagai "Payment Processing API"
database db_id sebagai "User Transaction SQL"Mengapa ini merupakan praktik terbaik: Menggunakan ID internal yang singkat dan bersih (seperti microservice_id) membuat menggambar garis hubungan jauh lebih cepat di kemudian hari. Jika suatu saat Anda perlu mengubah label yang ditampilkan ke pelanggan dari “Payment Processing API” menjadi “Global Checkout Service”, Anda hanya perlu mengeditnya di satu baris kode saja, bukan memperbarui puluhan baris di seluruh skrip Anda.
3. Menguasai Panah Hubungan dan Rute Berarah
Koneksi antar node sistem digambar menggunakan kombinasi garis miring (-) dan tanda kurung panah (>). Panjang garis miring dan penggunaan kata kunci berarah memberi Anda kendali implisit atas bagaimana mesin tata letak otomatis menyesuaikan ukuran diagram Anda:
- Koneksi Dasar:
A --> Bmenggambar panah berarah standar yang menunjuk dari elemen A langsung ke elemen B. - Garis Ketergantungan Titik-titik: Mengganti garis miring dengan titik menghasilkan garis putus-putus, yang merupakan standar industri untuk menunjukkan ketergantungan asinkron atau panggilan jaringan:
A ..> B. - Memaksa Orientasi Tata Letak: Meskipun mesin tata letak secara otomatis menempatkan kotak-kotak, Anda dapat secara eksplisit mengarahkan orientasi dengan memasukkan kata kunci arah langsung di dalam string panah:
A -up-> B(Memaksa B untuk dirender di atas A)A -down-> B(Memaksa B untuk dirender di bawah A)A -left-> B(Memaksa B untuk dirender di sebelah kiri A)A -right-> B(Memaksa B untuk dirender di sebelah kanan A)
4. Menambahkan Konteks Secara Langsung: Label dan Komentar Kode
Dokumentasi yang jelas sangat bergantung pada penempatan konteks yang tepat di sekitar garis visual dan skrip teks Anda:
Menandai Garis Koneksi
Anda dapat menambahkan teks penjelas langsung ke setiap garis koneksi dengan menambahkan tanda titik dua (“:) tepat setelah pemetaan hubungan Anda:
client_id --> api_id : "HTTPS POST /v1/checkout"Menulis Komentar Kode
Jika Anda ingin meninggalkan catatan administratif, kredit desain, atau penjelasan arsitektural di dalam file skrip Anda tanpa merender kotak visual di kanvas, gunakan karakter petik tunggal (“'). Ini memberi tahu mesin untuk melewatkan parsing baris tersebut sepenuhnya:
' TODO: Kita perlu memperbarui kotak batas ini setelah migrasi DevOps selesai
[Monolit Lama] --> [Microservice Baru]Sekarang Anda sudah terbiasa dengan pembungkus sintaks global, deklarasi komponen, dan parameter panah arah dari PlantUML, Anda benar-benar siap untuk mulai membangun bentuk sistem lanjutan. Lanjutkan ke halaman berikutnya untuk membuka koleksi kami tentang Diagram Arsitektur & Desain Tingkat Tinggi!