👩‍🌾 🚹 🛩️ एग्रीगेटर आर्किटेक्चर: वेब सेवा पैटर्न (भाग 1) 👈 ⏺️ 🤽🏽

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

डेवलपर्स द्वारा सामना की जाने वाली मुख्य समस्याएं:

सेवाओं के साथ काम करने के विभिन्न सिद्धांत: उनमें से कुछ एपीआई प्रदान करते हैं, और दूसरों को मानव क्रियाओं की नकल करते हुए बॉट के माध्यम से काम करना पड़ता है।
सेवाओं से प्रतिक्रियाओं की विषमता - कुछ रिटर्न जोंस, अन्य एक्सएमएल लौटाते हैं, और अन्य एक वेब पेज लौटाते हैं।

2 से उपजी - डेटा संरचनाओं की विविधता - उदाहरण के लिए, एक परियोजना वस्तु की संरचना
सी फ्रीलांसर इस तरह दिखता है:

<?xml version="1.0" encoding="UTF-8"?> <xml-result xmlns="http://api.freelancer.com/schemas/xml-0.1"> <id>588582</id> <name>sign design web software</name> <url>http://www.sandbox.freelancer.com/projects/PHP-ASP/sign-design-web-software.html</url> <buyer> <url>http://www.sandbox.freelancer.com/users/1353095.html</url> <id>1353095</id> <username>billk89</username> </buyer> <short_descr>Create and upload sign design web software for our client nlsigndesign.com Public internet users must be able to create there own signs online, then save and submit as a file. </short_descr> <jobs> <job>PHP</job> </jobs> ... </xml-result>

जबकि ओडस्क जवाब देता है:

  <response> .... <profile> .... <buyer>  <cnt_assignments>0</cnt_assignments>  <op_contract_date>December 18, 2011</op_contract_date>  <timezone>Russia (UTC+06)</timezone> </buyer> <op_title>A social network client app for iPhone/iPad</op_title> <ciphertext>~~05d405f2d5b8eb27</ciphertext> .... <op_required_skills>  <op_required_skill>   <skill>ipad,ui-design,iphone-development</skill>  </op_required_skill> </op_required_skills> .... <op_desc_digest> Hello, We need a social network client app for iPhone/iPad to be developed. It should support Facebook, Twitter and Linked-In. </op_desc_digest> .... </profile> </response>

समझने में आसानी के लिए, मैंने एक अलग लेख में समस्याओं में से प्रत्येक के समाधान का वर्णन करने का निर्णय लिया। इस लेख में मैं दिखाऊंगा कि दो लोकप्रिय फ्रीलांस एक्सचेंजों ओडेस्क और फ्रीलांसर के उदाहरण पर विभिन्न सेवाओं के साथ काम को कैसे एकजुट किया जाए। स्रोत कोड PHP5 में Yii फ्रेमवर्क का उपयोग करके लिखा गया है।

एक इंटरफ़ेस बनाएँ

इसलिए, पहली बात यह है कि प्रत्येक कंक्रीट क्लास में कार्यान्वयन को छिपाने और विभिन्न सेवाओं के लिए तरीकों के एक सेट को कॉल करने के लिए सक्षम करने के लिए एक इंटरफ़ेस बनाना है।

 interface ServiceInterface { public function authorize(); public function getServiceName(); public function setCredential(ModelCredential $credential); public function searchProjects(); }

हम सेवा एडेप्टर बनाते हैं

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

फ्रीलांसर सेवा एडाप्टर:

 class FreelancerService implements ServiceInterface { private $_serviceName = 'freelancer'; private $_service = null; public function __construct(ModelCredential $credential = null) { Yii::import('ext.freelancer-api-wrapper.*'); $this->_service = new Freelancer(Yii::app()->params['freelancer']['token'],Yii::app()->params['freelancer']['secret'], 'http://geeks-board.local/authorizeService/freelancer/?'); if($credential !== null) { $this->setCredential($credential); } } public function authorize() { if(!isset($_GET['oauth_token'])) { $requestToken = $this->_service->requestRequestToken(); $redirectUrl = $this->_service->getRedirectUrl($requestToken); header('Location: ' . $redirectUrl); } else { $oauth_verifier = $this->_service->getRequestTokenVerifier($_GET['oauth_token']); $auth = $this->_service->requestAccessToken($oauth_verifier,$_GET['oauth_token']); $this->_service->oauth->setToken($auth['oauth_token'],$auth['oauth_token_secret']); $this->_service->auth = $auth; return $auth; } return false; } public function getServiceName() { .... } public function setCredential(ModelCredential $credential) { .... } public function searchProjects() { .... } }

Odesk सेवा एडाप्टर:

 class OdeskService implements ServiceInterface { private $_serviceName = 'odesk'; private $_service = null; public function __construct(ModelCredential $credential = null) { Yii::import('ext.odesk-api.*'); Yii::import('classes.mapper.service.RequestMapper'); $this->_service = new oDeskAPI(Yii::app()->params['odesk']['secret'], Yii::app()->params['odesk']['token']); if($credential !== null) { $this->setCredential($credential); } } public function authorize() { return $this->_service->auth(); } public function getServiceName() { .... } public function setCredential(ModelCredential $credential) { .... } public function searchProjects() { .... } }

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

एक कारखाना बनाएँ

भविष्य में, हमें मौजूदा वर्गों के कोड को बदलने के बिना आसानी से नई सेवाओं को जोड़ने की आवश्यकता है (हम OCP सिद्धांत का पालन करते हैं)। ऐसा करने के लिए, "फ़ैक्टरी विधि" पैटर्न का उपयोग करें।

 class ServiceFactory { public static function create($serviceName, $credentials = null) { $className = ucfirst(strtolower($serviceName)).'Service'; $serviceObject = Yii::createComponent($className, $credentials); if(!($serviceObject instanceof ServiceInterface)) { throw new Exception('Not an instance of Service'); } return $serviceObject; } }

हमने एक चेक भी जोड़ा कि यह वर्ग ServiceInterface को लागू करता है। इंटरफ़ेस का उपयोग यहां क्यों किया गया है और सेवा वर्गों द्वारा इसके कार्यान्वयन के लिए जाँच की जा रही है? यदि डेवलपर कोई गलती करता है और किसी भी इंटरफ़ेस विधि को लागू करना भूल जाता है, तो php आपको सिद्धांत रूप में कोड को चलाने की अनुमति नहीं देगा। यह हमें विश्वास दिलाता है कि यह विधि लागू की गई है। यह इस बात की समझ भी देता है कि सिस्टम को काम करने के लिए किन विशिष्ट तरीकों की आवश्यकता होगी। इस अवसर पर, मैं अपनी कहानी साझा करूंगा।
जिन परियोजनाओं पर मैंने काम किया, उनमें से एक पर Google+ के लिए एडॉप्टर सेवा को लागू करने के लिए कार्य निर्धारित किया गया था। फेसबुक और ट्विटर एडेप्टर पहले ही परियोजना में एकीकृत हो चुके हैं। जब मैंने उनमें से एक की कक्षा खोली, तो मैं अंदर कोड की मात्रा से भयभीत था। मुझे समझ में नहीं आया कि सेवा करने के लिए मुझे किन तरीकों को लागू करने की आवश्यकता है, और जो माध्यमिक थे। मुझे कई वर्गों की तुलना करनी थी, उन डेवलपर्स के साथ जांच करें जिन्होंने यह कोड लिखा था। इसमें कुछ समय लगा। यदि हमारे पास ऐसे सेवा एडेप्टर के लिए एक इंटरफ़ेस है, तो यह तुरंत स्पष्ट होगा कि कौन से तरीकों को बनाने की आवश्यकता है।

यह सब एक साथ रखना

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

  Yii::import('application.models.ModelCredential'); //       -   ,    Credentials -   //     . $credentialsRecords = ModelCredential::model()->findAllByAttributes(array( 'type' => 'public' )); if(!empty($credentialsRecords)) { Yii::import('classes.service.ServiceFactory'); $aggregatedProjects = array(); foreach($credentialsRecords as $serviceCredential) { try { //          credentials. $service = ServiceFactory::create($serviceCredential->service, $serviceCredential); $foundProjects = $service->searchProjects(); //       if(is_array($foundProjects)) $aggregatedProjects = array_merge($aggregatedProjects,$foundProjects); } catch(Exception $e) { print_r($e); } } } else { echo 'empty '. "\n"; }

परिणाम

यह वास्तुकला आपको नई सेवाओं को और अधिक पारदर्शी रूप से एकीकृत करने की अनुमति देता है और डेवलपर को विधियों या उनके कॉल के नाम में अंतर को याद रखने की आवश्यकता नहीं है।

अगले लेख में मैं आपको बताऊंगा कि लौटी प्रतिक्रियाओं और डेटा संरचनाओं की विविधता के साथ क्या करना है।

पुनश्च

फैक्टरी कोड को सरल किया गया है - Yii :: createComponent () पर कॉल करके। धन्यवाद एकस्तीजी