👩🏽‍🤝‍👨🏾 👲🏾 ☘️ सिम्फनी घटक अवलोकन: विन्यास 👼🏼 🤞🏾 🌏

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

निम्नलिखित लेख Symfony2 घटकों के अवलोकन का अनुवाद है : कॉन्फ़िगर । मूल 2014 में प्रकाशित हुआ था और यह सिम्फनी के दूसरे संस्करण को इंगित करता है, लेकिन जानकारी नवीनतम के लिए प्रासंगिक है, फिलहाल, चौथा संस्करण।

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

 blog: title:     description:    ... rss: true posts_main_page: 2 social: twitter: url: http://twitter.com/raulfraile icon: twitter.png sensiolabs_connect: url: https://connect.sensiolabs.com/profile/raulfraile icon: sensiolabs_connect.png

अब हम अपनी फ़ाइल को पार्स करने की कोशिश करेंगे, आवश्यक फ़ील्ड की उपलब्धता की जाँच करें, और यदि आवश्यक हो तो डिफ़ॉल्ट मान सेट करें। हम स्थापित नियमों के अनुपालन के लिए प्राप्त किए गए सभी डेटा की जांच करेंगे, उदाहरण के लिए, rss में केवल एक बूलियन मान हो सकता है, और पोस्ट_main_page में 1 से 10 तक पूर्णांक मान होना चाहिए। हमें इन प्रक्रियाओं को हर बार दोहराना होगा जब तक कि फ़ाइल का उपयोग नहीं किया जाता है, जब तक कि कैशिंग प्रणाली का उपयोग नहीं किया जाता है। । इसके अलावा, इस तरह के एक तंत्र में अन्य स्वरूपों जैसे कि INI , XML या JSON की फ़ाइलों का उपयोग जटिल है।

उपरोक्त क्रियाओं को सरल बनाने के लिए, हम विन्यास घटक का उपयोग करेंगे। घटक सरल, अच्छी तरह से परीक्षण किया गया है और विभिन्न परियोजनाओं में उपयोग के लिए पर्याप्त लचीला है।

आर्किटेक्चर

हम परियोजना को दो मुख्य भागों में विभाजित करेंगे:

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

उदाहरण

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

 <?php namespace RaulFraile\Config; use Symfony\Component\Config\Definition\ConfigurationInterface; use Symfony\Component\Config\Definition\Builder\TreeBuilder; class Configuration implements ConfigurationInterface { public function getConfigTreeBuilder() { $treeBuilder = new TreeBuilder(); $rootNode = $treeBuilder->root('blog'); $rootNode ->children() ->scalarNode('title') ->isRequired() ->end() ->scalarNode('description') ->defaultValue('') ->end() ->booleanNode('rss') ->defaultValue(false) ->end() ->integerNode('posts_main_page') ->min(1) ->max(10) ->defaultValue(5) ->end() ->arrayNode('social') ->arrayPrototype() ->children() ->scalarNode('url')->end() ->scalarNode('icon')->end() ->end() ->end() ->end() ->end() ; return $treeBuilder; } }

यदि आप पहली बार PHP कोड की समान संरचना देखते हैं, तो चिंता न करें, इसमें DSL सिंटैक्स हमेशा थोड़ा अजीब लगता है। ऊपर के उदाहरण में, हमने ब्लॉग के रूट नोड को निर्धारित किया और इससे कॉन्फ़िगरेशन ट्री की संरचना का निर्माण किया, जिनमें से शाखाएं हमारे लिए आवश्यक पैरामीटर और उनके मूल्यों के लिए नियम हैं। उदाहरण के लिए, शीर्षक को स्केलर प्रकार के अनिवार्य पैरामीटर के रूप में दर्शाया गया है, एक वैकल्पिक पैरामीटर के रूप में वर्णन , जो डिफ़ॉल्ट रूप से खाली है, आरएसएस में हम एक बूलियन मान की उम्मीद false जो डिफ़ॉल्ट रूप से false है, और पोस्ट_मैं_पेज में 1 से 10 तक पूर्णांक मान होना चाहिए, जिसमें 5 डिफ़ॉल्ट है। ।

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

 <?php namespace RaulFraile\Config; use Symfony\Component\Config\Loader\FileLoader; use Symfony\Component\Yaml\Yaml; class YamlConfigLoader extends FileLoader { public function load($resource, $type = null) { $configValues = Yaml::parse(file_get_contents($resource)); return $configValues; } public function supports($resource, $type = null) { return is_string($resource) && 'yml' === pathinfo( $resource, PATHINFO_EXTENSION ); } }

जैसा कि आप देख सकते हैं, सब कुछ बहुत सरल है। YamlConfigLoader::supports विधि का उपयोग कॉन्फ़िगरेशन स्रोत को सत्यापित करने के लिए LoaderResolver वर्ग द्वारा किया जाता है। YamlConfigLoader::load विधि किसी अन्य Symfony YAML घटक का उपयोग करके डेटा सरणी के लिए एक YamlConfigLoader::load फ़ाइल को परिवर्तित करती है।

निष्कर्ष में, आवश्यक मूल्यों को प्राप्त करने के लिए स्रोत को संसाधित करते समय हम कॉन्फ़िगरेशन संरचना और लोडर को जोड़ते हैं:

 <?php use Symfony\Component\Config\FileLocator; use Symfony\Component\Config\Loader\LoaderResolver; use Symfony\Component\Config\Loader\DelegatingLoader; use Symfony\Component\Config\Definition\Processor; use RaulFraile\Config\YamlConfigLoader; use RaulFraile\Config\Configuration; include_once __DIR__. '/vendor/autoload.php'; //    $directories = array(__DIR__.'/config'); $locator = new FileLocator($directories); //       $loader = new YamlConfigLoader($locator); $configValues = $loader->load($locator->locate('config.yml')); //   $processor = new Processor(); $configuration = new Configuration(); try { $processedConfiguration = $processor->processConfiguration( $configuration, $configValues ); //   var_dump($processedConfiguration); } catch (Exception $e) { echo $e->getMessage() . PHP_EOL; }

आइए इस कोड का विश्लेषण करें। सबसे पहले, हम उन निर्देशिकाओं की एक सरणी को परिभाषित करते हैं जहाँ कॉन्फ़िगरेशन फ़ाइलें स्थित हो सकती हैं, और इसे FileLocator ऑब्जेक्ट में एक पैरामीटर के रूप में रखा जाता है जो निर्दिष्ट निर्देशिका में config.yml फ़ाइल की तलाश करता है। फिर, एक YamlConfigLoader ऑब्जेक्ट बनाएं जो मानों के साथ एक सरणी देता है, और यह पहले से ही हमारे कॉन्फ़िगरेशन संरचना द्वारा संसाधित है।

परिणामस्वरूप, हमें निम्न सरणी मिलती है:

 array(5) { 'title' => string(7) "My blog" 'description' => string(24) "This is just a test blog" 'rss' => bool(true) 'posts_main_page' => int(2) 'social' => array(2) { 'twitter' => array(2) { 'url' => string(29) "http://twitter.com/raulfraile" 'icon' => string(11) "twitter.png" } 'sensiolabs_connect' => array(2) { 'url' => string(49) "https://connect.sensiolabs.com/profile/raulfraile" 'icon' => string(22) "sensiolabs_connect.png" } } }

यदि हम rss और post_main_page फ़ील्ड हटाकर config.yml बदलने का प्रयास करते हैं, तो हमें डिफ़ॉल्ट मान मिलेंगे:

 array(5) { ... 'rss' => bool(false) 'posts_main_page' => int(5)

कैशिंग

बड़ी कॉन्फ़िगरेशन फ़ाइलों को संसाधित करना समय लेने वाला कार्य हो सकता है। वर्णित घटक में कॉन्फ़िगरेशन फ़ाइल के परिवर्तन की तारीख की जांच के आधार पर एक साधारण कैशिंग तंत्र है।

कैश को सक्षम करने के लिए, कोड की कुछ लाइनें पर्याप्त हैं:

 <?php use Symfony\Component\Config\FileLocator; use Symfony\Component\Config\ConfigCache; use Symfony\Component\Config\Resource\FileResource; use Symfony\Component\Config\Definition\Processor; use RaulFraile\Config\YamlConfigLoader; use RaulFraile\Config\Configuration; include_once __DIR__. '/vendor/autoload.php'; $cachePath = __DIR__.'/cache/config.php'; $configFile = 'config.yml'; //    /    $cache = new ConfigCache($cachePath, true); if (!$cache->isFresh()) { $directories = array(__DIR__.'/config'); $locator = new FileLocator($directories); $loader = new YamlConfigLoader($locator); $configFilePath = $locator->locate($configFile); $configValues = $loader->load($configFilePath); $resource = new FileResource($configFilePath); $processor = new Processor(); $configuration = new Configuration(); try { $processedConfiguration = $processor->processConfiguration( $configuration, $configValues ); //     $cache->write(serialize($processedConfiguration), array($resource)); } catch (Exception $e) { echo $e->getMessage() . PHP_EOL; } }

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

एकाधिक लोड हो रहा है

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

 <?php namespace RaulFraile\Config; use Symfony\Component\Config\Loader\FileLoader; class XmlConfigLoader extends FileLoader { public function load($resource, $type = null) { //  xml return $configValues; } public function supports($resource, $type = null) { return is_string($resource) && 'xml' === pathinfo( $resource, PATHINFO_EXTENSION ); } }

 $loaderResolver = new LoaderResolver(array( new YamlConfigLoader($locator), new XmlConfigLoader($locator) )); $delegatingLoader = new DelegatingLoader($loaderResolver); $configValues = $delegatingLoader->load($locator->locate('config.xml'));

पृष्ठभूमि की जानकारी सृजन

अन्य बातों के अलावा, घटक में आपके दस्तावेज़ के लिए संदर्भ जानकारी उत्पन्न करने की कार्यक्षमता है।

 <?php ... use Symfony\Component\Config\Definition\Dumper\YamlReferenceDumper; $dumper = new YamlReferenceDumper(); echo $dumper->dump($configuration);

यह उत्पादन होगा:

 blog: title: ~ # Required description: '' rss: false posts_main_page: 5 social: url: ~ icon: ~

परिणाम

शायद आप पाएंगे कि यह सब बहुत जटिल और भ्रामक है, और आप कुछ कार्यों के साथ कर सकते हैं। शायद, लेकिन एक अच्छी OOP संरचना के लिए इस तरह की "कीमत" है। दूसरी ओर, यह घटक कई लाभ प्रदान करता है:

~ 80% परीक्षण और सक्रिय समर्थन के साथ घटक का कवरेज।
नए कॉन्फ़िगरेशन स्वरूपों को जोड़ना वास्तव में आसान है। यह एक हैंडलर को परिभाषित करने के लिए पर्याप्त है जो स्रोत डेटा को एक नियमित सरणी में परिवर्तित करता है। एक समान संरचना का उपयोग अन्य प्रारूपों के लिए किया जाएगा। आवश्यक इंटरफ़ेस को जोड़कर घटक के किसी भी हिस्से का विस्तार लागू किया जाता है।
कैशिंग बॉक्स से बाहर काम करता है लचीली सेटिंग्स के साथ dev और prod दोनों वातावरण के लिए।
निर्मित मापदंडों और उनके मूल्यों का सत्यापन।
पृष्ठभूमि की जानकारी पीढ़ी।