अंतर्निहित कोड दोहराव से निपटने की मूल बातें

दो या दो से अधिक स्थानों में समान संरचना वाला एक कोड रिफैक्टरिंग की आवश्यकता का एक निश्चित संकेत है। यदि आपको एक स्थान पर कुछ बदलने की आवश्यकता है, तो सबसे अधिक संभावना है कि आपको अन्य स्थानों पर भी ऐसा करने की आवश्यकता है। लेकिन इन स्थानों को नहीं ढूंढने या उनके लिए बस भूलने की 100% संभावना है।

अधिकांश लोगों को एहसास है कि नीचे दिए गए उदाहरण में कोड (या कॉपी-पेस्ट) को दोहराना बुराई है:

// //    -  // void DrawCircle(int x, int y, int radius) { ///       (x, y)  radius } … DrawCircle(getScreenMetrics().width / 2, getScreenMetrics().height / 2, 100500); DrawCircle(getScreenMetrics().width / 2, getScreenMetrics().height / 2, 100600); 

सबसे स्पष्ट तरीका है कि सर्कल के केंद्र के निर्देशांक को अलग-अलग चर में स्थानांतरित किया जाए:

 ScreenMetrics metrics = getScreenMetrics(); int centerX = metrics.width / 2; int centerY = metrics.height / 2; DrawCircle(centerX, centerY, 100); DrawCircle(centerX, centerY, 200); 

ऊपर दिए गए उदाहरण में, दो सेकंड में दोहराव को समाप्त कर दिया जाता है क्योंकि उदाहरण को उंगली से चूसा जाता है क्योंकि ऐसे भाव जो मंडलियों के केंद्र के निर्देशांक को पूरी तरह से मेल खाते हैं:

 getScreenMetrics().width / 2, getScreenMetrics().height / 2 

इसी समय, सभी डेवलपर्स से अभी तक अंतर्निहित कोड दोहराव को पहचानने और समाप्त करने में सक्षम हैं।

उदाहरण के लिए एक मोबाइल एप्लिकेशन लें जो सर्वर के एपीआई और के साथ सहभागिता करता है
एक अधिकृत उपयोगकर्ता को तस्वीरें देखने और अपलोड करने की अनुमति देता है:

 HttpResponse login(String email, String password) { HttpRequest request = new HttpRequest(); request.setMethod(“GET”); request.setContentType("application/x-www-form-urlencoded"); String parameters = "?login=" + login + "&password=" + password; String uri = "https://mycoolsite.com/api/login" + parameters; request.setUrl(uri); return request.execute(); } ... HttpResponse getPhotos(int userId) { String uri = "https://mycoolsite.com/api/get_photos?user_id=" + user_id; HttpRequest request = new HttpRequest(); request.setMethod("GET"); request.setUrl(uri); request.setContentType("application/x-www-form-urlencoded"); return request.execute(); } … bool uploadPhoto(Bitmap photo, int user_id) { HttpRequest request = new HttpRequest(); HttpBody body = convertBitmapToHttpBody(photo); request.setUrl("https://mycoolsite.com/api/upload_photo?user_id=" + user_id); request.setMethod("POST"); request.setContentType(“multipart/form-data”); request.setHttpBody(body); HttpResponse response = request.execute(); return (response.getStatusCode()== 200); } 

... और एक और 100,500 समान तरीके, कुल एपीआई कॉल की संख्या।

यदि mycoolsite.com भयानक.net पर चला जाए तो क्या होगा? आपको पूरे प्रोजेक्ट के लिए request.execute () सर्च करना होगा और लाइनों को एडिट करना होगा। और कहीं न कहीं, यूआरएल को ठीक करने के लिए भूल जाओ या बस सील कर दिया जाए। परिणामस्वरूप, बहुत समय बिताते हैं, रात को ग्राहक के पास "सही" निर्माण भेजें, लेकिन अगले दिन SUDDENLY को एक बग रिपोर्ट मिल सकती है: "फोटो अपलोड करना बंद कर दिया", उदाहरण के लिए।

यदि आप तुरंत "माथे" पर कोड नहीं लिखते हैं, और थोड़ी देर के लिए धूम्रपान करते हैं और थोड़ा सोचते हैं, तो आप देख सकते हैं कि ऊपर दिए गए सभी तीन तरीके लगभग एक ही काम करते हैं:

• HttpRequest वर्ग का एक उदाहरण बनाएँ
• उदाहरण के लिए आवश्यक गुण सेट करें (HTTP विधि, सामग्री प्रकार)
• पैरामीटर के साथ URL सेट करें
• वैकल्पिक: शरीर में बाइनरी डेटा अनुरोध जोड़ें।

पहले आपको अलग-अलग तरीकों से सामान्य कोड डालने की आवश्यकता है:

 public HttpRequest createGetRequest() { HttpRequest request = new HttpRequest(); request.setMethod("GET"); request.setContentType("application/x-www-form-urlencoded"); return request; } public HttpRequest createPostRequest() { HttpRequest request = new HttpRequest() request.setMethod("POST"); request.setContentType("multipart/form-data"); return request; } 

गुजरती मापदंडों और एक अनुरोध URI को उत्पन्न करने पर विशेष ध्यान दिया जाना चाहिए।
कोड का प्रारंभिक संस्करण स्ट्रिंग संघनन का उपयोग करता है:

 String uri = "https://mycoolsite.com/api/get_photos?user_id=" + user_id; 

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

 public static final String API_BASE_URL = "https://mycoolsite.com/api/"; 

URI का अनुरोध करने से पहले, हम सभी मापदंडों और उनके मूल्यों को मानचित्र में एकत्र करेंगे:

 Map params = new HashMap<String, String>(); ... public void addParam(Map<String, String> params, String param, String value) { params.put(param, value); } //       public void addParam(Map<String, String> params, String param, int value) { params.put(param, String.valueOf(value)); } 

अब, पूर्ण अनुरोध URI उत्पन्न करने के लिए, हम निम्नलिखित कोड लिखेंगे:

 public String getUri(String path, Map<String, String> params) { StringBuilder query = new StringBuilder("?"); Iterator iterator = params.allKeys().iterator(); while (iterator.hasNext()) { String paramName = iterator.next(); query.add(paramName + "=" + params.get(paramName)); if (iterator.hasNext()) { query.add("&"); } } return API_BASE_URL + path + result.toString(); } 

इसलिए, सर्वर से अनुरोध को पूरा करने के लिए, हमें चाहिए:

• अनुरोध ऑब्जेक्ट बनाएँ:

 HttpRequest request = createGetRequest(); //  createPostRequest,     

• अनुरोध URI उत्पन्न करें:

 Map params = new HashMap<String, String>(); ... addParam(params, "user_id", userId); // ,  userId   String uri = getUri("get_photos"); //   : https://mycoolsite.com/api/get_photos?user_id=%user_id% 

अब आप सर्वर से अनुरोध को निष्पादित कर सकते हैं, प्रतिक्रिया प्राप्त कर सकते हैं, और फिर उसके साथ कुछ भी कर सकते हैं:

 request.setUrl(uri); HttpResponse response = request.execute(); 

अब हम यह सब सामान एक अलग वर्ग में ले जाएंगे। साथ ही इस वर्ग से विरासत में मिला
HttpRequest, जैसा कि कुछ मामलों में हमें इसके तरीकों का उपयोग करने की आवश्यकता है।

हमें निम्नलिखित कोड मिलते हैं:

 public class MyRequest extends HttRrequest { private static final String API_BASE_URL = "https://mycoolsite.com/api/"; private Map<String, String> mParameters; private MyRequest() { super(); mParameters = new HashMap<String, String>(); } public static MyRequest createGetRequest() { MyRequest request = new MyRequest(); request.setMethod("GET"); request.setContentType("application/x-www-form-urlencoded"); return request; } public static MyRequest createPostRequest() { MyRequest request = new MyRequest() request.setMethod("POST"); request.setContentType("multipart/form-data"); return request; } public void addParam(String name, String value) { mParameters.put(name, value); } public void addParam(String name, int value) { addParam(name, String.valueOf(value)); } public HttpResponse send(String path) { String uri = API_BASE_URL + path getParametersString(); setUrl(uri); execute(); } private String getParametersString() { StringBuilder result = new StringBuilder("?"); Iterator iterator = mParameters.allKeys().iterator(); while (iterator.hasNext()) { String paramName = iterator.next(); result.add(paramName + "=" + mParameters.get(paramName)); if (iterator.hasNext()) { result.add("&"); } } return result.toString(); } } 

अब एपीआई कॉल कोड इस तरह दिखेगा:

 HttpResponse login(String login, String password) { MyRequest request = MyRequest.createGetRequest(); request.addParam("login", login); request.addParam("password", password); return request.send("login"); } HttpResponse getPhotos(int userId) { MyRequest request = MyRequest.createGetRequest(); request.addParam("user_id", userId); return request.send("get_photos"); } HttpResponse uploadPhoto(Bitmap photo, int userId) { MyRequest request = MyRequest.createPostRequest(); request.addParam(“user_id”, userId); request.setHttpBody(convertBitmapToHttpBody(photo)); return request.send(“upload_photo”); } 

जैसा कि आप देख सकते हैं, लॉगिन, getPhotos और uploadPhoto विधियाँ छोटी, सरल और अधिक समझ में आ गई हैं।

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

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

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

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

रिफ्लेक्टरिंग पर फाउलर पुस्तक में और पढ़ें।

मुझे रचनात्मक आलोचना, सुझाव और लेख में परिवर्धन की खुशी होगी। आपका ध्यान के लिए धन्यवाद!