🚇 🕋 ⛹🏼 PHP Xdebug प्रॉक्सी: जब Xdebug की मानक विशेषताएं पर्याप्त नहीं हैं 🧚🏿 🌑 🗂️

PHP Xdebug प्रॉक्सी: जब Xdebug की मानक विशेषताएं पर्याप्त नहीं हैं

डीबगिंग के लिए PHP प्रोग्राम अक्सर Xdebug का उपयोग करते हैं। हालाँकि, IDE और Xdebug की मानक विशेषताएँ हमेशा पर्याप्त नहीं होती हैं। कुछ समस्याओं को Xdebug प्रॉक्सी - pydbgpproxy का उपयोग करके हल किया जा सकता है, लेकिन फिर भी सभी नहीं। इसलिए, मैंने amphp अतुल्यकालिक ढांचे के आधार पर PHP Xdebug प्रॉक्सी को लागू किया।

कट के तहत, मैं आपको बताऊंगा कि pydbgpproxy में क्या गलत है, इसमें क्या गायब है और मैंने इसे क्यों नहीं संशोधित किया। मैं यह भी बताऊंगा कि PHP Xdebug प्रॉक्सी कैसे काम करता है और यह दिखाता है कि एक उदाहरण का उपयोग करके इसे कैसे बढ़ाया जाए।

Pydbgpproxy बनाम PHP Xdebug प्रॉक्सी

Xdebug प्रॉक्सी, IDE और Xdebug (Xdebug से IDE और इसके विपरीत के अनुरोधों के बीच की एक मध्यवर्ती सेवा) है। बहुधा इसका उपयोग बहुउद्देशीय डिबगिंग के लिए किया जाता है। यह तब होता है जब आपके पास एक वेब सर्वर और कई डेवलपर्स होते हैं।

प्रॉक्सी के रूप में, आमतौर पर pydbgpproxy का उपयोग किया जाता है। लेकिन उसकी कुछ समस्याएं हैं:

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

GitHub और इंटरनेट पर PHP में लिखे गए Xdebug प्रॉक्सी की खोज के कोई परिणाम नहीं मिले। इसलिए मैंने PHP Xdebug प्रॉक्सी लिखा। हुड के तहत, मैंने एम्फ़ीप एसिंक्रोनस फ्रेमवर्क का उपयोग किया।

Pydbgpproxy पर PHP Xdebug प्रॉक्सी के मुख्य लाभ:

PHP Xdebug प्रॉक्सी PHP डेवलपर्स के लिए परिचित भाषा में लिखा गया है, जिसका अर्थ है:
- इसमें समस्याओं को हल करना आसान है;
- इसका विस्तार करना आसान है;
PHP Xdebug प्रॉक्सी में एक सार्वजनिक भंडार है, जिसका अर्थ है:
- आप कांटा कर सकते हैं और इसे अपनी आवश्यकताओं को पूरा कर सकते हैं;
- आप एक लापता सुविधा या किसी समस्या के समाधान के साथ पुल अनुरोध भेज सकते हैं।

PHP Xdebug प्रॉक्सी के साथ कैसे काम करें

स्थापना

PHP Xdebug प्रॉक्सी को संगीतकार के माध्यम से एक देवता निर्भरता के रूप में स्थापित किया जा सकता है:

composer.phar require mougrim/php-xdebug-proxy --dev

लेकिन अगर आप अपनी परियोजना में अतिरिक्त निर्भरता को नहीं खींचना चाहते हैं, तो PHP Xdebug प्रॉक्सी को एक ही संगीतकार के माध्यम से एक परियोजना के रूप में स्थापित किया जा सकता है:

 composer.phar create-project mougrim/php-xdebug-proxy cd php-xdebug-proxy

PHP Xdebug प्रॉक्सी एक्स्टेंसिबल है, लेकिन एक्सएमएल और एम्फ़पी / पार्सिंग के लिए एसिंक्रोनस लॉगिंग के लिए पार्सिंग के लिए डिफ़ॉल्ट रूप से एक्सटेंड -डोम की आवश्यकता होती है (PHP में डिफ़ॉल्ट रूप से एक्सटेंशन सक्षम होता है):

 composer.phar require amphp/log '^1.0.0'

लांच

PHP Xdebug प्रॉक्सी

प्रॉक्सी निम्नानुसार शुरू होती है:

 bin/xdebug-proxy

प्रॉक्सी डिफ़ॉल्ट सेटिंग्स के साथ शुरू होगा:

 Using config path /path/to/php-xdebug-proxy/config [2019-02-14 10:46:24] xdebug-proxy.NOTICE: Use default ide: 127.0.0.1:9000 array ( ) array ( ) [2019-02-14 10:46:24] xdebug-proxy.NOTICE: Use predefined ides array ( 'predefinedIdeList' => array ( 'idekey' => '127.0.0.1:9000', ), ) array ( ) [2019-02-14 10:46:24] xdebug-proxy.NOTICE: [Proxy][IdeRegistration] Listening for new connections on '127.0.0.1:9001'... array ( ) array ( ) [2019-02-14 10:46:24] xdebug-proxy.NOTICE: [Proxy][Xdebug] Listening for new connections on '127.0.0.1:9002'... array ( ) array ( )

लॉग से आप देख सकते हैं कि डिफ़ॉल्ट प्रॉक्सी:

आईडीई लॉगिन कनेक्शन के लिए 127.0.0.1:9001 लिए सुनता है;
Xdebug कनेक्शन के लिए 127.0.0.1:9002 लिए सुनता है;
डिफ़ॉल्ट IDE और idekey कुंजी के साथ पूर्वनिर्धारित IDE के रूप में 127.0.0.1:9000 का उपयोग करता है।

विन्यास

यदि आप श्रवण पोर्ट आदि को कॉन्फ़िगर करना चाहते हैं, तो आप सेटिंग फ़ोल्डर में पथ निर्दिष्ट कर सकते हैं। बस कॉन्फ़िगर फ़ोल्डर की प्रतिलिपि बनाएँ:

 cp -r /path/to/php-xdebug-proxy/config /your/custom/path

सेटिंग्स फ़ोल्डर में तीन फाइलें हैं:

config.php :

 <?php return [ 'xdebugServer' => [ // host:port    Xdebug 'listen' => '127.0.0.1:9002', ], 'ideServer' => [ //  proxy    IDE,     IDE  , //    IDE  ,     . // IDE   ,  proxy    . 'defaultIde' => '127.0.0.1:9000', //  IDE    'idekey' => 'host:port', //   IDE  ,     . //  IDE ,   proxy  , //           proxy. 'predefinedIdeList' => [ 'idekey' => '127.0.0.1:9000', ], ], 'ideRegistrationServer' => [ // host:port     IDE, //     IDE,     . 'listen' => '127.0.0.1:9001', ], ];

logger.php : आप logger.php को कॉन्फ़िगर कर सकते हैं; फ़ाइल को एक ऐसी वस्तु वापस करनी चाहिए जो \Psr\Log\LoggerInterface का एक उदाहरण है, डिफ़ॉल्ट \Amp\Log\StreamHandler साथ \Amp\Log\StreamHandler \Monolog\Logger (गैर-अवरुद्ध रिकॉर्डिंग के लिए), \Amp\Log\StreamHandler लॉग प्रदर्शित करता है;
factory.php : आप उन कक्षाओं को कॉन्फ़िगर कर सकते हैं जो प्रॉक्सी में उपयोग किए जाते हैं; फ़ाइल को एक ऐसी वस्तु वापस करनी चाहिए जो कि Factory\Factory का एक उदाहरण है, डिफ़ॉल्ट Factory\DefaultFactory ।

फ़ाइलों की प्रतिलिपि बनाने के बाद, आप प्रॉक्सी को संपादित और चला सकते हैं:

 bin/xdebug-proxy --configs=/your/custom/path/config

डिबगिंग

Xdebug का उपयोग करके कोड को डीबग करने के तरीके पर कई लेख लिखे गए हैं। मैं मुख्य बिंदुओं पर ध्यान दूंगा।

[xdebug] में, निम्नलिखित सेटिंग्स [xdebug] अनुभाग में होनी चाहिए (यदि वे मानक लोगों से भिन्न हैं तो उन्हें सही करें):

idekey = विचारधारा
Remote_host = 127.0.0.1
रिमोट_पोर्ट = 9002
Remote_enable = पर
Remote_autostart = पर
Remote_connect_back = बंद

तब आप डीबग किए गए PHP कोड चला सकते हैं:

 php /path/to/your/script.php

यदि आपने सब कुछ सही किया है, तो आईडीई में पहले ब्रेकपॉइंट से डिबगिंग शुरू हो जाएगी। कई डेवलपर्स द्वारा php-fpm मोड में डिबगिंग इस लेख के दायरे से परे है, लेकिन उदाहरण के लिए, यहाँ वर्णित है ।

विस्तार प्रॉक्सी सुविधाएँ

सब कुछ है कि हम ऊपर की जांच की, pydbgpproxy भी एक डिग्री या किसी अन्य के लिए सक्षम है।

अब आइए PHP Xdebug प्रॉक्सी में सबसे दिलचस्प बात करते हैं। अपने खुद के कारखाने का उपयोग करके प्रॉक्सी का विस्तार किया जा सकता है (फ़ैक्टरी में बनाया गया। factory.php कॉन्फ़िगरेशन, ऊपर देखें)। Factory\Factory को Factory\Factory इंटरफ़ेस लागू करना चाहिए।

सबसे शक्तिशाली तथाकथित अनुरोध तैयार करने वाले हैं। वे Xdebug से IDE और इसके विपरीत अनुरोधों को संशोधित कर सकते हैं। क्वेरी Factory\DefaultFactory::createRequestPreparers() जोड़ने के लिए, आपको Factory\DefaultFactory::createRequestPreparers() विधि को ओवरराइड करना होगा। विधि ऑब्जेक्ट की एक सरणी देता है जो RequestPreparer\RequestPreparer इंटरफ़ेस को लागू करता है। XEebug से IDE के लिए अनुरोध करते समय, उन्हें सीधे क्रम में निष्पादित किया जाता है; जब IDE से Xdebug के लिए अनुरोध का अनुरोध किया जाता है, तो इसे उलट दिया जाता है।

क्वेरी हैंडलर का उपयोग किया जा सकता है, उदाहरण के लिए, फ़ाइलों (ब्रेकपॉइंट और निष्पादन योग्य फ़ाइलों में) के पथ बदलने के लिए।

डीबग फ़ाइल अधिलेखित करें

एक तैयारी करने वाले का उदाहरण देने के लिए, मैं एक छोटा सा विषयांतर करूंगा। यूनिट परीक्षणों में, हम सॉफ्ट-मोक्स ( GitHub ) का उपयोग करते हैं। शीतल-मक्स आपको कार्यों, स्थिर विधियों, स्थिरांक आदि को परीक्षणों में बदलने की अनुमति देता है, यह रनकिट और योप्ज़ का विकल्प है। यह मक्खी पर PHP फ़ाइलों को फिर से लिखने का काम करता है। इसी तरह, AspectMock अभी भी काम करता है।

लेकिन Xdebug और IDE की मानक विशेषताएं आपको मूल फ़ाइलों के बजाय पुन: लिखित (अलग पथ होने) को डीबग करने की अनुमति देती हैं।

आइए परीक्षणों में नरम-नकली का उपयोग करते हुए डिबगिंग समस्या पर करीब से नज़र डालें। सबसे पहले, उस मामले को लें जहां PHP कोड को स्थानीय रूप से निष्पादित किया जाता है।

ब्रेकपॉइंट्स (ब्रेकपॉइंट्स) सेट करने के चरण में पहली कठिनाइयाँ दिखाई देती हैं। आईडीई में, वे मूल फ़ाइलों में इंस्टॉल किए जाते हैं, पुनर्लेखन वाले में नहीं। आईडीई के माध्यम से एक ब्रेकपॉइंट लगाने के लिए, आपको वास्तविक लिखित फ़ाइल ढूंढनी होगी। समस्या को इस तथ्य से जटिल किया जाता है कि हर बार जब मूल फ़ाइल को बदल दिया जाता है, तो एक नई पुनर्लेखन फ़ाइल बनाई जाती है, अर्थात प्रत्येक अद्वितीय फ़ाइल सामग्री के लिए एक अद्वितीय पुनर्लेखन फ़ाइल होगी।

इस समस्या को xdebug_break() फ़ंक्शन को कॉल करके हल किया जा सकता है, जो ब्रेकपॉइंट सेट करने के समान है। इस मामले में, फिर से लिखे गए फ़ाइल को खोजने की आवश्यकता नहीं है।

अब स्थिति को और अधिक जटिल मानें: एप्लिकेशन रिमोट मशीन पर चलता है।

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

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

AspectMock डिबग मोड को सक्षम करने के लिए इसे निष्क्रिय करने की क्षमता के बिना समस्या के आसपास मिला:

 public function init(array $options = []) { if (!isset($options['excludePaths'])) { $options['excludePaths'] = []; } $options['debug'] = true; $options['excludePaths'][] = __DIR__; parent::init($options); }

एक साधारण परीक्षण उदाहरण में, डिबग मोड 20 प्रतिशत से बहुत कम है। लेकिन मेरे पास पर्याप्त पहलू का परीक्षण करने के लिए पर्याप्त सटीक अनुमान नहीं है कि यह कितना धीमा है। यदि आपके पास AspectMock पर कई परीक्षण हैं, तो यदि आप टिप्पणियों में तुलना साझा करते हैं, तो मुझे खुशी होगी।

सॉफ्ट-मोक्स के साथ Xdebug का उपयोग करना

Xdebug + सॉफ्ट-मोक्स

अब जब समस्या स्पष्ट हो गई है, तो विचार करें कि PHP Xdebug प्रॉक्सी का उपयोग करके इसे कैसे हल किया जाए। मुख्य भाग RequestPreparer\SoftMocksRequestPreparer ।

क्लास कंस्ट्रक्टर में, सॉफ्ट-मोक्स इनिशियलाइज़ेशन स्क्रिप्ट के लिए पथ को परिभाषित करें और इसे चलाएं (यह माना जाता है कि सॉफ्ट-मोक्स एक निर्भरता के रूप में जुड़ा हुआ है, लेकिन किसी भी पथ को कंस्ट्रक्टर को पास किया जा सकता है):

 public function __construct(LoggerInterface $logger, string $initScript = '') { $this->logger = $logger; if (!$initScript) { $possibleInitScriptPaths = [ // proxy   , soft-mocks —    __DIR__.'/../../vendor/badoo/soft-mocks/src/init_with_composer.php', // proxy  soft-mocks    __DIR__.'/../../../../badoo/soft-mocks/src/init_with_composer.php', ]; foreach ($possibleInitScriptPaths as $possiblInitScriptPath) { if (file_exists($possiblInitScriptPath)) { $initScript = $possiblInitScriptPath; break; } } } if (!$initScript) { throw new Error("Can't find soft-mocks init script"); } //  soft-mocks (       ..) require $initScript; }

Xdebug + soft-mocks: Xdebug से IDE तक

XEebug से IDE के लिए एक अनुरोध तैयार करने के लिए, आपको मूल फ़ाइल के साथ फिर से लिखे गए फ़ाइल में पथ को बदलना होगा:

 public function prepareRequestToIde(XmlDocument $xmlRequest, string $rawRequest): void { $context = [ 'request' => $rawRequest, ]; $root = $xmlRequest->getRoot(); if (!$root) { return; } foreach ($root->getChildren() as $child) { //         : // - 'stack': https://xdebug.org/docs-dbgp.php#stack-get // - 'xdebug:message': https://xdebug.org/docs-dbgp.php#error-notification if (!in_array($child->getName(), ['stack', 'xdebug:message'], true)) { continue; } $attributes = $child->getAttributes(); if (isset($attributes['filename'])) { //         ,      $filename = $this->getOriginalFilePath($attributes['filename'], $context); if ($attributes['filename'] !== $filename) { $this->logger->info("Change '{$attributes['filename']}' to '{$filename}'", $context); $child->addAttribute('filename', $filename); } } } }

Xdebug + soft-mocks: IDE से Xdebug तक

IDE से Xdebug के लिए एक अनुरोध तैयार करने के लिए, आपको मूल फ़ाइल को फिर से लिखने के लिए पथ को बदलने की आवश्यकता है:

 public function prepareRequestToXdebug(string $request, CommandToXdebugParser $commandToXdebugParser): string { //       [$command, $arguments] = $commandToXdebugParser->parseCommand($request); $context = [ 'request' => $request, 'arguments' => $arguments, ]; if ($command === 'breakpoint_set') { //    -f,          // . https://xdebug.org/docs-dbgp.php#id3 if (isset($arguments['-f'])) { $file = $this->getRewrittenFilePath($arguments['-f'], $context); if ($file) { $this->logger->info("Change '{$arguments['-f']}' to '{$file}'", $context); $arguments['-f'] = $file; //    $request = $commandToXdebugParser->buildCommand($command, $arguments); } } else { $this->logger->error("Command {$command} is without argument '-f'", $context); } } return $request; }

काम Factory\DefaultFactory के लिए क्वेरी Factory\DefaultFactory लिए, आपको अपना कारखाना वर्ग बनाने की आवश्यकता है और या तो इसे Factory\DefaultFactory से विरासत में मिला है, या Factory\Factory इंटरफ़ेस को लागू करना है। सॉफ्ट- Factory\SoftMocksFactory लिए, Factory\SoftMocksFactory इस तरह दिखता है:

 class SoftMocksFactory extends DefaultFactory { public function createConfig(array $config): Config { //       return new SoftMocksConfig($config); } public function createRequestPreparers(LoggerInterface $logger, Config $config): array { $requestPreparers = parent::createRequestPreparers($logger, $config); return array_merge($requestPreparers, [$this->createSoftMocksRequestPreparer($logger, $config)]); } public function createSoftMocksRequestPreparer(LoggerInterface $logger, SoftMocksConfig $config): SoftMocksRequestPreparer { //     init-   return new SoftMocksRequestPreparer($logger, $config->getSoftMocks()->getInitScript()); } }

यहां आपको अपने स्वयं के कॉन्फ़िगरेशन वर्ग की आवश्यकता है ताकि आप सॉफ्ट-मोक्स इनिट स्क्रिप्ट का पथ निर्दिष्ट कर सकें। यह क्या है, आप कॉन्फ़िग \ सॉफ्टमॉक्सकॉन्फ़ में देख सकते हैं।

केवल थोड़ा ही रह गया: एक नया कारखाना बनाने और सॉफ्ट-मोक्स इनिट स्क्रिप्ट के लिए पथ को इंगित करने के लिए। यह कैसे किया जाता है इसे softMocksConfig में देखा जा सकता है।

गैर-अवरुद्ध एपीआई

जैसा कि मैंने ऊपर लिखा है, PHP Xdebug प्रॉक्सी हुड के तहत एम्पीपी का उपयोग करता है, जिसका अर्थ है कि I / O के साथ काम करने के लिए एक गैर-अवरुद्ध एपीआई का उपयोग किया जाना चाहिए । Apmphp में पहले से ही कई घटक हैं जो इस गैर-अवरुद्ध एपीआई को लागू करते हैं। यदि आप PHP Xdebug प्रॉक्सी का विस्तार करने जा रहे हैं और इसका उपयोग बहु-उपयोगकर्ता मोड में कर रहे हैं, तो गैर-अवरुद्ध एपीआई का उपयोग करना सुनिश्चित करें।

निष्कर्ष

PHP Xdebug प्रॉक्सी अभी भी एक काफी युवा परियोजना है, लेकिन Badoo में यह पहले से ही सॉफ्ट-मोक्स का उपयोग करके परीक्षणों को डीबग करने के लिए सक्रिय रूप से उपयोग किया जाता है।

PHP Xdebug प्रॉक्सी:

बहु-उपयोगकर्ता डिबगिंग में pydbgpproxy की जगह;
नरम-नकली के साथ काम कर सकते हैं;
विस्तार किया जा सकता है:
- आप IDE और Xdebug से आने वाली फ़ाइलों के लिए रास्तों को बदल सकते हैं;
- आँकड़े एकत्र किए जा सकते हैं: डिबग मोड में, कम से कम निष्पादन योग्य संदर्भ उपलब्ध है जब डिबगिंग (चर के मान और कोड की निष्पादन योग्य रेखा)।

यदि आप बहुउद्देशीय डिबगिंग के अलावा किसी अन्य चीज़ के लिए Xdebug प्रॉक्सी का उपयोग करते हैं, तो अपने मामले और आपके द्वारा उपयोग किए जाने वाले Xdebug प्रॉक्सी को टिप्पणियों में साझा करें।

यदि आप pydbgpproxy या कुछ अन्य Xdebug प्रॉक्सी का उपयोग करते हैं, तो PHP Xdebug प्रॉक्सी आज़माएं, अपनी समस्याओं के बारे में बताएं, पुल अनुरोध साझा करें। चलो एक साथ परियोजना का विकास! :)

PS मेरे सहयोगी Yevgeny मखरोव उर्फ ez को प्रॉक्सी smdbgpproxy के विचार के लिए धन्यवाद !

फिर से लिंक

PHP Xdebug प्रॉक्सी - Xdebug प्रॉक्सी, जिसकी चर्चा लेख में की गई है;
pydbgpproxy यहाँ डाउनलोड किया जा सकता है - अचानक, पायथन रिमोट डिबगिंग क्लाइंट;
amphp - अतुल्यकालिक गैर-अवरुद्ध PHP फ्रेमवर्क;
मॉक-एस के लिए उपकरण:
- नरम-नकली ;
- AspectMock ;
- ऊपज़ ;
- भागना ।

आपका ध्यान के लिए धन्यवाद!

मुझे टिप्पणियों और सुझावों पर खुशी होगी।

रिनट अखमदेव, सीनियर PHP डेवलपर

UPD : लेख का अंग्रेजी में अनुवाद।