मेरमाइड.जीएस अनुक्रम आरेख सिंटैक्स गाइड

अनुक्रम आरेख क्या है?

एक अनुक्रम आरेख एक महत्वपूर्ण व्यवहारात्मक है यूएमएल आरेख विभिन्न प्रणाली एकाधिकारियों के बीच संदेशों, कार्यक्रम कॉल और डेटा पेलोड के क्रमागत प्रवाह को दृश्यमान बनाने के लिए डिज़ाइन किया गया है, एक रेखीय समय रेखा पर। एक मूल रूप से मान्यता प्राप्त यूएमएल आरेख प्रकार यह रनटाइम अंतरक्रियाओं को एक्स-अक्ष के अनुदिश ऊर्ध्वाधर जीवन रेखाओं के रूप में तंत्र घटकों को लगाकर और संदेश आदान-प्रदान को वाई-अक्ष के अनुदिश ट्रैक करके नक्शा बनाता है। यह ब्लूप्रिंट विकासकर्ताओं के लिए अत्यंत मूल्यवान है जो वितरित एपीआई हैंडशेक, माइक्रोसर्विस ऑर्केस्ट्रेशन मार्ग या रियल-टाइम उपयोगकर्ता प्रमाणीकरण प्रवाह के निर्माण में मदद करता है।

साथ में मेरमाइड.जीएस आप एक स्पष्ट टेक्स्ट संरचना का उपयोग करके जटिल समय संबंधी प्रक्रियाओं को स्क्रिप्ट कर सकते हैं। इंजन ऑटोमैटिक रूप से ऊर्ध्वाधर अंतराल का प्रबंधन करता है, संदेश तीर के संरेखण का प्रबंधन करता है और रनटाइम एक्टिवेशन ब्लॉक को आपके कैनवास पर स्पष्ट रूप से बनाता है।

मूल सिंटैक्स गाइड: तत्व और निर्माण

मेरमाइड में एक सटीक, उच्च स्कैन करने योग्य यूएमएल अनुक्रम आरेख डिज़ाइन करने के लिए, आपको प्रतिभागी घोषणाओं, संदेश तीर विकल्पों, स्पष्ट जीवन रेखाओं और शर्ती ब्लॉक संरचनाओं को महारत हासिल करना होगा।

1. प्रतिभागियों और अभिनेताओं की घोषणा करना

आप एक मानक प्रणाली एकाधिकारी की घोषणा करते हैं प्रतिभागी कीवर्ड का उपयोग करके। यदि एकाधिकारी मानव अंतिम उपयोगकर्ता या बाहरी संचालक का प्रतिनिधित्व करता है, तो अभिनेता कीवर्ड का उपयोग करके कैनवास पर मानक स्टिक-फिगर आइकन बनाएं:

अनुक्रम आरेख
    अभिनेता क्लाइंट
    प्रतिभागी API के रूप में गेटवे राउटर

प्रो टिप: का उपयोग करें के रूप में लंबे घटक नामों को संक्षिप्त आ inter एलियास में मैप करने के लिए कीवर्ड का उपयोग करें, जिससे आपके संदेश स्क्रिप्ट्स संक्षिप्त और पठनीय बने रहें।

2. संदेश तीर के फॉर्मेटिंग

आपके द्वारा उपयोग की जाने वाली रेखा और तीर के सिरे के प्रकार आपके प्रणाली प्रतिभागियों के बीच संचार शैली को निर्धारित करते हैं:

• ->> **सिंक्रोनस कॉल:** एक ठोस रेखा जिसके सिरे पर भरा हुआ तीर है। एक ब्लॉकिंग अनुरोध का प्रतिनिधित्व करता है जो निष्पादन पूरा होने का इंतजार करता है।
• --> **प्रतिक्रिया रेखा:** एक बिंदीदार रेखा जिसके सिरे पर खुला तीर है। डेटा पेलोड या स्वीकृति टोकन वापस करने के लिए उपयोग किया जाता है।
• -> **असिंक्रोनस कॉल:** एक ठोस रेखा जिसके सिरे पर खुला तीर है। एक गैर-ब्लॉकिंग संदेश या इवेंट प्रसार को इंगित करता है।

अनुक्रम आरेख
    एप्प->>सर्वर: अनुरोध पेलोड
    सर्वर-->एप्प: 200 OK प्रतिक्रिया

3. लाइफलाइन एक्टिवेशन बार का प्रबंधन

एक सिस्टम कंपोनेंट के तब ठीक तब एक कार्य को सक्रिय रूप से निष्पादित कर रहा है या थ्रेड मेमोरी का उपयोग कर रहा है, उसे दिखाने के लिए, उपयोग करें एक्टिवेट और डीएक्टिवेट कमांड। वैकल्पिक रूप से, आप अपने संदेश लक्ष्यों के साथ सीधे एक प्लस (+) या माइनस (-) चिह्न को सीधे एक तेज दृश्य संक्षिप्त रूप के रूप में जोड़ सकते हैं:

अनुक्रम आरेख
    क्लाइंट->>+सर्वर: डेटा प्रोसेस करें
    %% सर्वर अब दृश्य रूप से सक्रिय है
    सर्वर-->-क्लाइंट: परिणाम वापस करें

4. शर्तों और विकल्पों की संरचना (Alt, Opt, Loop)

शाखाओं वाले रनटाइम तर्क, टोकन मूल्यांकन, या बार-बार अनुरोध पुनर्प्रयास को संभालने के लिए, अपने संदेश स्क्रिप्ट को मानक ब्लॉक खंडों के भीतर लपेटें:

• अल्ट / एल्स — शर्ती रास्तों का मूल्यांकन करता है (if/else कोड ब्लॉक्स के समान)।
• ऑप्ट — एक वैकल्पिक चरण को परिभाषित करता है जो केवल विशिष्ट मापदंडों के तहत ही निष्पादित होता है।
• लूप — एक शर्त पूरी होने तक एक निष्पादन क्रम को दोहराता है।

अनुक्रम आरेख
    लूप प्रत्येक 30 सेकंड में
        क्लाइंट->>सर्वर: हार्टबीट पिंग
    अंत

स्पष्ट अनुक्रम समय रेखाओं के लिए श्रेष्ठ व्यवहार

• जीवन रेखाओं को साफ रखें: एक्स-अक्ष के साथ दर्जनों माइक्रो-एंटिटीज की सूची बनाने से बचें। यदि कोई प्रक्रिया छोटी सहायक क्लासेस के साथ बातचीत करती है, तो उन्हें उच्च स्तर की प्रणाली सीमा के पीछे सारांशित करें जैसे[प्रमाणीकरण कर्मचारी] या [कैश पूल].
• स्थिति कोड को स्पष्ट रूप से लेबल करें: जब उत्तर लौटाने के लिए लिख रहे हों (-->), बस “डेटा लौटाएं” लिखने के बजाय। मार्ग को स्पष्ट HTTP स्थिति संख्याओं या घटना प्रकारों के साथ लेबल करें (उदाहरण के लिए, "201 बनाया गया (JWT टोकन)") इंजीनियरों को सटीक संदर्भ देने के लिए।
• जटिल गणनाओं के लिए नोट्स कार्यान्वित करें: का उपयोग करें ऊपर नोट, बाएं ओर नोट, या दाएं ओर नोट गैर-दृश्य ऑपरेशनों को दस्तावेज़ीकरण के लिए निर्देशों का उपयोग करें, जैसे आंतरिक एन्क्रिप्शन चरण या डेटाबेस डेटा हैशिंग।

वास्तविक दुनिया के मेरमैड.js अनुक्रम आरेख उदाहरण

उदाहरण 1: सुरक्षित OAuth2 टोकन विनिमय प्रवाह (सक्रियता और वैकल्पिक ब्लॉक)

यह कार्यात्मक ब्लूप्रिंट एक सुरक्षित उपयोगकर्ता लॉगिन क्रम का मॉडल बनाता है। यह एक alt/else ब्लॉक के उपयोग से मानव कार्यकर्ताओं, स्पष्ट प्रणाली जीवन रेखाओं और जटिल सत्यापन मार्गों को जोड़ने के तरीके को दर्शाता है।

sequenceDiagram
    actor User as अंतिम उपयोगकर्ता
    participant App as मोबाइल ऐप क्लाइंट
    participant Auth as Auth0 पहचान प्रदाता

    User->>+App: "OAuth के साथ लॉगिन" पर क्लिक करें
    App->>+Auth: client_id और scope के साथ पुनर्निर्देशित करें
    Auth-->>User: लॉगिन इंटरफेस रेंडर करें
    User->>Auth: प्रमाणपत्र जमा करें
    
    Auth->>Auth: पासवर्ड हैश की पुष्टि करें
    
    alt प्रमाणपत्र सही हैं
        Auth-->>App: प्रमाणीकरण कोड के साथ 302 पुनर्निर्देशित करें
        App->>Auth: प्रमाणीकरण कोड को एक्सेस टोकन में बदलें
        Auth-->>-App: JWT टोकन (IdToken) लौटाएं
        App-->>User: उपयोगकर्ता खाता होम रेंडर करें
    else अमान्य प्रमाणपत्र
        Auth-->>App: 401 अनधिकृत त्रुटि लौटाएं
        App-->>-User: "अमान्य उपयोगकर्ता नाम/पासवर्ड" चेतावनी दिखाएं
    end

सिंटैक्स विश्लेषण: इस समय रेखा एक बहु-पक्षीय हैंडशेक का अनुसरण करती है। दalt / else कंटेनर द्विआधारी प्रमाणीकरण मार्गों को स्पष्ट रूप से दर्शाता है, ताकि त्रुटि स्थितियों को सही मार्ग के साथ पूरी तरह से दस्तावेजीकृत किया जा सके।

उदाहरण 2: वितरित आदेश इन्वेंटरी चेकआउट (समानांतर प्रक्रियाएँ और नोट्स)

यह उन्नत प्रणाली ब्लूप्रिंट एक उद्यम ई-कॉमर्स चेकआउट पाइपलाइन को नक्शा बनाता है। इसमें समानांतर ब्लॉक्स (par) का उपयोग करके समानांतर API डिसपैच रूटीन को दिखाता है और टोपोलॉजी के साथ डेटाबेस लॉकिंग नोट्स को संभालता है।

sequenceDiagram
    participant Web as वेब फ्रंटएंड
    participant Ord as ऑर्डर ऑर्केस्ट्रेटर
    participant Inv as इन्वेंटरी सेवा
    participant Pay as भुगतान गेटवे

    Web->>+Ord: चेकआउट अनुरोध जमा करें
    Note over Ord: आइटम स्टॉक उपलब्धता की जांच करें
    
    par समानांतर API कॉल भेजें
        Ord->>+Inv: इन्वेंटरी आइटम लॉक करें
        Inv-->-Ord: इन्वेंटरी आरक्षित (स्टॉक लॉक किया गया)
    and
        Ord->>+Pay: क्रेडिट कार्ड चार्ज की अनुमति दें
        Pay-->-Ord: सफलतापूर्वक कैप्चर (चार्ज निपटाया गया)
    end
    
    opt प्रक्रिया आवंटन विफल होती है
        Note right of Ord: यदि कोई कॉल विफल होती है तो रोलबैक सैगा निष्पादित करें
    end
    
    Ord-->-Web: 200 सफलता चेकआउट पुष्टि की गई

सिंटैक्स विश्लेषण: दpar / and कंटेनर इंजन को समानांतर निष्पादनों को एक साथ समूहित करने के लिए निर्देश देता है, समानांतर बैकएंड संचालन का दस्तावेजीकरण करता है। दNote over और Note right of टैग तकनीकी रनटाइम व्याख्याएँ सीधे कैनवास ग्रिड में डालते हैं, टीमों को डेटा लॉकिंग और रोलबैक सैगा जैसे बैकग्राउंड लेनदेन को समझने में मदद करते हैं बिना मुख्य संदेश तीरों को भारी बनाए।