C4 मॉडल या सीक्वेंस टाइमलाइन जैसे विशिष्ट आर्किटेक्चरल लेआउट में डुबकी लगाने से पहले, यह समझना आवश्यक है कि किस पर आधारित नियमों के तहत काम करता हैPlantUML प्लेबुक. PlantUML एक साफ, बहुत अनुकूल टेक्स्ट नोटेशन प्रणाली पर निर्भर करता है। जब आप समझ लेते हैं कि इंजन दस्तावेज़ कैसे खोलता है, संरचनात्मक घटकों के नाम कैसे देता है और कनेक्शन लाइनों को कैसे रूट करता है, तो किसी भी जटिल सिस्टम लेआउट को लिखना पूरी तरह से प्राकृतिक हो जाता है।
यह त्वरित परिचय विभिन्न प्रकार के प्लांटयूएमएल डायग्राम में लागू होने वाले सार्वभौमिक संरचनात्मक सिंटैक्स मैकेनिज्म को कवर करता है, जो VPasCode वर्कस्पेस के अंदर लगभग हर जगह लागू होते हैं।
1. अनिवार्य दस्तावेज़ व्रैपर्स
प्लांटयूएमएल कोड का हर एक ब्लॉक को स्पष्ट फ्रेमवर्क टैग्स के साथ शुरू और समाप्त करना आवश्यक है। इन टैग्स को VPasCode पार्सर को आपके प्रीव्यू कैनवास में सही रेंडरिंग इंजन चालू करने के लिए बताते हैं:
@startuml— यह सटीक लाइन आपके स्क्रिप्ट के बिल्कुल शीर्ष पर रखी जानी चाहिए। इससे पहले कुछ भी नहीं होना चाहिए।@enduml— यह सटीक लाइन आपके स्क्रिप्ट के बिल्कुल नीचे रखी जानी चाहिए, जो आपके डायग्राम डेटा ब्लॉक के समापन को चिह्नित करती है।
इन दो मार्कर्स के बाहर लिखा गया कोई भी कोड कंपाइलर द्वारा सुरक्षित रूप से नजरअंदाज कर दिया जाएगा, या यह आपके वर्कस्पेस डायाग्नोस्टिक पैनल में सिंटैक्स वैलिडेशन चेतावनी को ट्रिगर कर सकता है।
2. तत्वों की घोषणा: आईडी बनाम प्रदर्शन लेबल
जब एक सॉफ्टवेयर सिस्टम का मॉडलिंग करते हैं, तो आप विभिन्न संरचनात्मक तत्व जैसे कंपोनेंट्स, डेटाबेस, एक्टर्स या माइक्रोसर्विसेज बनाएंगे। PlantUML में, आप तत्व की प्रकृति, आंतरिक संक्षिप्त आईडी और उपयोगकर्ता-अनुकूल प्रदर्शन नाम को उद्धरण चिह्नों में लिखकर स्पष्ट रूप से घोषित कर सकते हैं:
कंपोनेंट microservice_id के रूप में "पेमेंट प्रोसेसिंग API"
database db_id के रूप में "यूजर ट्रांजेक्शन SQL"क्यों यह एक बेस्ट प्रैक्टिस है: एक छोटे, साफ आंतरिक आईडी (जैसेmicroservice_id) बाद में संबंध लाइनें बनाने को बहुत तेज कर देता है। यदि आपको कभी ग्राहक-मुखी लेबल को “पेमेंट प्रोसेसिंग API” से “ग्लोबल चेकआउट सर्विस” में बदलना हो, तो आपको केवल एक ही कोड लाइन में उसे संपादित करना होगा, बजाय इसके कि आपको अपने स्क्रिप्ट के लगभग दसों लाइनों को अपडेट करना हो।
3. संबंध तीरों और दिशात्मक रूटिंग को समझना
सिस्टम नोड्स के बीच कनेक्शन डैशेज (-) और तीर ब्रैकेट्स (>) के संयोजन का उपयोग करके बनाए जाते हैं। आपके डैशेज की लंबाई और दिशात्मक कीवर्ड्स के शामिल होने से आपको स्वचालित लेआउट इंजन द्वारा आपके डायग्राम को कैसे स्केल करने के लिए अप्रत्यक्ष नियंत्रण मिलता है:
- बेसिक कनेक्शन्स:
A --> Bएक मानक दिशित तीर खींचता है जो तत्व A से सीधे तत्व B की ओर इशारा करता है। - डॉटेड डिपेंडेंसी लाइन्स: डैशेज के स्थान पर बिंदुओं का उपयोग करने से डॉटेड लाइन बनती है, जो एसिंक्रोनस डिपेंडेंसी या नेटवर्क कॉल को इंगित करने के लिए इंडस्ट्री मानक है:
A ..> B. - लेआउट अभिमुखीकरण के बलपूर्वक निर्देश: जबकि लेआउट इंजन बॉक्स को स्वचालित रूप से अलग करता है, आप तीर के तार में सीधे दिशा की शब्दावली डालकर अभिमुखीकरण को स्पष्ट रूप से निर्देशित कर सकते हैं:
A -up-> B(B को A के ऊपर रेंडर करने के लिए बाध्य करता है)A -down-> B(B को A के नीचे रेंडर करने के लिए बाध्य करता है)A -left-> B(B को A के बाईं ओर रेंडर करने के लिए बाध्य करता है)A -right-> B(B को A के दाईं ओर रेंडर करने के लिए बाध्य करता है)
4. सीधे संदर्भ जोड़ें: लेबल और कोड टिप्पणियाँ
स्पष्ट दस्तावेज़ीकरण अपनी दृश्य रेखाओं और पाठ स्क्रिप्ट्स के चारों ओर उपयुक्त संदर्भ रखने पर बहुत अधिक निर्भर करता है:
संबंध रेखाओं को लेबल करना
आप किसी भी संबंध रेखा के सीधे व्याख्यात्मक पाठ जोड़ सकते हैं जिसके बाद आप संबंध मानचित्र के बाद दाएँ बिंदु (“:) अपने संबंध मानचित्र के तुरंत बाद:
client_id --> api_id : "HTTPS POST /v1/checkout"कोड टिप्पणियाँ लिखना
यदि आप अपने स्क्रिप्ट फ़ाइल के भीतर प्रशासनिक नोट, डिज़ाइन क्रेडिट या संरचनात्मक व्याख्या छोड़ना चाहते हैं बिना किसी दृश्य बॉक्स को कैनवास पर रेंडर किए, तो एकल उद्धरण चिह्न (“'). इससे इंजन को उस पंक्ति को पूरी तरह से छोड़ने के लिए कहता है:
' TODO: हमें इस सीमा बॉक्स को अपडेट करने की आवश्यकता है जब DevOps माइग्रेशन पूरा हो जाए
[पुराना मोनोलिथ] --> [नया माइक्रोसर्विस]अब जब आप PlantUML के सार्वभौमिक सिंटैक्स व्रैपर्स, घटक घोषणाओं और दिशात्मक तीर पैरामीटर्स के साथ परिचित हैं, तो आप उन्नत प्रणाली आकृतियों के निर्माण के लिए पूरी तरह तैयार हैं। अपनी संग्रह को अनलॉक करने के लिए अगले पृष्ठ पर जाएँसंरचना और उच्च-स्तरीय डिज़ाइन आरेख!