एक और बदसूरत बत्तख का बच्चा या स्पेगेटी refactoring के विकास को देखो

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

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


आपको याद दिला दूं कि कोड को कंघी करना कार्य है

<h1></h1> <? $DB = new DBConnector; $DB->query('SELECT * FROM users LIMIT 10'); if($DB->get_num_rows()){ while($user = $DB->fetch_row()){ echo '<p>'.$user['name'].'</p>'; } } ?> 

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

हम PHPUnit जैसे चौखटे का उपयोग किए बिना सीधे PHP में एक साधारण परीक्षण लिख रहे हैं।

 <?php $expected = <<<'EOT' <h1></h1> <p>Username1</p><p>Username2</p><p>Username3</p><p>Username4</p> EOT; ob_start(); include 'index.php'; $actual = ob_get_clean(); echo $actual === $expected ? 'OK' : 'Failed', PHP_EOL; 

हम शुरू करते हैं ... और हमें DBConnector वर्ग की कमी के कारण "संकलन" की त्रुटि प्राप्त होती है। आगे की हलचल के बिना, हम इसके लिए एक स्टब लिखते हैं ("लड़ाई" में दर्शाते हुए कि मुझे इसे कनेक्ट करना होगा, टेस्ट टेबल बनाना होगा, आदि, लेकिन पोस्ट परीक्षण विधियों के बारे में नहीं है)। यह है कि मैं मूल DBConnector वर्ग का काम कैसे प्रस्तुत करता हूं :)

 <?php class DBConnector { private $users; public function query($query) { for ($i=1; $i<=4; $i++) { $this->users[] = array('name' => 'Username' . $i); } } public function get_num_rows() { return count($this->users); } public function fetch_row() { $each = each($this->users); return $each['value']; } } 

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

हम अपने कोड को देखते हैं। पहली बात जो मुझे व्यक्तिगत रूप से प्रभावित करती है, वह है हेडर, डेटाबेस क्वेरी, आउटपुट। हल, रिकॉर्ड और HTML आउटपुट प्राप्त करने पर साझा करें।

 <?php include 'DBConnector.php'; $DB = new DBConnector; $DB->query('SELECT * FROM users LIMIT 10'); if($DB->get_num_rows()){ while($user = $DB->fetch_row()){ $users[] = $user; } } else { $users = array(); } ?> <h1></h1> <? foreach ($users as $user) { echo '<p>'.$user['name'].'</p>'; } ?> 

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

 <?php // index.php include 'DBConnector.php'; $DB = new DBConnector; $DB->query('SELECT * FROM users LIMIT 10'); if($DB->get_num_rows()){ while($user = $DB->fetch_row()){ $users[] = $user; } } else { $users = array(); } include 'index.php.html'; 

 <h1></h1> <? // index.php.html foreach ($users as $user) { echo '<p>'.$user['name'].'</p>'; } ?> 

जांच - ठीक है। कुछ स्मार्ट लोग वही होते हैं जिन्हें हम अब एक नई फ़ाइल में एक दृश्य या दृश्य कहते हैं। लेकिन अब इसके बारे में भूल जाओ। हालाँकि नहीं, हम इसे थोड़ा स्वादिष्ट (स्वाद और रंग के लिए ...) बनाते हैं।

 <h1></h1> <?php foreach ($users as $user): ?> <p><?=$user['name']?></p> <?php endforeach; ?> 

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

 <?php class UserRepository { private $db_connector; public function __construct(DBConnector $db_connector) { $this->db_connector = $db_connector; } public function getAll($limit=10) { $this->db_connector->query("SELECT * FROM users LIMIT {$limit}"); if($this->db_connector->get_num_rows()){ while($user = $this->db_connector->fetch_row()){ $users[] = $user; } } else { $users = array(); } return $users; } } 

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

 <?php require_once 'DBConnector.php'; require_once 'UserRepository.php'; $user_repository = new UserRepository(new DBConnector); $users = $user_repository->getAll(); include 'index.php.html'; 

टेस्ट? ठीक है! (रिफैक्टरिंग के हर चरण पर, आपको परीक्षण चलाने की आवश्यकता है ताकि बाद में "जहाँ आप खराब हो गए थे" की तलाश में लक्ष्यहीन वर्षों तक शर्मिंदा न हों)। यदि हम "सेवा" requ_once को छोड़ देते हैं, तो हमारी स्क्रिप्ट की फ़ाइल तीन पंक्तियों में कम हो गई थी: एक रिपॉजिटरी बनाएं, इसमें से सभी उपयोगकर्ता प्राप्त करें, उन्हें एक दृश्य में प्रदर्शित करें। हेजहोग, यह पहली नजर में शायद स्पष्ट होगा। स्मार्ट लोग इस स्क्रिप्ट को एक नियंत्रक और पतला कहते हैं। खैर यह संदर्भ के लिए है।

हमारे भंडार पर एक और नज़र डालें। किसी की असहमति नहीं है - क्या उन्होंने "उपयोगकर्ता रिपॉजिटरी" वर्ग बनाया है , जिनकी वस्तुएं साहचर्य सरणियों (उर्फ हैश) की एक सरणी लौटाती हैं? यह मेरे लिए पैदा होता है। इसे मूल नाम उपयोगकर्ता के साथ कम से कम ऑब्जेक्ट की एक सरणी पर वापस जाने दें।

  while($user = $this->db_connector->fetch_row()){ $users[] = new User($user); } 

ठीक है, उपयोगकर्ता वर्ग ही, जिसे स्मार्ट लोग डोमेन मॉडल वर्ग या बस मॉडल वर्ग कहते हैं।

 <?php class User { private $name; public function __construct(array $properties) { $this->name = $properties['name']; } public function getName() { return $this->name; } } 

ऑब्जेक्ट की एक सरणी के साथ काम करने के लिए दृश्य बदलें

 <h1></h1> <?php foreach ($users as $user): ?> <p><?= $user->getName() ?></p> <?php endforeach; ?> 

और नियंत्रक के लिए मॉडल वर्ग की घोषणा जोड़ें।

 <?php require_once 'DBConnector.php'; require_once 'User.php'; require_once 'UserRepository.php'; $user_repository = new UserRepository(new DBConnector); $users = $user_repository->getAll(); include 'index.php.html'; 

परीक्षण चलाएं - सब कुछ ठीक है! शायद यह अभी के लिए रुक सकता है। संक्षेप में:

- स्क्रिप्ट का व्यवहार लगभग गारंटी है कि नहीं बदला गया है। कुछ समस्याओं के अलावा, जिसकी उपस्थिति पर हमने ध्यान दिया और दस्तावेज किया। कहाँ? परीक्षण में! परीक्षण मुख्य कोड के लिए दस्तावेज भी है।

- हमारे पास जो दृश्य है वह हर चीज से अलग है, सभी की जरूरत है कि वह उन उपयोगकर्ताओं के लिए है जो उसके नाम में होने के लिए getName () विधि के साथ ऑब्जेक्ट से हैं। हम इसे अलग से परख सकते हैं।

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

- मॉडल ऑब्जेक्ट अनिवार्य रूप से सामान्य रूप से डेटाबेस से स्वतंत्र होते हैं, और वास्तव में कुछ भी नहीं, ये तथाकथित POPO हैं - प्लेन ओल्ड PHP ऑब्जेक्ट्स (फ्लैट पुरानी PHP ऑब्जेक्ट्स)। अब तक, वास्तव में, उनमें कोई तर्क नहीं है, लेकिन जब यह प्रतीत होता है तो इसे बाकी सब चीजों से अलग से भी परीक्षण किया जा सकता है।

- मुख्य स्क्रिप्ट का काम लगभग स्पष्ट है, केवल अंतिम में लगभग कुछ भी शामिल नहीं है, लेकिन मैं पहले से ही इसे एक फ़ंक्शन / विधि के लिए आवंटित करने के लिए बहुत आलसी था।

वास्तुकला की जटिलता को बेहतर बनाने के लिए कोड के साथ और क्या किया जा सकता है:

- डेटाबेस से आगे सार, या सामान्य रूप में भंडारण का प्रकार भी।

- देखने के प्रकार (हमारे शामिल) को अनदेखा करें - आप इसे बिना किसी समस्या के कुछ टेम्पलेट इंजन द्वारा प्रस्तुत कर सकते हैं - स्मार्टी, ट्विग, आदि।

- कंट्रोलर को क्लास का ऑब्जेक्ट भी बनाएं

- फ्रंटकंट्रोलर पैटर्न का उपयोग करें

- आसानी से अन्य तृतीय-पक्ष घटकों (ORM, राउटर, कॉन्फ़िगरेशन, आदि) को संलग्न करें

- कोड को एक फ्रेमवर्क में अनुवाद करें, उदाहरण के लिए Symfony2 :)

- सामान्य परीक्षणों के साथ कवर, मॉड्यूलर (यूनिट) से स्वीकृति तक।

यदि रुचि है, तो यह एक छोटे चक्र में पहला लेख हो सकता है। केवल पहली बार में यह कुछ या कम काम करने के लिए गोवनोकॉड के प्रारंभिक उदाहरण को जटिल करने के लिए चोट नहीं पहुंचाएगा और कम से कम थोड़ा असभ्य और शर्मीली :) अगर कोई भी व्यक्ति है, तो github.com/Vololh/refactor-sample github पर रैप करना होगा