इंटरेक्टर, ऑपरेशन पैटर्न

यह पाठ लारवेल फ्रेमवर्क के लिए हनमी फ्रेमवर्क मैनुअल के एक भाग का रूपांतरण है। इस विशेष सामग्री में रुचि किस कारण हुई? यह प्रोग्रामिंग भाषाओं और रूपरेखाओं के लिए ऐसी सामान्य चीजों के प्रदर्शन के साथ एक चरण-दर-चरण विवरण प्रदान करता है:

• इंटरेक्टर्स पैटर्न का उपयोग करना।
• TDD \ BDD का प्रदर्शन।

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

इसलिए, शुरू में हमारे पास हनमी (माणिक) ढांचा है - एक काफी नया ढांचा जो वैचारिक रूप से सिम्फनी को अधिक प्रभावित करता है, ओआरएम "रिपॉजिटरी पर"। और सक्रिय रिकॉर्ड के साथ लक्ष्य लारवेल \ लुमेन (php) ढांचा।

अनुकूलन की प्रक्रिया में, सबसे तीव्र कोण काट दिए गए थे:

• गाइड के पहले भाग को परियोजना के आरंभीकरण, ढांचे की विशेषताओं और इसी तरह की विशिष्ट चीजों के विवरण के साथ छोड़ दिया गया था।
• ORM एलोकेंट को ग्लोब पर खींचा जाता है और यह भंडार का काम भी करता है।
• ईमेल भेजने के लिए कोड और टेम्प्लेट जनरेट करने के चरण।

सहेजा गया और इस पर जोर दिया गया:

• इंटरेक्टर्स - इंटरफ़ेस पर न्यूनतम उपयुक्त कार्यान्वयन किया गया था।
• टेस्ट, टीडीडी के माध्यम से कदम-दर-चरण विकास।

मूल हनमी ट्यूटोरियल का पहला भाग, जिसे नीचे दिए गए पाठ में संदर्भित किया जाएगा
मूल इंटरएक्टिव ट्यूटोरियल पाठ
पाठ के अंत में अनुकूलित php कोड के साथ रिपॉजिटरी से लिंक करें।

interactor

नई सुविधा: ईमेल सूचनाएं

फीचर परिदृश्य: एक व्यवस्थापक के रूप में, जब मैं एक पुस्तक जोड़ता हूं, तो मैं ईमेल सूचनाएं प्राप्त करना चाहता हूं।

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

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

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

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

वे एकल जिम्मेदारी सिद्धांत के बाद गैर-तुच्छ व्यापार तर्क को अलग करने के लिए उपयोग किया जाता है।

वेब अनुप्रयोगों में, वे आमतौर पर नियंत्रक कार्यों से उपयोग किए जाते हैं। इस तरह से आप अलग-अलग कार्य, व्यावसायिक लॉजिक ऑब्जेक्ट और इंटरेक्टर्स करते हैं; वे एप्लिकेशन के नेटवर्क लेयर के बारे में कुछ भी नहीं जानते हैं।

कॉलबैक? हमें उनकी आवश्यकता नहीं है!

ईमेल अधिसूचना को लागू करने का सबसे आसान तरीका कॉलबैक जोड़ना है।

यही है, डेटाबेस में एक नई पुस्तक प्रविष्टि बनाने के बाद, एक ईमेल भेजा जाता है।

वास्तुकला में, हनमी इस तरह का तंत्र प्रदान नहीं करता है। ऐसा इसलिए है क्योंकि हम मॉडल कॉलबैक को एक विरोधी पैटर्न मानते हैं। वे एकमात्र जिम्मेदारी के सिद्धांत का उल्लंघन करते हैं। हमारे मामले में, वे ईमेल सूचनाओं के साथ दृढ़ता परत को गलत तरीके से मिलाते हैं।

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

इसके बजाय, हम निहित के बजाय स्पष्ट सलाह देते हैं।

इंटरेक्टर एक वस्तु है जो एक विशिष्ट उपयोग के मामले का प्रतिनिधित्व करता है।

वे प्रत्येक वर्ग को एक ही जिम्मेदारी देते हैं। किसी विशेष परिणाम को प्राप्त करने के लिए इंटरेक्टर की एकमात्र जिम्मेदारी ऑब्जेक्ट्स और मेथड कॉल्स को मिलाना है।

विचार

इंटरेक्टर्स का मुख्य विचार यह है कि आप कार्यक्षमता के अलग-अलग हिस्सों को एक नए वर्ग में निकालते हैं।

आपको केवल दो सार्वजनिक तरीके लिखने चाहिए: __construct और call ।
__invoke के php कार्यान्वयन में, कॉल विधि में संरक्षित संशोधक होता है और इसे __invoke माध्यम से बुलाया जाता है।

इसका मतलब यह है कि ऐसी वस्तुओं की व्याख्या करना आसान है, क्योंकि उनके उपयोग के लिए केवल एक ही उपलब्ध तरीका है।

एक वस्तु में व्यवहार को एनकैप्सुलेट करने से परीक्षण करना आसान हो जाता है। यह आपके कोड आधार को समझने में भी आसान बनाता है, और न केवल छिपी हुई जटिलता को स्पष्ट रूप से छोड़ देता है।

ट्रेनिंग

मान लें कि हमारे पास "प्रारंभ करना " बुकशेल्फ़ एप्लिकेशन है, और हम "अतिरिक्त पुस्तक के लिए ईमेल अधिसूचना" सुविधा को जोड़ना चाहते हैं।

इंटरेक्टर लिखना

आइए हमारे इंटरैक्टर्स के लिए एक फोल्डर बनाएं और उनके टेस्ट के लिए एक फोल्डर बनाएं:

 $ mkdir lib/bookshelf/interactors $ mkdir tests/bookshelf/interactors 

हम उन्हें lib/bookshelf में डालते हैं क्योंकि वे वेब एप्लिकेशन से संबंधित नहीं हैं। आप बाद में व्यवस्थापक पोर्टल, एपीआई या यहां तक ​​कि कमांड लाइन उपयोगिता के माध्यम से किताबें जोड़ सकते हैं।

AddBook इंटरएक्टर जोड़ें और एक नया परीक्षण tests/bookshelf/interactors/AddBookTest.php लिखें tests/bookshelf/interactors/AddBookTest.php :

 # tests/bookshelf/interactors/AddBookTest.php <?php use Lib\Bookshelf\Interactors\AddBook; class AddBookTest extends TestCase { private function interactor() { return $this->app->make(AddBook::class); } private function bookAttributes() { return [ "author" => "James Baldwin", 'title' => "The Fire Next Time", ]; } private function subjectCall() { return $this->interactor()($this->bookAttributes()); } public function testSucceeds() { $result = $this->subjectCall(); $this->assertTrue($result->successful()); } } 

टेस्ट सूट चलाने से Class does not exist एरर Class does not exist होगा क्योंकि AddBook क्लास नहीं है। आइए इस वर्ग को फ़ाइल lib/bookshelf/interactors/AddBook.php :

 <?php namespace Lib\Bookshelf\Interactors; use Lib\Interactor\Interactor; class AddBook { use Interactor; public function __construct() { } protected function call() { } } 

इस कक्षा में केवल दो विधियाँ होनी चाहिए: __construct डेटा को सेट करने और स्क्रिप्ट को लागू करने के लिए call करना।

इन विधियों, विशेष रूप से call , को निजी तरीकों को कॉल करना चाहिए जो आप लिखते हैं।

डिफ़ॉल्ट रूप से, परिणाम सफल माना जाता है, क्योंकि हमने स्पष्ट रूप से संकेत नहीं दिया था कि ऑपरेशन विफल हो गया है।

चलो परीक्षण चलाते हैं:

 $ phpunit 

सभी टेस्ट पास करने होंगे!

अब, चलो हमारे AddBook इंटरएक्टर वास्तव में कुछ करते हैं!

पुस्तक निर्माण

tests/bookshelf/interactors/AddBookTest.php :

  public function testCreateBook() { $result = $this->subjectCall(); $this->assertEquals("The Fire Next Time", $result->book->title); $this->assertEquals("James Baldwin", $result->book->author); } 

यदि आप phpunit परीक्षण चलाते हैं, तो आपको एक त्रुटि दिखाई देगी:

 Exception: Undefined property Lib\Interactor\InteractorResult::$book 

चलो हमारे अंतःक्रिया को भरें, फिर समझाएं कि हमने क्या किया:

 <?php namespace Lib\Bookshelf\Interactors; use Lib\Interactor\Interactor; use Lib\Bookshelf\Book; class AddBook { use Interactor; protected static $expose = ["book"]; private $book = null; public function __construct() { } protected function call($bookAttributes) { $this->book = new Book($bookAttributes); } } 

यहां ध्यान देने योग्य दो महत्वपूर्ण बातें:

स्ट्रिंग protected static $expose = ["book"]; book संपत्ति को परिणाम वस्तु में जोड़ता है जो इंटरेक्टर को बुलाए जाने पर वापस कर दिया जाएगा।

call विधि Book मॉडल को book संपत्ति को असाइन करती है, जो परिणामस्वरूप उपलब्ध होगी।

अब टेस्ट पास होने चाहिए।

हमने Book मॉडल को इनिशियलाइज़ किया है, लेकिन यह डेटाबेस में संग्रहीत नहीं है।

सेविंग बुक

हमारे पास एक नई पुस्तक है, जिसे शीर्षक और लेखक से प्राप्त किया गया है, लेकिन यह अभी तक डेटाबेस में नहीं है।

हमें इसे सहेजने के लिए अपनी BookRepository - BookRepository का उपयोग करने की आवश्यकता है।

 // tests/bookshelf/interactors/AddBookTest.php public function testPersistsBook() { $result = $this->subjectCall(); $this->assertNotNull($result->book->id); } 

यदि आप परीक्षण चलाते हैं, तो आपको संदेश के साथ एक नई त्रुटि दिखाई देगी Failed asserting that null is not null ।

ऐसा इसलिए है क्योंकि हमारे द्वारा बनाई गई पुस्तक में पहचानकर्ता नहीं है, क्योंकि यह केवल तभी प्राप्त होगा जब इसे सहेजा जाएगा।

परीक्षा पास करने के लिए, हमें एक सहेजी गई पुस्तक बनाने की आवश्यकता है। दूसरा, कोई कम सही तरीका उस पुस्तक को सहेजना नहीं है जो हमारे पास पहले से है।

lib/bookshelf/interactors/AddBook.php में call विधि संपादित करें:

 protected function call($bookAttributes) { $this->book = Book::create($bookAttributes); } 

new Book को कॉल करने के बजाय, हम Book::create पुस्तक की विशेषताओं के साथ Book::create ।

विधि अभी भी पुस्तक लौटाती है, और डेटाबेस में इस रिकॉर्ड को भी सहेजती है।

यदि आप अब परीक्षण चलाते हैं, तो आप देखेंगे कि सभी परीक्षण पास हो गए हैं।

निर्भरता इंजेक्शन

आइए रिफ्लेक्टर पर निर्भरता इंजेक्शन का उपयोग करें।

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

हम अपने परीक्षण और इंटरेक्टर को अधिक विश्वसनीय बनाने के लिए इसे संशोधित कर सकते हैं: इसकी फ़ाइल के बाहर होने वाले परिवर्तनों के कारण इसका टूटना कम होगा।

यहां बताया गया है कि हम इंटरप्रेटर में निर्भरता इंजेक्शन का उपयोग कैसे कर सकते हैं:

 // lib/bookshelf/interactors/AddBook.php public function __construct(Book $repository) { $this->repository = $repository; } protected function call($bookAttributes) { $this->book = $this->repository->create($bookAttributes); } 

अनिवार्य रूप से, यह एक ही है, थोड़ा और अधिक कोड के साथ, एक repository संपत्ति बनाने के लिए।

अभी, परीक्षण यह create तरीके के व्यवहार की जांच करता है ताकि यह सुनिश्चित किया जा सके कि इसकी पहचानकर्ता $this->assertNotNull($result->book->id) से भरा हुआ $this->assertNotNull($result->book->id) ।

यह एक कार्यान्वयन विवरण है।

इसके बजाय, हम परीक्षण को केवल यह सुनिश्चित करने के लिए संशोधित कर सकते हैं कि create विधि रिपॉजिटरी पर कॉल की गई थी, और यह विश्वास करने के लिए कि रिपॉजिटरी ऑब्जेक्ट को बचाएगा (चूंकि यह इसकी जिम्मेदारी है)।

आइए testPersistsBook परीक्षण बदलें:

 // tests/bookshelf/interactors/AddBookTest.php public function testPersistsBook() { $repository = Mockery::mock(Book::class); $this->app->instance(Book::class, $repository); $attributes = [ "author" => "James Baldwin", 'title' => "The Fire Next Time", ]; $repository->expects()->create($attributes); $this->subjectCall($attributes); } 

अब हमारा परीक्षण इसके क्षेत्र की सीमाओं का उल्लंघन नहीं करता है।

हमने जो भी किया वह रिपॉजिटरी पर इंटरप्रेटर निर्भरता को जोड़ दिया था।

ईमेल अधिसूचना

चलो एक ईमेल अधिसूचना जोड़ें!

आप यहां कुछ भी कर सकते हैं, उदाहरण के लिए, एसएमएस भेजें, चैट संदेश भेजें या वेब हुक सक्रिय करें।

हम संदेश बॉडी को खाली छोड़ देंगे, लेकिन विषय क्षेत्र में हम "बुक एड!" इंगित करेंगे।

एक अधिसूचना परीक्षण tests/bookshelf/mail/BookAddedNotificationTest.php :

 <?php use Lib\Bookshelf\Mail\BookAddedNotification; use Illuminate\Support\Facades\Mail; class BookAddedNotificationTest extends TestCase { public function setUp() { parent::setUp(); Mail::fake(); $this->mail = new BookAddedNotification(); } public function testCorrectAttributes() { $this->mail->build(); $this->assertEquals('no-reply@example.com', $this->mail->from[0]['address']); $this->assertEquals('admin@example.com', $this->mail->to[0]['address']); $this->assertEquals('Book added!', $this->mail->subject); } } 

अधिसूचना वर्ग lib/Bookshelf/Mail/BookAddedNotification.php जोड़ें।

 <?php namespace Lib\Bookshelf\Mail; use Illuminate\Mail\Mailable; use Illuminate\Queue\SerializesModels; class BookAddedNotification extends Mailable { use SerializesModels; public function build() { $this->from('no-reply@example.com') ->to('admin@example.com') ->subject('Book added!'); return $this->view('emails.book_added_notification'); } } 

अब हमारे सारे टेस्ट पास हो गए!

लेकिन अधिसूचना अभी तक नहीं भेजी गई है। हमें अपने AddBook इंटरेक्टर से AddBook भेजने की आवश्यकता है।

AddBook यह सुनिश्चित करने के लिए AddBook परीक्षण AddBook कि मेलर को बुलाया जाएगा:

 public function testSendMail() { Mail::fake(); $this->subjectCall(); Mail::assertSent(BookAddedNotification::class, 1); } 

यदि हम परीक्षण चलाते हैं, तो हमें त्रुटि मिलती है: The expected [Lib\Bookshelf\Mail\BookAddedNotification] mailable was sent 0 times instead of 1 times. ।

अब हम इंटरएक्टर में सूचना भेजने को एकीकृत करते हैं।

 public function __construct(Book $repository, BookAddedNotification $mail) { $this->repository = $repository; $this->mail = $mail; } protected function call($bookAttributes) { $this->book = $this->repository->create($bookAttributes); Mail::send($this->mail); } 

परिणामस्वरूप, इंटरेक्टर ईमेल में पुस्तक जोड़ने के बारे में एक सूचना भेजेगा।

नियंत्रक एकीकरण

अंत में, हमें इंटरैक्शनर को कार्रवाई से कॉल करने की आवश्यकता है।

एक्शन फ़ाइल app/Http/Controllers/BooksCreateController.php संपादित करें:

 <?php namespace App\Http\Controllers; use Lib\Bookshelf\Interactors\AddBook; use Illuminate\Http\Request; use Illuminate\Http\Response; class BooksCreateController extends Controller { /** * Create a new controller instance. * * @return void */ public function __construct(AddBook $addBook) { $this->addBook = $addBook; } public function call(Request $request) { $input = $request->all(); ($this->addBook)($input); return (new Response(null, 201)); } } 

हमारे परीक्षण पास हो जाते हैं, लेकिन एक छोटी सी समस्या है।

हम पुस्तक निर्माण कोड का दो बार परीक्षण करते हैं।

यह आमतौर पर एक बुरा अभ्यास है, और हम इसे इंटरैक्टर्स के एक अन्य लाभ को दिखाते हुए ठीक कर सकते हैं।

हम परीक्षण में BookRepository पर उल्लेख को हटाने जा रहे हैं और हमारे AddBook इंटरेक्टर के लिए मॉक का उपयोग करें:

 <?php use Lib\Bookshelf\Interactors\AddBook; class BooksCreateControllerTest extends TestCase { public function testCallsInteractor() { $attributes = ['title' => '1984', 'author' => 'George Orwell']; $addBook = Mockery::mock(AddBook::class); $this->app->instance(AddBook::class, $addBook); $addBook->expects()->__invoke($attributes); $response = $this->call('POST', '/books', $attributes); } } 

अब हमारे परीक्षण पास हो गए हैं और वे बहुत अधिक विश्वसनीय हैं!

कार्रवाई इनपुट (http अनुरोध के मापदंडों से) लेती है और इंटरेक्टर को अपना काम करने के लिए बुलाती है। कार्रवाई की एकमात्र जिम्मेदारी नेटवर्क के साथ काम कर रही है। और इंटरएक्टर हमारे वास्तविक व्यापार तर्क के साथ काम करता है।

यह क्रियाओं और उनके परीक्षणों को बहुत सरल करता है।

व्यवहार को व्यावसायिक तर्क से छूट दी गई है।

जब हम सहभागिता को संशोधित करते हैं, तो हमें कार्रवाई या उसके परीक्षण को बदलने की आवश्यकता नहीं होती है।

ध्यान दें कि एक वास्तविक अनुप्रयोग में, आप संभवतः उपरोक्त तर्क से अधिक करना चाहते हैं, उदाहरण के लिए सुनिश्चित करें कि परिणाम सफल है। और यदि कोई विफलता होती है, तो आप इंटरैक्टर से त्रुटियों को वापस करना चाहेंगे।

कोड के साथ भंडार