🍥 👨‍👧‍👦 💛 मुझे C # में एक ग्राफकॉल सर्वर लिखिए 👨🏽‍🤝‍👨🏼 👨🏼‍🌾 🤴🏼

किसी तरह मेरे पास कुछ दिन की छुट्टी थी, और मैंने अपने डॉक्सविजन प्लेटफ़ॉर्म पर ग्राफकलाइन सर्वर को स्केच किया। नीचे मैं आपको बताऊंगा कि यह कैसे हुआ।

पोस्टर - इशारे पर

डॉक्सविजन मंच क्या है

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

विकल्प क्या हैं

ईमानदारी से, बहुत सारे विकल्प नहीं हैं और वे बहुत सारे हैं। मैं केवल दो पुस्तकालय खोजने में कामयाब रहा:

UPD: टिप्पणियों में उन्होंने सुझाव दिया कि अभी भी हॉटचैच है ।

README पर, पहले तो मुझे दूसरा पसंद आया, और मैंने भी इसके साथ कुछ करना शुरू कर दिया। लेकिन उसे जल्द ही पता चला कि उसकी एपीआई बहुत खराब थी, और वह मेटाडेटा स्कीम बनाने के काम को नहीं कर सकती थी। हालाँकि, ऐसा लगता है कि पहले ही छोड़ दिया गया था (एक साल पहले आखिरी प्रतिबद्ध)।

graphql-dotnet एपीआई काफी लचीला है, लेकिन एक ही समय में यह बहुत ही प्रलेखित, भ्रमित, और अनपेक्षित है। यह समझने के लिए कि इसके साथ कैसे काम करना है, मुझे स्रोत कोड देखना था ... सच है, मैंने 0.16 संस्करण के साथ काम किया, जबकि अब अंतिम 0.17.3 , और 7 बीटा संस्करण 2.0 पहले ही जारी किए जा चुके हैं। इसलिए मुझे खेद है कि यदि सामग्री थोड़ी पुरानी है।

मुझे यह भी उल्लेख करना होगा कि पुस्तकालय असम्बद्ध विधानसभाओं के साथ आते हैं। मुझे साइन इन असेंबली के साथ हमारे ASP.NET एप्लिकेशन में उनका उपयोग करने के लिए उन्हें मैन्युअल रूप से स्रोत से पुनर्निर्माण करना पड़ा।

GraphQL सर्वर संरचना

यदि आप ग्राफकॉल से परिचित नहीं हैं, तो आप गिटब एक्सप्लोरर की कोशिश कर सकते हैं। थोड़ा सा रहस्य - आप स्वत: पूर्ण होने के लिए Ctrl + स्थान दबा सकते हैं। क्लाइंट भाग में ग्राफिइक्यूएल से अधिक कुछ नहीं है, जिसे आपके सर्वर पर आसानी से खराब किया जा सकता है। बस index.html लें , npm पैकेज से स्क्रिप्ट जोड़ें, और अपने सर्वर के पते पर ग्राफकॉफ़्टर फ़ंक्शन में url बदलें - बस इतना ही, आप खेल सकते हैं।

एक साधारण प्रश्न पर विचार करें:

 query { viewer { login, company } }

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

योजना सी # कक्षाओं के आधार पर स्वचालित रूप से उत्पन्न की जा सकती है, लेकिन हम कट्टर के माध्यम से जाएंगे - हम अपने हाथों से सब कुछ करेंगे। लेकिन ऐसा इसलिए नहीं है क्योंकि मैं एक डेशिंग आदमी हूं, बस एक मेटाडेटा-आधारित स्कीमा जेनरेट करना ग्राफिकल-डॉटनेट में एक गैर-मानक स्क्रिप्ट है जो आधिकारिक प्रलेखन द्वारा समर्थित नहीं है। तो, हम एक अनचाहे क्षेत्र में, उसकी आंत में थोड़ी खुदाई करते हैं।

योजना बनाने के बाद, यह हमारे लिए क्लाइंट से सर्वर तक किसी भी सुविधाजनक तरीके से अनुरोध स्ट्रिंग (और पैरामीटर) वितरित करने के लिए बना रहता है (इससे कोई फर्क नहीं पड़ता कि यह कैसे प्राप्त होता है, पोस्ट, सिग्नल, टीसीपी ...), और योजना के साथ इसके इंजन को फ़ीड करें। इंजन एक वस्तु को बाहर निकाल देगा, जिसके परिणामस्वरूप हम JSON में बदल जाएंगे और इसे क्लाइंट को वापस कर देंगे। यह मेरे लिए इस तरह देखा:

  //  ,        var schema = GraphQlService.GetCardsSchema(sessionContext); //    (  ) var executer = new DocumentExecuter(); //   ,  var dict = await executer.ExecuteAsync(schema, sessionContext, request.Query, request.MethodName).ConfigureAwait(false); // -   :) if (dict.Errors != null && dict.Errors.Count > 0) { throw new InvalidOperationException(dict.Errors.First().Message); } //    return Json(dict.Data);

आप sessionContext ध्यान दे सकते हैं। यह हमारा डॉक्सविजन-विशिष्ट ऑब्जेक्ट है जिसके माध्यम से प्लेटफ़ॉर्म एक्सेस किया जाता है। एक योजना बनाते समय, हम हमेशा एक विशेष संदर्भ के साथ काम करते हैं, लेकिन बाद में उस पर अधिक।

सर्किट पीढ़ी

यह सब एक स्पर्श तरीके से शुरू होता है:

 Schema schema = new Schema();

दुर्भाग्य से, यह वह जगह है जहां सरल कोड समाप्त होता है। योजना में एक क्षेत्र जोड़ने के लिए, हमें चाहिए:

इसके प्रकार का वर्णन करें - एक ObjectGraphType, StringGraphType, BooleanGraphType, IdGraphType, IntGraphType, DateGraphType या FloatGraphType ऑब्जेक्ट बनाएँ।
फ़ील्ड को स्वयं का नाम (नाम, हैंडलर) बताएं - एक ग्राफक्यूएल बनाएँ

आइए उस सरल अनुरोध का वर्णन करने का प्रयास करें जिसे मैंने ऊपर उद्धृत किया है। अनुरोध में, हमारे पास एक फ़ील्ड है - दर्शक। इसे किसी क्वेरी में जोड़ने के लिए, आपको पहले इसके प्रकार का वर्णन करना होगा। इसका प्रकार सरल है - एक वस्तु, दो स्ट्रिंग फ़ील्ड के साथ - लॉगिन और कंपनी। हम लॉगिन क्षेत्र का वर्णन करते हैं:

 var loginField = new GraphQL.Types.FieldType(); loginField.Name = "login"; loginField.ResolvedType = new StringGraphType(); loginField.Type = typeof(string); loginField.Resolver = new MyViewerLoginResolver(); // ... class MyViewerLoginResolver : GraphQL.Resolvers.IFieldResolver { public object Resolve(ResolveFieldContext context) { // ,       -   UserInfo //      viewer return (context.Source as UserInfo).AccountName; } }

हम एक ही तरह से CompanyField ऑब्जेक्ट बनाते हैं - उत्कृष्ट, हम व्यूअर फ़ील्ड के प्रकार का वर्णन करने के लिए तैयार हैं।

 ObjectGraphType<UserInfo> viewerType = new ObjectGraphType<UserInfo>(); viewerType.Name = "Viewer"; viewerType.AddField(loginField); viewerType.AddField(companyField);

एक प्रकार है, अब हम स्वयं दर्शक क्षेत्र का वर्णन कर सकते हैं:

 var viewerField = new GraphQL.Types.FieldType(); viewerField.Name = "viewer"; viewerField.ResolvedType = viewerType; viewerField.Type = typeof(UserInfo); viewerField.Resolver = new MyViewerResolver(); // ... class MyViewerResolver : GraphQL.Resolvers.IFieldResolver { public object Resolve(ResolveFieldContext context) { //     sessionContext   ? // ,         (login  company) return (context.Source as SessionContext).UserInfo; } }

खैर, और अंतिम स्पर्श, हमारे क्षेत्र को क्वेरी प्रकार में जोड़ें:

 var queryType = new ObjectGraphType(); queryType.AddField(viewerField); schema.Query = queryType;

बस, हमारी योजना तैयार है।

संग्रह, पृष्ठांकन, पैरामीटर प्रसंस्करण

यदि फ़ील्ड एक वस्तु नहीं, बल्कि एक संग्रह लौटाता है, तो आपको इसे स्पष्ट रूप से निर्दिष्ट करने की आवश्यकता है। ऐसा करने के लिए, बस संपत्ति प्रकार को ListGraphType वर्ग के उदाहरण में लपेटें। मान लीजिए कि अगर किसी दर्शक ने एक संग्रह लौटाया, तो हम इसे बस लिखेंगे:

 //  ( ) viewerField.ResolvedType = viewerType; //  () viewerField.ResolvedType = new ListGraphType(viewerType);

तदनुसार, MyViewerResolver रिज़ॉल्वर में तब सूची को वापस करना आवश्यक होगा।

जब संग्रह फ़ील्ड दिखाई देते हैं, तो तुरंत पेजिंग का ध्यान रखना महत्वपूर्ण है। यहां कोई तैयार तंत्र नहीं है, सब कुछ मापदंडों के माध्यम से किया जाता है। आप ऊपर दिए गए उदाहरण में पैरामीटर का उपयोग करने का एक उदाहरण देख सकते हैं (कार्डकंडिशन में एक आईडी पैरामीटर है)। आइए दर्शक में ऐसा पैरामीटर जोड़ें:

 var idArgument = new QueryArgument(typeof(IdGraphType)); idArgument.Name = "id"; idArgument.ResolvedType = new IdGraphType(); idArgument.DefaultValue = Guid.Empty; viewerField.Arguments = new QueryArguments(idArgument);

फिर आप इस तरह से रिज़ॉल्वर में पैरामीटर मान प्राप्त कर सकते हैं:

 public object Resolve(ResolveFieldContext context) { var idArgStr = context.Arguments?["id"].ToString() ?? Guid.Empty.ToString(); var idArg = Guid.Parse(idArgStr);

GraphQL इतना टाइप्ड है कि गाइड, निश्चित रूप से, पार्स नहीं कर सकता है। खैर, ठीक है, यह हमारे लिए मुश्किल नहीं है।

डॉक्सविजन कार्ड अनुरोध

डॉक्सविजन प्लेटफॉर्म के लिए ग्रेपक्क्लाइन के कार्यान्वयन में, मैं तदनुसार केवल मेटाडेटा कोड ( sessionContext.Session.CardManager.CardTypes ) के माध्यम से जाता sessionContext.Session.CardManager.CardTypes , और सभी कार्डों और उनके अनुभागों के लिए मैं स्वचालित रूप से संबंधित रिज़ॉल्वर के साथ ऐसी वस्तुओं को स्वचालित रूप से sessionContext.Session.CardManager.CardTypes हूं। परिणाम कुछ इस प्रकार है:

 query { cardDocument(id: "{AF652E55-7BCF-E711-8308-54A05079B7BF}") { mainInfo { name instanceID } } }

यहाँ cardDocument कार्ड का प्रकार है, mainInfo इसमें अनुभाग का नाम है, नाम और उदाहरण अनुभाग में फ़ील्ड हैं। कार्ड, अनुभाग और फ़ील्ड के लिए संबंधित रिज़ॉल्वर निम्नानुसार CardManager API का उपयोग करते हैं:

  class CardDataResolver : GraphQL.Resolvers.IFieldResolver { public object Resolve(ResolveFieldContext context) { var sessionContext = (context.Source as SessionContext); var idArg = Guid.Parse(context.Arguments?["id"].ToString() ?? Guid.Empty.ToString()); return sessionContext.Session.CardManager.GetCardData(idArg); } } class SectionResolver : GraphQL.Resolvers.IFieldResolver { CardSection section; public SectionFieldResolver(CardSection section) { this.section = section; } public object Resolve(ResolveFieldContext context) { var idArg = Guid.Parse(context.Arguments?["id"].ToString() ?? Guid.Empty.ToString()); var skipArg = (int?)context.Arguments?["skip"] ?? 0; var takeArg = (int?)context.Arguments?["take"] ?? 15; var sectionData = (context.Source as CardData).Sections[section.Id]; return idArg == Guid.Empty ? sectionData.GetAllRows().Skip(skipArg).Take(takeArg) : new List<RowData> { sectionData.GetRow(idArg) }; } } class RowFieldResolver : GraphQL.Resolvers.IFieldResolver { Field field; public RowFieldResolver(Field field) { this.field = field; } public object Resolve(ResolveFieldContext context) { return (context.Source as RowData)[field.Alias]; } }

बेशक, यहां आप केवल आईडी द्वारा कार्ड का अनुरोध कर सकते हैं, लेकिन उन्नत रिपोर्ट, सेवाओं और किसी अन्य चीज तक पहुंच के लिए उसी तरह से एक योजना बनाना आसान है। इस एपीआई के साथ, आप केवल उचित जावास्क्रिप्ट लिखकर डॉक्सविजन डेटाबेस से कोई भी डेटा प्राप्त कर सकते हैं - यह आपकी स्वयं की स्क्रिप्ट और एक्सटेंशन लिखने के लिए बहुत सुविधाजनक है।

निष्कर्ष

.NET में GrapqhQL के साथ, चीजें आसान नहीं हैं। विश्वसनीय विक्रेता के बिना और समझ से बाहर भविष्य के साथ एक कुछ जीवंत पुस्तकालय है, एक अस्थिर और अजीब एपीआई, अज्ञात है कि यह कैसे लोड के तहत व्यवहार करेगा और यह कितना स्थिर है। लेकिन हमारे पास जो है, वह काम करने लगता है, लेकिन प्रलेखन में खामियां और बाकी की भरपाई स्रोत कोड के खुलेपन से होती है।

मैंने इस लेख में जो वर्णन किया है, वह एक बढ़ती हुई अनिर्दिष्ट एपीआई है, जिसे मैंने टाइप करके और स्रोत का अध्ययन करके पता लगाया है। यह सिर्फ पुस्तकालय के लेखकों ने नहीं सोचा था कि किसी को स्वचालित रूप से सर्किट उत्पन्न करने की आवश्यकता होगी - ठीक है, आप क्या कर सकते हैं, यह खुला स्रोत है।

यह सब सप्ताहांत में लिखा गया था, और खुद के द्वारा, अब तक एक प्रोटोटाइप से अधिक नहीं है। मानक डॉक्सविजन पैकेज में, यह दिखाई देने की संभावना है, लेकिन कब - यह कहना अभी भी मुश्किल है। हालाँकि, यदि आपको सर्वर एक्सटेंशन के बिना JavaScrpit से सीधे डॉक्सविजन डेटाबेस एक्सेस करने का विचार पसंद है, तो लिखें। भागीदारों से अधिक ब्याज, हम इस पर ध्यान देंगे।

मुझे C # में एक ग्राफकॉल सर्वर लिखिए