🐐 💈 🍳 AMatch - PHP में इनपुट मापदंडों की जाँच 👩🏼‍🤝‍👨🏽 🙏🏼 🎴

कामरेड! यह लेख उच्च-उच्च-उच्च-लोड सिस्टम के लिए नहीं है। प्रस्तुत समाधानों की गति निश्चित रूप से सरलतम जाँचों से कम है। हजारों या बहुत गहरी संरचनाओं पर, प्रस्तावित दृष्टिकोण की सिफारिश नहीं की जाती है। इस विषय में, तेज कोडिंग जीतती है, तेज कोड नहीं।

कोई लंबा नहीं

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

चलिए बात पर आते हैं

एक पूरा उदाहरण जीथब के साथ है ।

मान लीजिए कि हमारे पास एक निश्चित नियंत्रक है जो अभी तक पूरी तरह से गायब होने के लिए अपवर्तन और पुनर्विचार के चरण को पारित नहीं किया है। सबसे पहले, वह सब कुछ लेता है जो सामने वाले छोर से आया था ($ params = $ _REQUEST;)। प्रयोग की गंदगी के लिए, आइए कल्पना करें कि कोई पूर्व फ़िल्टरिंग नहीं है - जितना अधिक उन्होंने भेजा, उतना ही खुश। उदाहरण के लिए, $ परम सरणी की सामग्री इस प्रकार होगी:

$params = array( 'doc_id' => 133, 'subject_id' => '64', 'parent_id' => 32, 'title' => 'New document', 'data' => array( 'flag' => 'experiment', 'from_topic' => false, ), );

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

 //   if (!isset($params['doc_id'])) { throw new Exception('Expected document id'); } if (!isset($params['subject_id'])) { throw new Exception('Expected subject id'); } if ($params['doc_id'] <= 0) { throw new Exception('Incorrect document id'); } if ($params['subject_id'] == 0) { //   throw new Exception('Incorrect document id'); } if (isset($params['parent_id']) && $params['parent_id'] <= 0) { //   —   throw new Exception('Incorrect parent id'); } if (isset($params['data']) && (!is_array($params['data']) || empty($params['data']))) { throw new Exception('Incorrect document data'); } //...if //...if-else //...if-or-if-else-if //...the brain is burning

क्या वह परिचित है? और बहुत सारे, दिन में कई बार। व्यवसाय प्रक्रिया में प्रत्येक "यदि" स्थिति के लिए, विभिन्न सीमा मूल्यों के साथ एक इकाई परीक्षण लिखना आवश्यक है। कल्पना कीजिए कि केवल इस कोड के लिए परीक्षण की कितनी लाइनों की आवश्यकता होगी। क्या कल? - "इसे काट दो, और यहां आपको एक साथ तीन दस्तावेजों की आवश्यकता है ताकि आप स्वीकार कर सकें और parent_id अब एक सरणी होगी।" और मोटिव त्रुटियों के साथ क्या करना है, जिनमें से प्रत्येक स्थिति को अलग से लिखा गया है? नई फैशनेबल भुगतान प्रणाली के साथ एकीकृत कैसे करें, जिसमें कोड के रूप में त्रुटियों की आवश्यकता है? इस तरह के vinaigrette के लिए मैपिंग लिखना अपने आप में एक पॉपोल है।

अंत में वह एमाच दिखाता है

खैर, अब मिठाई एमाच का उपयोग करने वाले कई कारकों के लिए एक ही सरणी की जाँच कर रही है :

 require_once('class.AMatch.php'); $match = AMatch::runMatch($params) ->doc_id(0, '<') //    ->subject_id(0, '!=') //    ->subject_id('', '!float') //  float ->author_name(AMatch::OPTIONAL, 'string') //    ->author_name('Guest') //   ->parent_id(AMatch::OPTIONAL, 'int') //   int ->parent_id(0, '<') //    ->parent_id(array(32, 33), 'in_left_array') //       ->data('', 'array') //  ->data('', '!empty') //   ->data('old_property', '!key_exists') //     ->data('experiment', 'in_array') //     'experiment' ->title() //     ; $result = $match->stopMatch(); if (!$result) { die(var_export($match->matchComments(), true)); //    } echo 'Victory!';

आइए दिए गए कोड का विश्लेषण करें। सत्यापन की शुरुआत (मिलान की स्थिति) एएमच :: रनमच () विधि में चेक किए जाने वाले सरणी के हस्तांतरण के साथ शुरू होती है। फिर, डेरेफेरिंग द्वारा, चेक निम्नानुसार लगाए जाते हैं:

 ->_([___], [])->…->stopMatch()

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

महाराज, यह सब हो गया

चलो परिणाम को देखने के लिए आने वाली सरणी को गड़बड़ करते हैं:

 $params_bad = array( 'doc_id' => -4, 'subject_id' => null, 'parent_id' => 30, 'data' => array( 'flag' => 'booom', 'from_topic' => array(), 'old_property' => true, ), 'wtf_param' => 'exploit', ); $params = $params_bad;

आउटपुट है:

 array ( 'doc_id' => 'Condition is not valid', )

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

 die( var_export($match->matchComments(), true) . PHP_EOL . var_export($match->matchCommentsConditions(), true) );

अब परिणाम तुलनात्मक ऑपरेशन को दिखाता है जो कि गलत था:

 array ( 'doc_id' => 'Condition is not valid', ) array ( 'doc_id' => // ,     array ( 0 => 0, //     1 => '<', //   «  » ), )

संक्षेप में, यह मूल प्रविष्टि का दोहराव है:

 ->doc_id(0, '<')

सभी टिप्पणियां स्थिरांक में संग्रहीत हैं (AMatch :: KEY_CONDITION_NOT_VALID == 'स्थिति मान्य नहीं है')। जाहिर है, अब त्रुटि स्थिरांक और उनके होने की स्थितियों के आधार पर, उपयोगकर्ता को त्रुटियों को जारी करने के लिए मानक मानचित्रण को कॉन्फ़िगर करना संभव है।

अधिक लकड़ी की आवश्यकता है!

अन्य शर्तों पर लौटते हैं। एएमच को निर्देश देने और जाँचने के लिए जब तक कि स्थिति समाप्त न हो जाए, आपको झंडे (बिटमास्क) का उपयोग करना होगा। वर्तमान में तीन झंडे हैं।

FLAG_STRICT_STRUCTURE - जांचें कि चेक किए गए सरणी में कोई कुंजी नहीं है जो मिलान के लिए घोषित नहीं हैं।
FLAG_DONT_STOP_MATCHING - बेमेल स्थिति का पता चलने पर भी मिलान बंद न करें।
FLAG_SHOW_GOOD_COMMENTS - न केवल समस्याओं पर, बल्कि उन कुंजियों और शर्तों पर भी टिप्पणी दिखाएं, जो तुलना से गुजरती हैं।

ये झंडे आवेदन डिबग मोड में विशेष रूप से उपयोगी हो सकते हैं। ठीक है, ध्वज "FLAG_DONT_STOP_MATCHING" विशेष रूप से उपयोगी है, उदाहरण के लिए, यदि आपको प्रपत्र डेटा की जांच करने और सभी समस्याओं को वापस करने की आवश्यकता है। कोड को पूरक करें:

 $flags = AMatch::FLAG_DONT_STOP_MATCHING; $match = AMatch::runMatch($params, $flags) …

अब परिणाम से सभी समस्याओं का पता चलता है:

 array ( 'doc_id' => 'Condition is not valid', 'subject_id' => 'Condition is not valid', 'parent_id' => 'Condition is not valid', 'data' => array ( 'flag' => 'Condition is not valid', ), 'title' => 'Expected parameter does not exist in the array of parameters', ) … (  )

मैं मुश्किल प्यार करता हूँ!

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

 $flags = AMatch::FLAG_DONT_STOP_MATCHING | AMatch::FLAG_STRICT_STRUCTURE;

आइए इस ध्वज के साथ कोड निष्पादित करें। टिप्पणियों में दो नई लाइनें जोड़ी जाएंगी:

'stopMatch' => 'इनपुट डेटा में अज्ञात पैरामीटर',
'अज्ञात पैरामीटर:' => 'wtf_param',
// किसी भी मानचित्रण के लिए त्रुटि मान AMatch का उपयोग करें :: UNKNOWN_PARAMETERS_LIST और मुख्य नाम AMatch :: _ UNKNOWN_PARAMETERS_LIST

सामान्य तौर पर, यह इस बात से देखा जा सकता है कि एक पैरामीटर पाया जाता है जिसके लिए कोई सत्यापन शर्तें नहीं हैं।

कीट नियंत्रण

अंतिम ध्वज डिबगिंग मोड के लिए उपयोगी है, जब आपको न केवल यह जानने की आवश्यकता होती है कि अमान्य कुंजी हैं, बल्कि यह भी जानते हैं कि मान्य कुंजियों का सही सत्यापन किया गया है। हम डिबगिंग के साथ झंडे को पूरक करते हैं और मूल सही सरणी लौटाते हैं:

 define('DEBUG_MODE', true); if (DEBUG_MODE) { $flags |= AMatch::FLAG_SHOW_GOOD_COMMENTS; } …   Victory: if (DEBUG_MODE) { $comments = $match->matchComments(); $comments_explanation = $match->matchCommentsConditions(); echo PHP_EOL; var_export($comments); echo PHP_EOL; var_export($comments_explanation); }

अब टिप्पणियों में कई bukaf होंगे (उनमें से सभी AMatch स्थिरांक में हैं):

 Victory! array ( 'doc_id' => 'OK. Condition is valid', 'subject_id' => 'OK. Condition is valid', 'author_name' => 'Optional parameter, skipped bad condition result', 'parent_id' => 'OK. Expected parameter type is valid', 'data' => 'OK. Expected parameter type is valid', 'title' => 'OK. Expected parameter exist in the array of parameters', 'stopMatch' => 'The array does not contains unknown parameters', )

अलग-अलग, मैं ध्यान देता हूं कि निष्पादन परिणाम और टिप्पणियों का पुनर्लेखन असफल परिस्थितियों में ही किया जाता है। यही है, अगर पहले शर्तों में "सफलता" थी, तो गलत स्थिति कुंजी द्वारा टिप्पणी को अधिलेखित कर देगी। यदि पहले कोई विफलता हुई थी, तो एक सफल स्थिति टिप्पणियों को नहीं छूएगी।

मैं संतुष्ट नहीं हूँ!

कुछ कैंडी जोड़ें। $ मैच से पहले- stopMatch (), नेस्टेड सरणी संरचना की जाँच करें:

 function checkDocumentData($data) { $result = AMatch::runMatch($data) ->flag('experiment') //   ->from_topic(specialValidation(), true) //  ,       true ->from_topic(false) //  false ->link_id(AMatch::OPTIONAL, 'int') //   int ; return array($result->stopMatch(), $result->matchComments(), $result->matchCommentsConditions()); } function specialValidation() { return 1 < 2; //    ,   -  (,    ) } $match->data('checkDocumentData', 'callback'); //

मुझे उम्मीद है कि यहां सब कुछ स्पष्ट है।

Poslebukvie

आंद्रेई टेरेशचेंको, आंद्रेई लुगोवॉय और प्रोवोव विकास टीम के विचारों के लिए धन्यवाद।
आप और अधिक उदाहरण देख सकते हैं (unittests देखें) और यहाँ स्रोतों को डाउनलोड करें: https://github.com/KIVagant/AMatch
मुझे बहुत खुशी होगी अगर आपके विचार उपयोगी कामों में बदल जाते हैं। मुझे आलोचना पसंद नहीं है, लेकिन ओह ठीक है, टिप्पणियों में जले। और अफसोस, मैं अंग्रेजी में अच्छा नहीं हूं, इसलिए ग्रामर-नाजी वेलकम।

युपीडी:
अगला लेख: नई कॉलबैक और त्रुटि से निपटने ।

युपीडी:
संगीतकार में परिवर्तित।

AMatch - PHP में इनपुट मापदंडों की जाँच