UrlBuilder के उदाहरण पर TDD

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

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

समस्या

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

http://server.com?action=search&query=%20

दस्तावेज़ प्रकार द्वारा फ़िल्टरिंग के साथ सभी डेटाबेस में खोज करने के लिए:

http://server.com?action=search&query=%20&document_type_id=N

एक विशिष्ट दस्तावेज की खोज करने के लिए:

http://server.com?action=search&query=%20&document_id=M

और इसी तरह। संभावित प्रश्नों के सिर्फ कुछ दर्जन वर्ग। इसके अलावा, प्रत्येक अनुरोध या तो उत्पादन या एक देव सर्वर के लिए हो सकता है।

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

Uri.Builder उपयुक्त नहीं है, यदि केवल इसलिए कि वहां मेजबान बंदरगाह को स्थापित करने का कोई तरीका नहीं है।

इसलिए, मैंने यूआरएल बनाने के लिए एक वर्ग लिखने का फैसला किया।

के विश्लेषण

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

विकास: वर्ग इंटरफेस और इकाई परीक्षण

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

 public class UrlBuilder { public UrlBuilder protocol(String protocol){ return this; } public UrlBuilder host(String host){ return this; } public UrlBuilder port(String port){ return this; } public UrlBuilder path(String path){ return this; } public UrlBuilder param(String key, String value){ return this; } public String build() { return null; } } 

 public class ServerUrlBuilder extends UrlBuilder{ public UrlBuilder fullSearch(String query){ return this; } public UrlBuilder fullSearch(String query, int documentTypeId){ return this; } public UrlBuilder documentSearch(String query, long documentId){ return this; } } 

और तुरंत हम इकाई परीक्षण लिखते हैं। पहले UrlBuilder के लिए ...

 public class UrlBuilderTest extends TestCase { public void testRootUrl(){ UrlBuilder builder = new UrlBuilder(); String expected = "http://server.com/"; String actual = builder1.protocol(UrlBuilder.HTTP).host("server.com").build(); assertEquals(expected, actual); } public void testRootUrlWithOneParam(){ UrlBuilder builder = new UrlBuilder(); String expected = "http://server.com/?a=b"; String actual = builder.protocol(UrlBuilder.HTTP).host("server.com").param("a","b").build(); assertEquals(expected, actual); } public void testFullUrl(){ UrlBuilder builder = new UrlBuilder(); String expected = "http://server.com/folder/?a=b"; String actual = builder.protocol(UrlBuilder.HTTP).host("server.com").path("folder").param("a","b").build(); assertEquals(expected, actual); } } 

... और उसके बाद ServerUrlBuilder के लिए।

 public class SereverUrlBuilderTest extends TestCase { public void testFullSearch(){ ServerUrlBuilder builder = new ServerUrlBuilder(); String expected = "http://server.com?action=search&query= "; String actual = builder.fullSearch(" "); assertEquals(expected, actual); } public void testFullSearchWithDocumentTupeId(){ ServerUrlBuilder builder = new ServerUrlBuilder(); String expected = "http://server.com?action=search&query= &document_type_id=123"; String actual = builder.fullSearch(" ",123); assertEquals(expected, actual); } public void testDocumentSearch(){ ServerUrlBuilder builder = new ServerUrlBuilder(); String expected = "http://server.com?action=search&query= &document_id=123456"; String actual = builder.documentSearch(" ",123456); assertEquals(expected, actual); } } 

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

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

कार्यान्वयन

UrlBuilder वर्ग में स्थिरांक जोड़ें - कई प्रोटोकॉल और यूआरएल में उपयोग किए गए सीमांकक। हम प्रत्येक विधि का तर्क देते हैं।

 public class UrlBuilder { public static final String HTTP = "http"; public static final String HTTPS = "https"; public static final String FTP = "ftp"; private static final String sProtocolHostSeparator = "://"; private static final String sPathSeparator = "/"; private static final String sParamSeparator = "?"; private static final String sParamEquals = "="; private static final String sParamConcotinator = "&"; private String mProtocol; private String mHost; private final ArrayList<String> mPath = new ArrayList<String>(); private final ArrayList<String> mParamKeys = new ArrayList<String>(); private final ArrayList<String> mParamValues = new ArrayList<String>(); public UrlBuilder(){} public UrlBuilder protocol(String protocol){ mProtocol = protocol; return this; } public UrlBuilder host(String host){ mHost = host; return this; } public UrlBuilder path(String path){ mPath.add(path); return this; } public UrlBuilder param(String key, String value){ mParamKeys.add(key); mParamValues.add(value); return this; } public String build() { final StringBuilder builder = new StringBuilder(); builder.append(mProtocol); builder.append(sProtocolHostSeparator); builder.append(mHost); builder.append(sPathSeparator); for(String path : mPath){ builder.append(path); builder.append(sPathSeparator); } if(mParamKeys.size()>0){ builder.append(sParamSeparator); for(int i=0; i<mParamKeys.size(); i++){ String key = mParamKeys.get(i); if(i!=0){ builder.append(sParamConcotinator); } String value = mParamValues.get(i); builder.append(key); builder.append(sParamEquals); builder.append(value); } } String result = builder.toString(); return result; } } 

इकाई परीक्षण फिर से चलाएँ। हुर्रे, उनमें से कुछ सफल हैं। यह ServerUrlBuilder के तर्क को लागू करने के लिए बनी हुई है।

 public class ServerUrlBuilder extends UrlBuilder{ public static final String SERVER_HOST = "server.com"; public static final String PARAM_ACTION = "action"; public static final String ACTION_SEARCH = "search"; public static final String PARAM_QUERY = "query"; public static final String PARAM_DOCUMENT_TYPE_ID = "document_type_id"; public static final String PARAM_DOCUMENT_ID = "document_id"; public UrlBuilder fullSearch(String query){ protocol(HTTP); host(SERVER_HOST); param(PARAM_ACTION, ACTION_SEARCH); param(PARAM_QUERY, query); return this; } public UrlBuilder fullSearch(String query, int documentTypeId){ protocol(HTTP); host(SERVER_HOST); param(PARAM_ACTION, ACTION_SEARCH); param(PARAM_QUERY, query); param(PARAM_DOCUMENT_TYPE_ID, documentTypeId); return this; } public UrlBuilder documentSearch(String query, long documentId){ protocol(HTTP); host(SERVER_HOST); param(PARAM_ACTION, ACTION_SEARCH); param(PARAM_QUERY, query); param(PARAM_DOCUMENT_ID, documentId); return this; } } 

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

निष्कर्ष

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