🤓 👩‍🍳 🤷🏽 गणन का उपयोग करते हुए मेटाडेटा का प्रतिनिधित्व ✋ 👨‍👨‍👦‍👦 🏏

मेटाडेटा क्या है? यह कुछ वर्णनात्मक जानकारी है जो प्रोग्राम एल्गोरिदम द्वारा उपयोग की जाती है। उदाहरण के लिए, यह डेटाबेस के तालिकाओं और क्षेत्रों के नाम हो सकते हैं, रजिस्ट्री कुंजी के नाम जिसमें आवश्यक पैरामीटर संग्रहीत हैं, या प्रोग्राम द्वारा एक्सेस की गई वस्तुओं के गुणों के नाम हैं। मैं बताना चाहता हूं कि कैसे, विस्तार विधियों और विशेषताओं का उपयोग करके, आप मेटाडेटा का प्रतिनिधित्व करने के लिए आसानी से एनम का उपयोग कर सकते हैं।

क्वेरी पीढ़ी कार्य

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

 string BuildQuery() { ... if (IsDateFromSpecified) strQuery += "DateFrom >= '" + DateFromValue.ToString() + "'"; ... }

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

हम अनुरोध की शुद्धता को नियंत्रित करने के लिए संकलक की क्षमताओं का उपयोग नहीं करते हैं - आप किसी भी रेखा और किसी भी क्रम में शामिल हो सकते हैं।
भारी पठनीय कोड - "अदृश्य" अनुरोध
विशेषताओं का पुन: उपयोग करते समय स्ट्रिंग त्रुटियों का एक मौका है
एक विशेषता का नाम बदलना मुश्किल है - कोई गारंटी नहीं है कि सभी स्थानों में नाम बदला गया है
एक अलग सिंटैक्स (जैसे XPath से SQL) पर स्विच करना मुश्किल है

स्थिरांक का चयन करें

क्या करें? पहला, सबसे स्पष्ट समाधान विशेषता नामों के लिए स्थिरांक का उपयोग करना है, और स्थितियों का वर्णन करने के लिए स्वरूपित तार हैं। परिणाम कुछ इस तरह दिखेगा:

 const string MORE_OR_EQUALS_EXPRESSION = "{0} >= '{1}'"; const string DATE_FROM_ATTRIBUTE = "DateFrom"; string BuildQuery() { ... if (IsDateFromSpecified) strQuery += string.Format(MORE_OR_EQUALS_EXPRESSION, DATE_FROM_ATTRIBUTE, DateFromValue.ToString()); ... }

const string MORE_OR_EQUALS_EXPRESSION = "{0} >= '{1}'"; const string DATE_FROM_ATTRIBUTE = "DateFrom"; string BuildQuery() { ... if (IsDateFromSpecified) strQuery += string.Format(MORE_OR_EQUALS_EXPRESSION, DATE_FROM_ATTRIBUTE, DateFromValue.ToString()); ... }

बेशक, परिणामी कोड बनाए रखना आसान है, परिवर्तन करना आसान है, लेकिन मैं यह नहीं कह सकता कि यह अधिक पठनीय बन गया है। थोड़ा सोचने के बाद, मुझे एक समाधान मिला, जो वास्तव में, मैं साझा करना चाहता था। मैं नीचे दिए गए विवरण का खुलासा करूंगा, लेकिन अभी के लिए, अनुरोध पीढ़ी कोड (उत्पादन कोड से) का सिर्फ एक उदाहरण है:

 // -  predicate.Add(DGA.FlowId.EqualsTo(WorksFlowId)); //     predicate.Add(DGA.DogovorOfWorkID.EqualsTo(CurrentDocument.Id)); // if (DateFrom != null) predicate.Add(DGA.WorkEndsAt.MoreOrEqualThan(DateFrom.Value)); if (DateTo != null) predicate.Add(DGA.WorkStartsAt.LessOrEqualThan(DateTo.Value)); //   if (OnlyActive) predicate.Add(DGA.WorkState.EqualsTo(WorkState.Planned.ToString()));

// - predicate.Add(DGA.FlowId.EqualsTo(WorksFlowId)); // predicate.Add(DGA.DogovorOfWorkID.EqualsTo(CurrentDocument.Id)); // if (DateFrom != null) predicate.Add(DGA.WorkEndsAt.MoreOrEqualThan(DateFrom.Value)); if (DateTo != null) predicate.Add(DGA.WorkStartsAt.LessOrEqualThan(DateTo.Value)); // if (OnlyActive) predicate.Add(DGA.WorkState.EqualsTo(WorkState.Planned.ToString()));

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

हम गणन का उपयोग करते हैं

इसलिए, स्ट्रिंग स्थिरांक के बजाय, मैंने एक खोज के रूप में खोज क्षेत्रों को डिज़ाइन किया। खोज विशेषता का स्ट्रिंग नाम (इसमें हार्ड-टू-रीड XPath- जैसा लुक है) विवरण विशेषता में शामिल है:

 public enum DGA { [Description("doc_RegCard/rc_Index/date__")] RegDate, [Description("doc_RegCard/rc_Index/text__")] RegNum, [Description("doc_RegCard/rc_Index/text___")] Manager, [Description("doc_RegCard/rc_FlowKey")] FlowId, [Description("doc_RegCard/rc_Index/text__")] Title, [Description("doc_RegCard/rc_Index/text__")] Subject, ... }

public enum DGA { [Description("doc_RegCard/rc_Index/date__")] RegDate, [Description("doc_RegCard/rc_Index/text__")] RegNum, [Description("doc_RegCard/rc_Index/text___")] Manager, [Description("doc_RegCard/rc_FlowKey")] FlowId, [Description("doc_RegCard/rc_Index/text__")] Title, [Description("doc_RegCard/rc_Index/text__")] Subject, ... }

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

 public static string LessOrEqualThan(this DGA attrib, DateTime val) { return attrib.LessOrEqualThan(System.Xml.XmlConvert .ToString(val, System.Xml.XmlDateTimeSerializationMode.Unspecified)); } public static string LessOrEqualThan(this DGA attrib, string val) { return String.Format("{0} <= '{1}'", attrib.GetAttribName(), val); } public static string InList(this DGA attrib, IEnumerable<string> values) { return String.Format("{0} in list({1})", attrib.GetAttribName(), values .Select(x => "'" + x + "'") .Aggregate((x, y) => x + ", " + y)); }

public static string LessOrEqualThan(this DGA attrib, DateTime val) { return attrib.LessOrEqualThan(System.Xml.XmlConvert .ToString(val, System.Xml.XmlDateTimeSerializationMode.Unspecified)); } public static string LessOrEqualThan(this DGA attrib, string val) { return String.Format("{0} <= '{1}'", attrib.GetAttribName(), val); } public static string InList(this DGA attrib, IEnumerable<string> values) { return String.Format("{0} in list({1})", attrib.GetAttribName(), values .Select(x => "'" + x + "'") .Aggregate((x, y) => x + ", " + y)); }

खैर, और एक और विस्तार विधि - जो वास्तविक विशेषता नाम को पुनः प्राप्त करती है:

 public static class DGAExt { public static string GetAttribName(this DGA attrib) { if (_dgaNames != null) return _dgaNames[attrib]; return EnumHelper.GetDescription(attrib); } } public static class EnumHelper { /// <summary> /// Retrieve the description on the enum, eg /// [Description("Bright Pink")] /// BrightPink = 2, /// Then when you pass in the enum, it will retrieve the description /// </summary> /// <param name="en">The Enumeration</param> /// <returns>A string representing the friendly name</returns> public static string GetDescription(Enum en) { var desc = GetAttribute<DescriptionAttribute>(en); if (desc != null) return desc.Description; return en.ToString(); } public static T GetAttribute<T>(Enum en) where T : System.Attribute { Type type = en.GetType(); MemberInfo[] memInfo = type.GetMember(en.ToString()); if (memInfo.Length > 0) { var attrs = memInfo[0].GetCustomAttributes(typeof(T), false).Cast<T>(); return attrs.FirstOrDefault(); } return null; } }

public static class DGAExt { public static string GetAttribName(this DGA attrib) { if (_dgaNames != null) return _dgaNames[attrib]; return EnumHelper.GetDescription(attrib); } } public static class EnumHelper { /// <summary> /// Retrieve the description on the enum, eg /// [Description("Bright Pink")] /// BrightPink = 2, /// Then when you pass in the enum, it will retrieve the description /// </summary> /// <param name="en">The Enumeration</param> /// <returns>A string representing the friendly name</returns> public static string GetDescription(Enum en) { var desc = GetAttribute<DescriptionAttribute>(en); if (desc != null) return desc.Description; return en.ToString(); } public static T GetAttribute<T>(Enum en) where T : System.Attribute { Type type = en.GetType(); MemberInfo[] memInfo = type.GetMember(en.ToString()); if (memInfo.Length > 0) { var attrs = memInfo[0].GetCustomAttributes(typeof(T), false).Cast<T>(); return attrs.FirstOrDefault(); } return null; } }

निष्कर्ष

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

गणन का उपयोग करते हुए मेटाडेटा का प्रतिनिधित्व

क्वेरी पीढ़ी कार्य

स्थिरांक का चयन करें

हम गणन का उपयोग करते हैं

निष्कर्ष

More articles: