हम Symfony2 के आधार पर अपना ढांचा बनाते हैं। (भाग 2)

सामग्री की तालिका

भाग 1
भाग २
भाग ३
भाग ४
भाग 5

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

• मैं बड़े अनुप्रयोगों के साथ और कुछ से अधिक डेवलपर्स के साथ काम करते समय चौखटे का उपयोग करने के स्पष्ट लाभों के बारे में बात नहीं करूंगा; इस विषय पर नेट पर पहले से ही काफी अच्छे संसाधन हैं।

हालाँकि हमने पिछली बार जो "एप्लिकेशन" लिखा था वह काफी सरल था, इसमें कई कमियाँ हैं:

<?php // framework/index.php $input = $_GET['name']; printf('Hello %s', $input); 

सबसे पहले, यदि क्वेरी पैरामीटर में नाम चर सेट नहीं है, तो एक PHP चेतावनी जारी की जाएगी। चलो इसे ठीक करते हैं:

 <?php // framework/index.php $input = isset($_GET['name']) ? $_GET['name'] : 'World'; printf('Hello %s', $input); 

मानो या न मानो, यहां तक ​​कि कोड का यह छोटा सा टुकड़ा सबसे आम कमजोरियों में से एक के लिए असुरक्षित है - XSS (क्रॉस-साइट स्क्रिप्ट)। यहाँ एक अधिक सुरक्षित संस्करण है:

 <?php $input = isset($_GET['name']) ? $_GET['name'] : 'World'; header('Content-Type: text/html; charset=utf-8'); printf('Hello %s', htmlspecialchars($input, ENT_QUOTES, 'UTF-8')); 

• जैसा कि आपने देखा होगा कि htmlspecialchars () के साथ कोड की सुरक्षा करना बहुत थकाऊ है और आसानी से टाइपो को जन्म दे सकता है। यह एक अस्थायी इंजन जैसे कि ट्विग का उपयोग करने का एक कारण है, जहां ऑटो-एस्केप डिफ़ॉल्ट रूप से सक्षम है।

जैसा कि आप देख सकते हैं, शुरू में सरल कोड सुरक्षा जांच जोड़ने और PHP की चेतावनी / सूचनाओं से बचने के दौरान और अधिक जटिल हो जाता है।

सुरक्षा के अलावा, इस कोड का परीक्षण करना भी आसान नहीं है। यहां तक ​​कि अगर वहाँ परीक्षण करने के लिए बहुत कुछ नहीं है, तो मुझे लगता है कि PHP कोड के सबसे सरल टुकड़े के लिए इकाई परीक्षण लिखना स्वाभाविक नहीं है और बदसूरत दिखाई देगा। यहाँ उपरोक्त कोड के लिए PHPUnit इकाई परीक्षण का एक उदाहरण दिया गया है:

 <?php // framework/test.php class IndexTest extends \PHPUnit_Framework_TestCase { public function testHello() { $_GET['name'] = 'Fabien'; ob_start(); include 'index.php'; $content = ob_get_clean(); $this->assertEquals('Hello Fabien', $content); } } 

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

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

हम HttpFoundation घटक का उपयोग करके OOP पर स्विच करते हैं। (HttpFoundation घटक के साथ OOP जाना)

वेब आधारित कोड लिखना अनिवार्य रूप से HTTP प्रोटोकॉल के साथ काम कर रहा है। तो हमारे ढांचे के बुनियादी सिद्धांत HTTP विनिर्देश पर आधारित होना चाहिए।

HTTP विनिर्देशन बताता है कि एक क्लाइंट (जैसे ब्राउज़र) एक सर्वर (वेब ​​सर्वर के माध्यम से हमारा आवेदन) के साथ कैसे संपर्क करता है। क्लाइंट और सर्वर के बीच संवाद स्पष्ट रूप से संदेश, अनुरोधों और प्रतिक्रियाओं को परिभाषित करता है: क्लाइंट सर्वर को एक अनुरोध भेजता है और इस अनुरोध के आधार पर, सर्वर एक प्रतिक्रिया देता है।

PHP में, एक अनुरोध को वैश्विक चर ( $ _GET, $ _POST, $ _FILE, $ _COOKIE, $ _SESSION ...) के रूप में दर्शाया जाता है, और फ़ंक्शन (इको, हेडर, सेटक्यूकी, ...) का उपयोग करके प्रतिक्रिया उत्पन्न होती है।

एक बेहतर कोड का पहला कदम एक वस्तु-उन्मुख दृष्टिकोण का उपयोग करना है। HttpFoundation घटक का मुख्य लक्ष्य वैश्विक PHP चर को ऑब्जेक्ट-ओरिएंटेड लेयर से बदलना है।

इस घटक का उपयोग करने के लिए, इसे composer.json फ़ाइल में प्रोजेक्ट के आधार पर जोड़ें, जिसके बाद कमांड चलाएँ

 composer update 

अंत में, autoload.php फ़ाइल के निचले भाग में, घटक को स्वचालित रूप से डाउनलोड करने के लिए आवश्यक कोड जोड़ें:

 <?php // framework/autoload.php $loader->registerNamespace('Symfony\\Component\\HttpFoundation', __DIR__.'/vendor/symfony/http-foundation'); 

अब, हम " रिक्वेस्ट " और " रिस्पांस " कक्षाओं का उपयोग करके अपने आवेदन को फिर से लिखते हैं:

 <php // framework/index.php require_once __DIR__.'/autoload.php'; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; $request = Request::createFromGlobals(); $input = $request->get('name', 'World'); $response = new Response(sprintf('Hello %s', htmlspecialchars($input, ENT_QUOTES, 'UTF-8'))); $response->send(); 

CreateFromGlobals () विधि PHP वैश्विक चर के वर्तमान मूल्यों के आधार पर अनुरोध वर्ग का एक उदाहरण बनाता है।
भेजें () विधि " प्रतिक्रिया " वर्ग के ऑब्जेक्ट का डेटा क्लाइंट को वापस भेजती है (पहले, सामग्री के बाद HTTP हेडर)।

• संकेत: भेजें () विधि को कॉल करने से पहले, हमें यह सुनिश्चित करने के लिए कि " प्रतिसाद " HTTP विनिर्देश के साथ संगत है, हमें तैयारी () विधि ( $ प्रतिक्रिया-> तैयारी ($ अनुरोध) ) को कॉल करना होगा। उदाहरण के लिए, यदि हमें "HEAD" विधि का उपयोग करके एक पृष्ठ मिलता है, तो हमें प्रतिक्रिया निकाय से सामग्री को हटाने की आवश्यकता है।

पिछले कोड से मुख्य अंतर यह है कि आपके पास HTTP संदेशों पर पूर्ण नियंत्रण है। आप अपनी इच्छानुसार कोई भी अनुरोध बना सकते हैं, और जब भी आप फिट दिखते हैं तो आप प्रतिक्रिया भेजने के लिए जिम्मेदार होते हैं।

• हमने "सामग्री-प्रकार" हेडर को फिर से लिखे गए कोड में सेट नहीं किया है, क्योंकि " प्रतिक्रिया " ऑब्जेक्ट में डिफ़ॉल्ट एन्कोडिंग UTF-8 है।

" अनुरोध " वर्ग के साथ, सभी अनुरोधित जानकारी हमेशा आपकी उंगलियों पर होती है, एक अच्छा और सरल एपीआई के लिए धन्यवाद:

 <?php //  URI (.. /about)    $request->getPathInfo(); //  GET  POST  $request->query->get('foo'); $request->request->get('bar', 'default value if bar does not exist'); //   SERVER $request->server->get('HTTP_HOST'); //    "UploadedFile" ( )   foo $request->files->get('foo'); //    COOKIE $request->cookies->get('PHPSESSID'); //   HTTP  $request->headers->get('host'); $request->headers->get('content_type'); $request->getMethod(); // GET, POST, PUT, DELETE, HEAD $request->getLanguages(); //  ,    

आप किसी अनुरोध का अनुकरण भी कर सकते हैं:

 $request = Request::create('/index.php?name=Fabien'); 

" प्रतिक्रिया " वर्ग के साथ, आप आसानी से प्रतिक्रिया को अनुकूलित कर सकते हैं:

 <?php $response = new Response(); $response->setContent('Hello world!'); $response->setStatusCode(200); $response->headers->set('Content-Type', 'text/html'); //   HTTP  $response->setMaxAge(10); 

• संकेत: " रिस्पॉन्स " को डीबग करने के लिए, ऑब्जेक्ट को स्ट्रिंग प्रकार पर डालें; यह HTTP प्रतिक्रिया सबमिशन (हेडर और कंटेंट) लौटाएगा

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

यहां तक ​​कि क्लाइंट के आईपी पते को वापस करने के लिए इस तरह का एक सरल ऑपरेशन सुरक्षित नहीं हो सकता है:

 <?php if ($myIp == $_SERVER['REMOTE_ADDR']) { //   ,    } 

यह तब तक ठीक काम करता है जब तक कि आप उत्पादन पर सर्वर के सामने एक रिवर्स प्रॉक्सी नहीं जोड़ते हैं, इस समय आपको कोड बदलना होगा ताकि यह आपकी दोनों मशीनों पर काम करे (यदि आपके पास विकास सर्वर पर रिवर्स प्रॉक्सी नहीं है):

 <?php if ($myIp == $_SERVER['HTTP_X_FORWARDED_FOR'] || $myIp == $_SERVER['REMOTE_ADDR']) { //   ,    } 

अनुरोध :: getClientIp () विधि का उपयोग करते हुए, आपके पास पहले दिन से एक वर्किंग कोड होगा, चाहे वह किसी भी प्रॉक्सी की मौजूदगी का हो।

 <?php $request = Request::createFromGlobals(); if ($myIp == $request->getClientIp()) { //   ,    } 

एक अतिरिक्त लाभ भी है: यह डिफ़ॉल्ट रूप से सुरक्षित है। मुझे सुरक्षा से क्या मतलब है? अंतिम उपयोगकर्ता $ _SERVER ['HTTP_X_FORWARDED_FOR'] के मूल्य में हेरफेर कर सकता है और उस पर भरोसा नहीं किया जा सकता है। इसलिए, यदि आप प्रॉक्सी सर्वर के बिना उत्पादन में इस कोड का उपयोग करते हैं, तो आपके सिस्टम पर इसका दुरुपयोग करना काफी आसान हो जाता है। यह getClientIp () विधि के साथ नहीं होता है, क्योंकि आपको स्पष्ट रूप से संकेत करना चाहिए कि आप इस हेडर को TrustProxyData () कहकर भरोसा करते हैं:

 <?php Request::trustProxyData(); if ($myIp == $request->getClientIp(true)) { //   ,    } 

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

• यदि आप HttpFoundation घटक के बारे में अधिक जानना चाहते हैं, तो आप एपीआई पर एक नज़र डाल सकते हैं या सिम्फनी वेबसाइट पर प्रलेखन पढ़ सकते हैं।

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

वास्तव में, ड्रुपल जैसी परियोजनाओं ने (आगामी संस्करण 8 के लिए) HttpFoundation घटक को अपनाया है; अगर यह उनके लिए काम करता है, तो यह शायद आपके लिए काम करेगा। पहिया को सुदृढ़ न करें।

मैं लगभग एक अतिरिक्त लाभ का उल्लेख करना भूल गया: HttpFoundation घटक का उपयोग करके आप फ्रेमवर्क और अनुप्रयोगों के बीच बेहतर इंटरैक्शन प्राप्त कर सकते हैं जो इसका उपयोग करते हैं (आज Symfony2 , Drupal 8 , PhpBB 4 , Silex , Midgif CMS , Zikula ...)।