लारवेल: व्यवहार में निर्भरता इंजेक्शन

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

परिचय

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

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

कार्यान्वयन

एसएमएस के लिए सभी वर्गों मैं फ़ोल्डर में डाल दिया जाएगा `app \ Acme \ Sms` और संगीतकार .json में PSR-0 के तहत रजिस्टर:

"psr-0": { "Acme": "app" } 

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

 <?php namespace Acme\Sms; interface SmsGateInterface { /** * @param SmsRecipient $recipient * @param string $text */ public function send(SmsRecipient $recipient, $text); } 

अभी के लिए, हमें केवल 1 भेजने की विधि चाहिए, जो SMS भेजेगा। `SmsRecipient` वर्ग प्राप्तकर्ता द्वारा डेटा संग्रहीत करता है:

 <?php namespace Acme\Sms; class SmsRecipient { public $phone; } 

संगीतकार में SmsOnline प्रदाता के साथ काम करने के लिए कक्षा निर्धारित करें:

 "require": { "laravel/framework": "4.0.*", "kkamkou/sms-online-api": "dev-master" } 

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

 <?php namespace Acme\Sms; use SmsOnline\Api as SmsOnlineApi; class SmsOnlineGate implements SmsGateInterface { private $api; public function __construct(SmsOnlineApi $api) { $this->api = $api; } /** * @param SmsRecipient $recipient * @param string $text */ public function send(SmsRecipient $recipient, $text) { $this->api->send($recipient->phone, $text); } } 

लेकिन `SmsOnline \ Api 'वर्ग के DI को लागू करना इतना आसान है, क्योंकि `SmsOnline \ Api 'वर्ग का निर्माण विन्यास के साथ एक सरणी को स्वीकार करता है। हमारे एसएमएस घटक (`एप्लिकेशन / कॉन्फ़िगरेशन / sms.php`) के लिए एक कॉन्फ़िगरेशन फ़ाइल बनाएं, और उसी समय डिफ़ॉल्ट ड्राइवर` SmsOnlineGate` डालें:

 <?php return [ 'default' => 'Acme\Sms\SmsOnlineGate', 'drivers' => [ 'Acme\Sms\SmsOnlineGate' => [ 'user' => '', 'secret_key' => '', ], ], ]; 

अब यह IoC पर निर्भर है। फ़ाइल बनाएँ `app / bindings.php`, जहाँ हम IoC कॉन्फ़िगर करेंगे:

 <?php $smsConfig = Config::get('sms'); $smsGate = $smsConfig['default']; App::bind('Acme\Sms\SmsGateInterface', $smsGate); 

हम डिफ़ॉल्ट एसएमएस ड्राइवर प्राप्त करते हैं और आईओसी को बताते हैं कि जब आवेदन `SmsGateInterface` चाहता है तो इसे` SmsOnlineGate` दें। वैसे, यदि आप संस्करण 5.5 से पहले ही PHP हैं, तो मैं निम्नानुसार कोड को फिर से लिखने की सलाह देता हूं:

app / config / sms.php

 <?php use Acme\Sms\SmsOnlineGate; return [ 'default' => SmsOnlineGate::class, 'drivers' => [ SmsOnlineGate::class => [ 'user' => '', 'secret_key' => '', ], ], ]; 

app / bindings.php

 <?php use Acme\Sms\SmsGateInterface; $smsConfig = Config::get('sms'); $smsGate = $smsConfig['default']; App::bind(SmsGateInterface::class, $smsGate); 

यह सुविधाजनक है क्योंकि रिफैक्टरिंग के दौरान हम आसानी से वर्ग के नाम बदल सकते हैं, और IDE, बदले में, इन पंक्तियों को सम्मिलित रूप से बदल देता है।
इसके बाद, हमें ऐप / bindings.php को जोड़कर `SmsOnline \ Api` के लिए कॉन्फ़िगरेशन सेट करना होगा

 <?php use Acme\Sms\SmsGateInterface; use Acme\Sms\SmsOnlineGate; //    $smsConfig = Config::get('sms'); $smsGate = $smsConfig['default']; App::bind(SmsGateInterface::class, $smsGate); //   "SmsOnline" App::bind(SmsOnline\Api::class, function ($app) { $gateConfig = Config::get('sms'); $gateConfig = $gateConfig['drivers'][SmsOnlineGate::class]; return new SmsOnline\Api($gateConfig); }); 

अब जब एप्लिकेशन को वर्ग की एक वस्तु की आवश्यकता होती है `SmsOnline \ Api` - यह एक कॉन्फ़िगर उदाहरण प्राप्त करेगा।

अपने एप्लिकेशन में इस डिज़ाइन का उपयोग करते हुए, आप आसानी से प्रदाताओं के बीच स्विच कर सकते हैं - आपको इसके लिए केवल एक ड्राइवर लिखने और कॉन्फ़िगरेशन को बदलने की आवश्यकता है, उदाहरण के लिए, विकास के दौरान हम प्रदाता के माध्यम से एसएमएस नहीं भेजना चाहते हैं, इसलिए हम डेटाबेस में या यहां तक ​​कि कहीं भी लिख सकते हैं। फ़ाइल। ऐसा करने के लिए, हम ड्राइवरों को एक ही सिद्धांत पर `DatabaseSmsGate` और` FileSmsGate` लिखेंगे। यह सबसे "स्वादिष्ट भाग" पर जाने का समय है - परीक्षणों के साथ कोड को कवर करना।

परीक्षण

वास्तव में, यह डीआई में मुख्य प्लस है: पूर्ण अलगाव में सुविधाजनक परीक्षण। काम के तरीकों के साथ वास्तविक वस्तुओं को चूसने के बजाय - परीक्षणों में आप स्टब विधियों के साथ मॉक ऑब्जेक्ट बनाते हैं और सत्यापित करते हैं कि विधि को अपेक्षित तर्कों के साथ और विशिष्ट क्रम में n बार कहा गया था। आइए देखें कि ऊपर लिखे हमारे कोड का परीक्षण कैसे किया जाए।

पहले मुझे phpunit और mockery को स्थापित करने की आवश्यकता है। मैंने इसे संगीतकार के माध्यम से भी डाला:

 "require-dev": { "phpunit/phpunit": "3.8.*@dev", "mockery/mockery": "dev-master" } 

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

 <?php use Acme\Sms\SmsOnlineGate; use Acme\Sms\SmsRecipient; class SmsOnlineGateTest extends TestCase { /** * @var SmsOnline\Api */ private $api; /** * @var SmsOnlineGate */ private $gate; /** * @var SmsRecipient */ private $recipient; public function setUp() { parent::setUp(); $this->api = Mockery::mock(SmsOnline\Api::class)->makePartial(); $this->recipient = Mockery::mock(SmsRecipient::class); $this->gate = new SmsOnlineGate($this->api); } public function test_send() { $text = ' '; $this->api->shouldReceive('send') ->withArgs([$this->recipient->phone, $text]) ->once(); $this->gate->send($this->recipient, $text); } } 

परीक्षण यह है कि हम सत्यापित करते हैं कि `SmsOnline \ Api` में भेजने की विधि वास्तव में आवश्यक मापदंडों के साथ एक बार कॉल की गई थी। दरअसल, इसे बुलाया नहीं गया था, इसके बजाय हमारी मॉक ऑब्जेक्ट से एक विधि को बुलाया गया था, और मॉकरी ने हमें इसके साथ मदद की।
हमें यह सुनिश्चित करने के लिए एक और परीक्षण की आवश्यकता है कि जब आवेदन `SmsGateInterface` प्राप्त करना चाहता है, तो IoC हमें` SmsOnlineGate` लौटाता है, क्योंकि यह हमारे डिफ़ॉल्ट कॉन्फ़िगरेशन में पंजीकृत है:

 <?php use Acme\Sms\SmsGateInterface; use Acme\Sms\SmsOnlineGate; class SmsGateTest extends TestCase { public function test_instance() { $instance = App::make(SmsGateInterface::class); $this->assertInstanceOf(SmsOnlineGate::class, $instance); } } 

---

वह सब मैं बताना चाहता था। यहाँ मैंने ServiceProvider के माध्यम से IoC में वस्तुओं को इंजेक्ट करने पर विचार नहीं किया, जो कि अधिक सही समाधान है।
मुझे आशा है कि मैंने एसएमएस भेजने वाले घटक के उदाहरण का उपयोग करके डीआई और आईओसी के लाभों के बारे में अपना दृष्टिकोण विस्तृत किया है। याद रखें कि विकास मज़ेदार होना चाहिए, और आपको एक कलाकार की तरह महसूस करना चाहिए जो एक उत्कृष्ट आंतरिक संरचना के साथ एक तंत्र खींचता है। यदि आपके पास अभी भी प्रश्न हैं - टिप्पणियों में पूछें, तो मुझे उन्हें जवाब देने में खुशी होगी।

---

उपयोगी साहित्य की सूची:

• निर्भरता इंजेक्शन क्या है? लेखक फैबियन पोटेंसीयर
• लारवेल IoC कंटेनर प्रलेखन
• मॉकरी : एक बेहतर तरीका नेटट्स +
• लारवेल टेस्टिंग डिकोडेड , जेफरी वे द्वारा लिखित टीडीडी और यूनिट टेस्टिंग बेस्ट प्रैक्टिस का सबसे अच्छा परिचय है। न केवल लारवेल पर लागू होता है।
• PSR-0 मानक विवरण
• लारवेल: फ्रॉम अपरेंटिस टू आर्टिसन , लारवेल फ्रेमवर्क के लेखक टेलर ओटवेल द्वारा लिखित एप्लीकेशन आर्किटेक्चर डिजाइन और लारवेल क्षमताओं पर आधारित एक पुस्तक है।
• लराकास्ट्स - लारवेल वीडियो ट्यूटोरियल। नए लगभग हर दिन दिखाई देते हैं। वहाँ मुफ्त वाले हैं, और केवल $ 9 प्रति माह की सदस्यता है।