🤰🏽 🐔 👆🏼 Symfony2 निर्भरता इंजेक्शन गाइड 🏧 🛢️ 🤳🏾

यह आलेख निर्भरता इंजेक्शन पैटर्न का उपयोग करके एक सरल ब्लॉग साइट बनाने का एक उदाहरण प्रदान करता है। दृष्टिकोण सभी संभव सिम्फनी घटकों में निर्भरता की शुरूआत के साथ लागू किया जाता है: नियंत्रक, सिद्धांत प्रतिकृतियां, रूप।

लेख को सरल बनाने के लिए, साइट पर पृष्ठों की संख्या को दो तक कम करें:

एक नया पोस्ट जोड़ना (/ जोड़ना)
सभी पदों की सूची (/ सूची)

आवेदन की अंतिम वास्तुकला इस तरह दिखाई देगी:

चरण 1. एक मनमानी सेवा बनाना

सिम्फनी के हिस्से के रूप में DI को पहले से ही एक हब पर माना जाता था, और प्रलेखन में वर्णित विस्तार से भी है। इसलिए, हम तुरंत अपनी सेवाएं और निर्भरता बनाना शुरू कर देंगे। ऐसा करने के तीन तरीके हैं: कॉन्फ़िगरेशन फ़ाइलों (YAML, XML, PHP) के माध्यम से बंडल कोड में निर्भरता को परिभाषित करना और एनोटेशन का उपयोग करना ( JMSDiExtraBundle बंडल का उपयोग करना, जो कि सिम्फनी पर मानक है)। प्रत्येक विधि के पेशेवरों और विपक्ष हैं। हम कोड की मात्रा को कम करने और कम करने के लिए एनोटेशन का उपयोग करेंगे। आइए एक ऐसे वर्ग से शुरू करें जो व्यावसायिक तर्क को लागू करता है। इसे पोस्टमैनेजर के रूप में एक नई पोस्ट के अलावा संभालने दें:

/src/AppBundle/Manager/PostManager.php

<?php namespace AppBundle\Manager; use JMS\DiExtraBundle\Annotation as DI; use AppBundle\Entity\Post; use AppBundle\Entity\User; /** * @DI\Service("app.manager.post", public=false) */ class PostManager { /** * @DI\Inject("doctrine.orm.entity_manager") * @var \Doctrine\ORM\EntityManager */ public $em; public function addPost(Post $post, User $user) { $post->setAuthor($user); $this->em->persist($post); $user->setLastPost($post); $user->increasePostsCount(); $this->em->flush(); } }

@DI \ _ सेवा - एक वर्ग को सेवा में बदल देती है। एनोटेशन पैरामीटर सेवा का नाम (app.manager.post) और उसकी विशेषताओं का संकेत देते हैं।
public = false - यह विशेषता इंगित करती है कि बनाई गई सेवा को सीधे DIC से नहीं बुलाया जा सकता है ($ कंटेनर-> get ('app.manager.post') के परिणामस्वरूप त्रुटि होगी)। बनाई गई सेवा का उपयोग केवल उन सेवाओं द्वारा किया जा सकता है जो इस पर स्पष्ट रूप से निर्भर करते हैं (आगे, नियंत्रक के साथ उदाहरण का उपयोग करके, यह स्पष्ट हो जाएगा)।
@DI \ Inject - उन सेवाओं का एक संकेत, जिस पर बनाई गई सेवा निर्भर करती है। इस एनोटेशन का उपयोग केवल सार्वजनिक प्रकार के चर के साथ ही संभव है। निजी / संरक्षित निर्भरता चर के लिए, आप निर्माण करने के लिए @DI \ InjectParams या सेवाओं को बनाने के अन्य तरीकों का उपयोग कर सकते हैं।

इसलिए, हमने app.manager.post सेवा बनाई है, जो doctrine.orm.entity_manager पर निर्भर करती है :

सेवाओं और कनेक्शनों का एक ग्राफिकल प्रदर्शन JMSDebuggingBundle की स्थापना के साथ एक सुविधाजनक वेब इंटरफेस में उपलब्ध है।

चरण 2. एक नियंत्रक बनाना

डिफ़ॉल्ट रूप से, सिम्फनी में, नियंत्रक सेवा नहीं हैं, लेकिन उन्हें बनाने के लिए दस्तावेज में एक नोट है। पहले बनाए गए PostManager का उपयोग करके एक PostController बनाएं:

/src/AppBundle/Controller/PostController.php

 <?php namespace AppBundle\Controller; use JMS\DiExtraBundle\Annotation as DI; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template; use JMS\SecurityExtraBundle\Annotation\Secure; use Symfony\Bundle\FrameworkBundle\Controller\Controller; use AppBundle\Entity\Post; use AppBundle\Form\PostType; /** * @DI\Service("app.controller.post", scope="request") * @Route(service="app.controller.post") */ class PostController extends Controller { /** * @DI\Inject("service_container") */ public $container; /** * @DI\Inject("app.manager.post") * @var \AppBundle\Manager\PostManager */ public $postManager; /** * @Route("/add", name="post_add") * @Template * @Secure(roles="ROLE_USER") */ public function addAction() { $post = new Post(); $form = $this->createForm(new PostType(), $post); if ($this->getRequest()->getMethod() == 'POST') { $form->bind($this->getRequest()); if ($form->isValid()) { $this->postManager->addPost($post, $this->getUser()); return $this->redirect($this->generateUrl('post_list')); } } return array( 'form' => $form->createView() ); } }

गुंजाइश = "अनुरोध" - यह विशेषता प्रलेखन में विस्तार से वर्णित है
@Rute (सेवा = "app.controller.post") - रूटिंग सिस्टम को बताता है कि इस नियंत्रक का उपयोग सेवा के रूप में किया जाता है। इस स्थिति में, अग्रेषण नियमों के स्ट्रिंग मान 'AppBundle: Post: add' से 'app.controller.post:addAction' में बदल जाएंगे।
@DI \ Inject ("service_container") निर्भरता का उपयोग करके पेरेंट कंट्रोलर क्लास Symfony \ बंडल \ FrameworkBundle \ नियंत्रक \ नियंत्रक की आवश्यकता है। आवश्यक रूप से एक मानक नियंत्रक से व्युत्पन्न किसी भी वर्ग को नियंत्रक के रूप में अनुमति नहीं दी जाती है - इस मामले में, डीआईसी निर्भरता को समाप्त किया जा सकता है।

इस प्रकार, हमने service_container और app.manager.post के आधार पर सेवा app.controller.post बनाया:

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

स्टेप 3. एक फॉर्म बनाएं

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

/src/AppBundle/Form/PostType.php

 <?php namespace AppBundle\Form; use JMS\DiExtraBundle\Annotation as DI; /** * @DI\Service("app.form.post", public=false) */ class PostType extends AbstractType { /* ... */ }

हम नियंत्रक में बनाई गई सेवा का उपयोग करेंगे:

/src/AppBundle/Controller/PostController.php

 /* ... */ class PostController extends Controller { /** * @DI\Inject("app.form.post") * @var \AppBundle\Form\PostType */ public $postType; public function addAction() { $post = new Post(); $form = $this->createForm($this->postType, $post); /* ... */ } }

अब हम फॉर्म और कंट्रोलर के कनेक्शन का पता लगा सकते हैं:

चरण 4. एक भंडार बनाना

पहला तरीका: कारखाना निर्माण

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

/src/AppBundle/Entity/Post.php

 <?php namespace AppBundle\Entity; use Doctrine\ORM\Mapping as ORM; /** * @ORM\Table() * @ORM\Entity(repositoryClass="AppBundle\Repository\PostRepository") */ class Post { /* ... */ }

पदों की सूची प्राप्त करने के लिए एक PostRepository बनाएँ:

/src/AppBundle/Repository/PostRepository.php

 <?php namespace AppBundle\Repository; use Doctrine\ORM\EntityRepository; use Doctrine\ORM\Tools\Pagination\Paginator; class PostRepository extends EntityRepository { public function getListPaginator($first, $max) { $qb = $this->createQueryBuilder('p') ->orderBy('p.id', 'DESC') ->setFirstResult($first) ->setMaxResults($max); return new Paginator($qb->getQuery()); } }

एप्लिकेशन . repository.post सेवा के रूप में बनाए गए वर्ग को परिभाषित करें:

/src/AppBundle/Resources/config/services.yml

 services: app.repository.post: class: AppBundle\Repository\PostRepository factory_service: doctrine.orm.entity_manager factory_method: getRepository public: false arguments: [AppBundle\Entity\Post]

नियंत्रक में रिपॉजिटरी और सूची पृष्ठ जोड़ें:

/src/AppBundle/Controller/PostController.php

 /* ... */ class PostController extends Controller { /** * @DI\Inject("app.repository.post") * @var \AppBundle\Repository\PostRepository */ public $postRepository; protected $itemsPerPage = 10; /** * @Route("/list/{page}", requirements={"page"="\d+"}, defaults={"page"=1}, name="post_list") * @Template */ public function listAction($page) { $posts = $this->postRepository->getListPaginator( $first = ($page-1)*$this->itemsPerPage, $max = $this->itemsPerPage ); return array( 'posts' => $posts, 'page' => $page, 'pagesCount' => ceil(count($posts)/$this->itemsPerPage), ); } /* ... */ }

दूसरा तरीका: रैपर रिपोजिटरी बनाना

यह विधि एडेप्टर पैटर्न का उपयोग करती है। मानक डॉक्ट्रिन रिपॉजिटरी हमारी अपनी सेवा रिपॉजिटरी में शामिल है। पहली विधि के विपरीत, सब कुछ एनोटेशन द्वारा कार्यान्वित किया जाता है।
डॉक्ट्रिन संस्था की फाइल में, हम रिपॉजिटरी इंडिकेशन को हटाते हैं:

src / AppBundle / Entity / Post.php

 <?php namespace AppBundle\Entity; use Doctrine\ORM\Mapping as ORM; /** * @ORM\Table() * @ORM\Entity() */ class Post { /* ... */ }

हमें मूल वर्ग रिपॉजिटरी की आवश्यकता होगी, जो doctrine.orm.entity_manager पर निर्भर करेगा और आवश्यक रिपॉजिटरी कार्यों को लागू करेगा। ऐसा करने के लिए, हम सेवाओं की विरासत का उपयोग करते हैं :

/src/AppBundle/Repository/Repository.php

 <?php namespace AppBundle\Repository; use JMS\DiExtraBundle\Annotation as DI; /** * @DI\Service("app.repository", abstract=true) */ class Repository { /** * @DI\Inject("doctrine.orm.entity_manager") * @var \Doctrine\ORM\EntityManager */ public $em; protected $repositoryName; /** @return \Doctrine\ORM\EntityRepository */ protected function getDoctrineRepository() { return $this->em->getRepository($this->repositoryName); } public function find($id) { return $this->getDoctrineRepository()->find($id); } public function findOneBy(array $criteria) { return $this->getDoctrineRepository()->findOneBy($criteria); } public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null) { return $this->getDoctrineRepository()->findBy($criteria, $orderBy, $limit, $offset); } public function findAll() { return $this->getDoctrineRepository()->findAll(); } /** @return \Doctrine\ORM\QueryBuilder */ public function createQueryBuilder($alias) { return $this->getDoctrineRepository()->createQueryBuilder($alias); } }

सेवा परिभाषा अब रैपर रिपॉजिटरी वर्ग में ही होगी:

/src/AppBundle/Repository/PostRepository.php

 <?php namespace AppBundle\Repository; use JMS\DiExtraBundle\Annotation as DI; use Doctrine\ORM\Tools\Pagination\Paginator; /** * @DI\Service("app.repository.post", parent="app.repository", public=false) */ class PostRepository extends Repository { protected $repositoryName = 'AppBundle:Post'; public function getListPaginator($first, $max) { $qb = $this->createQueryBuilder('p') ->orderBy('p.id', 'DESC') ->setFirstResult($first) ->setMaxResults($max); return new Paginator($qb->getQuery()); } }

नोट: एनोटेशन का उपयोग करते समय, माता-पिता को निर्दिष्ट करना = "app.repository" पैरामीटर वैकल्पिक है। JMSDiExtraBundle मूल श्रेणी के आधार पर, इसे स्वचालित रूप से प्रतिस्थापित करता है।

दोनों विधियां समान कार्यक्षमता को लागू करती हैं और विनिमेय हैं। इसलिए, नियंत्रक कोड नहीं बदलेगा:

/src/AppBundle/Controller/PostController.php

 /* ... */ class PostController extends Controller { /** * @DI\Inject("app.repository.post") * @var \AppBundle\Repository\PostRepository */ public $postRepository; protected $itemsPerPage = 10; /** * @Route("/list/{page}", requirements={"page"="\d+"}, defaults={"page"=1}, name="post_list") * @Template */ public function listAction($page) { $posts = $this->postRepository->getListPaginator( $first = ($page-1)*$this->itemsPerPage, $max = $this->itemsPerPage ); return array( 'posts' => $posts, 'page' => $page, 'pagesCount' => ceil(count($posts)/$this->itemsPerPage), ); } /* ... */ }

परिणामस्वरूप, आवेदन का निर्भरता ग्राफ निम्नलिखित रूप लेगा:

इस दृष्टिकोण के साथ कनेक्शन को नियंत्रित करने के लिए, आपको नियम का पालन करना चाहिए:

चरण 5. अनुकूलन

जैसा कि आप पहले ही देख चुके हैं, किसी सेवा की सभी निर्भरताएं इसके चर हैं और इस सेवा के निर्माण के साथ बनाई गई हैं। बदले में, निर्भरताएं बनाते समय, उनकी निर्भरताएं बनाई जाती हैं, इस प्रकार अप्रयुक्तता के सभी तत्व बनाए जाते हैं, जिसमें अप्रयुक्त भी शामिल हैं। App.controller.post उदाहरण का उपयोग करते हुए, हम देखते हैं कि addAction फ़ंक्शन app.manager.post और app.form.post का उपयोग करता है, और listAction app.repository.post का उपयोग करता है। लेकिन जब नियंत्रक बनाया जाता है, तो सभी चर बनाए जाते हैं, इसलिए, कोई फर्क नहीं पड़ता कि हम किस फ़ंक्शन को कॉल करते हैं, कुछ चर अप्रयुक्त होंगे: addAction के मामले में, यह app.repository.post है, listAction, app.manager.post और app.form.post के मामले में। यह वर्ग, जैसा कि यह था, इसमें दो स्वतंत्र हिस्से शामिल हैं, जिसमें यह कहा जाता है कि इसकी कनेक्टिविटी कम है । एक विधि जितनी अधिक तरीकों से काम करती है, उतनी ही अधिक विधि इस वर्ग से जुड़ती है। एक वर्ग जिसमें प्रत्येक विधि द्वारा प्रत्येक चर का उपयोग किया जाता है, अधिकतम कनेक्टिविटी होती है। अधिकतम कनेक्टिविटी के साथ कक्षाएं बनाना हमेशा संभव नहीं होता है, लेकिन हमारे मामले में app.controller.post को दो स्वतंत्र कक्षाओं में विभाजित करके हासिल करना आसान है:

निष्कर्ष

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

कार्य स्रोतों को यहाँ डाउनलोड / देखा जा सकता है:
github.com/cerritus/demoblog

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

चरण 1. एक मनमानी सेवा बनाना

चरण 2. एक नियंत्रक बनाना

स्टेप 3. एक फॉर्म बनाएं

चरण 4. एक भंडार बनाना

पहला तरीका: कारखाना निर्माण

दूसरा तरीका: रैपर रिपोजिटरी बनाना

चरण 5. अनुकूलन

निष्कर्ष

More articles: