यदि आप ReSharper का उपयोग करते हैं, तो आप संभवतः इसके हाइलाइटिंग "संभावित 'NullReferenceException' से परिचित हैं। " इस लेख में, मैं संक्षेप में उस विश्लेषक के बारे में बात करूंगा जो इस तरह की चेतावनी देता है, और इसे बेहतर तरीके से करने में कैसे मदद करता है।

तुरंत एक उदाहरण पर विचार करें:

public string Bar( bool condition) { string iAmNullSometimes = condition ? "Not null value" : null ; return iAmNullSometimes.ToUpper(); } * This source code was highlighted with Source Code Highlighter .

ReSharper इस चेतावनी के साथ विधि की दूसरी पंक्ति में iAmNullSometimes को सही ढंग से उजागर करता है। अब विधि का चयन करें:

public string Bar( bool condition) { string iAmNullSometimes = GetNullWhenFalse(condition); return iAmNullSometimes.ToUpper(); } public string GetNullWhenFalse( bool condition) { return condition ? "Not null value" : null ; } * This source code was highlighted with Source Code Highlighter .

इस ऑपरेशन के बाद, चेतावनी गायब हो जाती है। ऐसा क्यों हो रहा है?

विश्लेषक

विश्लेषक यह पहचानने की कोशिश करता है कि उपयोग किए गए चर के क्या मूल्य हो सकते हैं। मैं स्पष्ट करूंगा कि एक चर के मूल्य के बारे में अमूर्त ज्ञान का स्तर किस स्तर पर घटा है। विश्लेषक के दृष्टिकोण से, एक चर में एक या कई राज्य हो सकते हैं:

* NULL , NOT_NULL - इंगित करता है कि लिंक में एक शून्य या गैर-शून्य मान है;

* सही , FALSE - इसी प्रकार के बूल के लिए ;

* UNKNOWN - आशावादी विश्लेषण के लिए दर्ज मूल्य, जिसकी मदद से झूठी सकारात्मक की संख्या कम हो जाती है।

विश्लेषक के परिणामस्वरूप, चर के उपयोग के प्रत्येक बिंदु के लिए, संभावित राज्यों का एक सेट निर्धारित किया जाता है।

पहली सूची में, प्रारंभिक के बाद iAmNullSometimes के दो संभावित राज्य होंगे: NULL और NOT_NULL । इसलिए, "संभावित NullReferenceException" हाइलाइटिंग हमें बताती है कि कम से कम एक प्रोग्राम निष्पादन पथ है जिसमें iAmNullSometimes शून्य होगा (इस मामले में, जिस स्थिति में स्थिति झूठी है)।

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

एक और विकल्प है। मान लें कि जिन बाहरी तरीकों से कुछ भी ज्ञात नहीं है, वे NULL या NOT_NULL हैं । यह कैसे निराशावादी विश्लेषण काम करता है।

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

विश्लेषक और उसके ऑपरेटिंग मोड के लिए एक अलग लेख की आवश्यकता होती है, इसलिए मैं उनके बारे में अलग से लिखूंगा।

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

ठेके

ReSharper विश्लेषक अतिरिक्त विधियों के बारे में ज्ञान का उपयोग कर सकता है, इसे अनुबंधों के माध्यम से प्राप्त कर सकते हैं जैसे "एक विधि कभी भी अशक्त नहीं", "एक विधि अशक्त वापस आ सकती है", "आप एक पैरामीटर में अशक्त नहीं कर सकते हैं"। सरलतम स्थिति में, ये अनुबंध JetBrains.Annotations.CanBeNullAttribute और JetBrains.Annotations.NotNullAttribute विशेषताओं का उपयोग करके परिभाषित किए गए हैं। एक विशेषता को एक विधि पर लागू करना इंगित करेगा कि क्या यह अशक्त लौट सकता है। पैरामीटर के लिए - शून्य मान को प्रतिस्थापित करने की अनुमति पर। उन्हें संपत्तियों और क्षेत्रों पर भी लागू किया जा सकता है। ये विशेषताएँ JetBrains.Annotations.dll लाइब्रेरी में परिभाषित की गई हैं, जो <ReSharper install directory> Bin में स्थित है ।

CanBeNull विशेषता के साथ GetNullWhenFalse विधि को चिह्नित करके दूसरी सूची में उदाहरण में सुधार किया जा सकता है:

public string Bar( bool condition) { string iAmNullSometimes = GetNullWhenFalse(condition); return iAmNullSometimes.ToUpper(); } [CanBeNull] public string GetNullWhenFalse( bool condition) { return condition ? "Not null value" : null ; } * This source code was highlighted with Source Code Highlighter .

IAmNullSometimes चर विधि का उपयोग करते समय, इस मामले में "संभावित 'NullReferenceException" हाइलाइट दिखाई देता है।

यदि आप अपनी परियोजना में एक अतिरिक्त असेंबली को खींचना नहीं चाहते हैं, जो रनटाइम में कार्यक्षमता भी नहीं जोड़ता है, तो आप इन विशेषताओं को सीधे अपनी परियोजना में घोषित कर सकते हैं। विश्लेषक किसी भी विधानसभाओं से किसी भी विशेषता का उपयोग करने के लिए उपयुक्त है, यदि केवल उनके नाम JetBrains.Annotations.dll में निर्दिष्ट लोगों के साथ मेल खाते हैं। ReSharper की सेटिंग पृष्ठों में से एक पर स्थित क्लिपबोर्ड बटन पर कॉपी डिफ़ॉल्ट कार्यान्वयन का उपयोग करके इन विशेषताओं की परिभाषा आसानी से प्राप्त की जा सकती है:

बाहरी एनोटेशन

यदि आप एक बाहरी पुस्तकालय (जैसे। Mscorlib.dll ) का उपयोग करना चाहते हैं, तो विशेषताओं का उपयोग करके इसकी संस्थाओं के लिए अनुबंध दर्ज करना संभव नहीं है। यहाँ पर बाह्य व्याख्याएँ बचाव में आती हैं। यह ReSharper सुविधा आपको ReSharper विश्लेषक द्वारा उपयोग की जाने वाली विशेषताओं के साथ पहले से संकलित संस्थाओं को पूरक करने की अनुमति देती है। बाहरी एनोटेशन विश्लेषक को "ट्रिक" करने का अवसर प्रदान करते हैं - इसे बनाने के लिए ताकि यह उन विशेषताओं, मापदंडों और अन्य घोषणाओं को देखता है जो लाइब्रेरी संकलित होने पर घोषित नहीं किए गए थे। ऐसा करने के लिए, विशेषताएँ <ReSharper स्थापित निर्देशिका> \ Bin \ ExternalAnnotnot निर्देशिका में स्थित XML फ़ाइल में लिखी जानी चाहिए।

यह मानक पुस्तकालयों के लिए अनुबंध को परिभाषित करता है जो ReSharper स्थापित करते समय इस फ़ोल्डर में आते हैं। ये कॉन्ट्रैक्ट सोर्स कोड एनालिसिस और माइक्रोसॉफ्ट कॉन्ट्रैक्ट्स से लिए गए थे। पहले दृष्टिकोण के परिणामस्वरूप प्राप्त अनुबंध * .Generated.xml नाम के साथ फ़ाइलों में स्थित हैं, दूसरे के परिणामस्वरूप * .Contracts.xml ।

अतिरिक्त विशेषताओं का वर्णन करने वाली फ़ाइलों में XmlDoc फ़ाइलों की संरचना के समान एक संरचना होती है। उदाहरण के लिए, चौथे फ्रेमवर्क के System.Xml असेंबली से XmlReader.Create (स्ट्रीम इनपुट) विधि के लिए, नोटनल अनुबंध को निम्नानुसार परिभाषित किया गया है:

< assembly name ="System.Xml, Version=4.0.0.0" >  < member name ="M:System.Xml.XmlReader.Create(System.IO.Stream)" >  < attribute ctor ="M:JetBrains.Annotations.NotNullAttribute.#ctor" />  < parameter name ="input" > < attribute ctor ="M:JetBrains.Annotations.NotNullAttribute.#ctor" /> </ parameter > </ member > </ assembly > * This source code was highlighted with Source Code Highlighter .

फ़ाइल को चुनने के लिए ReSharper के लिए, इसे निम्न तरीकों में से एक में रखा जाना चाहिए: <ReSharper install directory> \ Bin \ ExternalAnnotations \ <विधानसभा का नाम> .xml या <ReSharper इनस्टॉल डायरेक्टरी>> Bin \ ExternalAnnotations \ <विधानसभा का नाम> <<कोई भी नाम>। xml , जहाँ <विधानसभा का नाम> बिना किसी संस्करण को निर्दिष्ट किए विधानसभा नाम है। यदि आप दूसरे तरीके से फाइलों की व्यवस्था करते हैं, तो एक विधानसभा के लिए आप अनुबंधों के कई सेट निर्दिष्ट कर सकते हैं। विभिन्न संस्करणों के साथ विधानसभा अनुबंधों को अलग करने के लिए यह आवश्यक हो सकता है।

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

आवेदन

बाह्य एनोटेशन का उपयोग करने की कई प्रथाएं जो रीशर के साथ काम करते समय जीवन को बेहतर बनाती हैं।

XmlDocument.SelectNodes (स्ट्रिंग xpath)

इस विधि के लिए कैनबुल एनोटेशन अक्सर बग रिपोर्ट का विषय होता है। तथ्य यह है कि SelectNodes XmlNode क्लास का एक तरीका है और सामान्य तौर पर null (उदाहरण के लिए, XmlDeclaration ) के लिए वापस आ सकता है। लेकिन सबसे अधिक बार हम इस विधि का उपयोग करते हैं जब यह कभी भी शून्य नहीं लौटता है, - एक्सएमएलडिमेंटमेंट से । एक समाधान बाहरी एनोटेशन से संबंधित एनोटेशन को हटाने या इसे नोटनूल से बदलने का हो सकता है । लेकिन आप XmlDocument के लिए एक्सटेंशन विधि लिखकर सही काम कर सकते हैं:

public static class XmlUtil { [NotNull] public static XmlNodeList SelectNodesEx([NotNull] this XmlDocument xmlDocument, [NotNull] string xpath) { // ReSharper disable AssignNullToNotNullAttribute return xmlDocument.SelectNodes(xpath); // ReSharper restore AssignNullToNotNullAttribute } } * This source code was highlighted with Source Code Highlighter .

इस मामले में, निश्चित रूप से, हर बार टाइप रूपांतरण से बचने के लिए SelectElements और SelectAttributes जैसे तरीके बनाना अच्छा होगा, लेकिन यह एक और कहानी है।

अभिकथन

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

< assembly name ="Microsoft.Contracts" > < member name ="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean)" > < attribute ctor ="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor" /> < parameter name ="condition" > < attribute ctor ="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)" > < argument > 0 </ argument > </ attribute > </ parameter > </ member > < member name ="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean,System.String)" > < attribute ctor ="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor" /> < parameter name ="condition" > < attribute ctor ="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)" > < argument > 0 </ argument > </ attribute > </ parameter > </ member > </ assembly > * This source code was highlighted with Source Code Highlighter .

यदि आप हमेशा एक अपवाद को फेंकने के तरीके हैं, तो आप टर्मिनेटरप्रोग्राम एट्रिब्यूट की ओर भी देख सकते हैं।

और अंत में

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

और हाँ। अनुबंध के साथ अपना कोड एनोटेट करें और आपका स्वागत होगा!

ReSharper: NullReferenceException पर विश्लेषण और इसके लिए अनुबंध