डिजाइन की "गंध": अस्थायी कनेक्टिविटी

यह पोका-योक डिज़ाइन के बारे में एक श्रृंखला में पहली पोस्ट है - जिसे एनकैप्सुलेशन के रूप में भी जाना जाता है ।

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

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

var b = new EndpointAddressBuilder(); var e = b.ToEndpointAddress(); 

यह पता चलता है कि एंडपॉइंट बनाने के लिए, आपको कम से कम एक यूआरआई प्रदान करना होगा। निम्न उदाहरण संकलित करता है और सामान्य रूप से चलता है:

 var b = new EndpointAddressBuilder(); b.Uri = new UriBuilder().Uri; var e = b.ToEndpointAddress(); 

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

"गंध" का एक उदाहरण।
यह उदाहरण गंध वर्ग में दिखाए गए अधिक सार "गंध" का वर्णन करता है। एक खुला एपीआई इस तरह दिख सकता है:

 public class Smell { public void Initialize(string name) public string Spread() } 

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

 var s = new Smell(); var n = s.Spread(); 

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

 var sut = new Smell(); sut.Initialize("   "); var n = sut.Spread(); 

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

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

 public class Fragrance : IFragrance { private readonly string name; public Fragrance(string name) { if (name == null) { throw new ArgumentNullException("name"); } this.name = name; } public string Spread() { return this.name; } } 

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

• कक्षा की चक्रवाती जटिलता कम;
• वर्ग अब अपरिवर्तनीय है, जिसका अर्थ है कि यह धागा सुरक्षित है।

हालांकि, कभी-कभी ऐसा होता है कि कक्षा का मूल संस्करण एक इंटरफ़ेस को लागू करता है जो अस्थायी कनेक्टिविटी का कारण बनता है। यहाँ एक उदाहरण है:

 public interface ISmell { void Initialize(string name); string Spread(); } 

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

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

 public interface IFragranceFactory { IFragrance Create(string name); } 

सरल कार्यान्वयन:

 public class FragranceFactory : IFragranceFactory { public IFragrance Create(string name) { if (name == null) { throw new ArgumentNullException("name"); } return new Fragrance(name); } } 

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

 var f = factory.Create(name); var n = f.Spread(); 

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