साइकिल के लिए कांटों के माध्यम से जाओ, एक भाग: प्लगइन्स का उपयोग करके विज़ुअल स्टूडियो डीबगर को अनुकूलित करने की मूल बातें जानें

विज़ुअल स्टूडियो 2012 के नवाचारों में से एक कॉनकॉर्ड नामक एक नए कस्टम डिबगर की उपस्थिति के साथ था। इसकी घटक प्रणाली VSIX प्लग-इन को डिबगर के व्यवहार को अनुकूलित करने और नए, संदर्भ-संवेदनशील उपकरण लिखने की अनुमति देती है जो डिबगर का उपयोग उनकी आवश्यकताओं के लिए कर सकते हैं। इसका एपीआई कई QOL सुविधाएँ प्रदान करता है, जैसे कि प्रबंधित / अप्रबंधित कोड के बीच मार्शलिंग, एक दूरस्थ / स्थानीय रूप से डिबग की गई प्रक्रिया के साथ सहज एकीकरण, और बहुत कुछ। वास्तव में, लगभग सभी चीजें जो आईडीई में की जा सकती हैं, उन्हें कॉनकॉर्ड एपीआई का उपयोग करके प्रोग्रामेटिक रूप से किया जा सकता है! मक्खी पर विशिष्ट चर के मूल्यों को बदलें, अनुरोध पर कॉल फ़ंक्शंस (या विशेष रूप से प्रोग्राम को उन पर कॉल छोड़ें!), प्लगइन्स पीडीबी (!), चरण-दर-चरण बायपास और यहां तक ​​कि कोड संशोधन द्वारा खोज सकते हैं! बिल्ली खोलें और आप साइकिल निर्माण के क्षेत्र में इन अल्पज्ञात नवाचारों के बारे में जानेंगे।

आपको शुरू से शुरू करना चाहिए। डीबगर बनाम VSIXfig फ़ाइल की जानकारी को पढ़कर घटकों का पता लगाता है। बदले में, vsdconfig यह दर्शाता है कि प्लगइन घटकों द्वारा कौन से इंटरफेस को लागू किया गया है और इन घटकों को कैसे खोजना है (एक .dll फ़ाइल के लिए लिंक, वर्ग को दर्शाता है या, मूल कार्यान्वयन के मामले में, CLSID का संकेत देता है। मैं C # में उदाहरण दूंगा)। इसके अलावा, प्रत्येक घटक के लिए एक विशिष्ट पहचानकर्ता (GUID) इंगित किया गया है, साथ ही साथ इसका "स्तर" भी। एक स्तर वह है जो निर्धारित करता है कि किस क्रम में प्लगइन्स को संसाधित किया जाएगा, साथ ही इस प्रक्रिया को किस कार्यान्वयन में लोड किया जाएगा - आईडीई प्रक्रिया में या डीबग किए गए एप्लिकेशन की प्रक्रिया में। यह इस तथ्य के कारण है कि कुछ कार्यक्षमता केवल एक आईडीई के संदर्भ में काम कर सकती है, और इसके विपरीत - केवल एक डीबग प्रक्रिया के संदर्भ में। कुछ एपीआई फ़ंक्शंस वहीं और वहीं काम करते हैं। साथ ही, कई घटकों के अपने लेआउट नियम हैं, क्योंकि वे अपने निर्धारित स्तरों पर स्थित मौजूदा डिबगर तत्वों पर निर्भर हो सकते हैं। घटनाओं से बचने के लिए, मैं एक अलग सैंडबॉक्स में RTFM (https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.debugger.componentinterfaces?view=visualstudiosdk-2017) और स्वतंत्र प्रयोगों की सलाह देता हूं, जो एक दया नहीं होगी। यदि कुछ होता है तो हटाएं (यह जुड़ा हुआ है, फिर से, इस तरह की बारीकियों के साथ - कुछ मामलों में यह भी स्पष्ट नहीं है कि असेंबली या प्रकार लोड क्यों नहीं हो रहा है, क्योंकि मुझे अभी भी नहीं मिला कि लॉग कहां दिखाई देंगे जो समस्या का संकेत देगा। उदाहरण के लिए, एक निर्भरता के संदर्भ में जिसे लक्ष्य प्रक्रिया में लोड नहीं किया जा सकता है, यह आउटपुट सेंट में दिखाई दे सकता है di-, या नहीं। akuratno रहो, लगातार प्रतिबद्ध लेते हैं, और पहिया नशे में पीछे बैठने नहीं है)।

स्तरों की सूची इस प्रकार है (मैं अंग्रेजी में पाठ दूंगा ताकि पाठक RFTM कृत्यों को करते समय घटनाएं न हों):

आईडीई घटक स्तर (मान> 100,000):

लक्ष्य प्रक्रिया के घटकों के स्तर (मान <99.999):

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

1. विजुअल स्टूडियो खोलें। मेरे मामले में, 2017 सामुदायिक संस्करण
2. VSIX प्रोजेक्ट ( विजुअल C # -> एक्स्टेंसिबिलिटी टैब, या खोज के माध्यम से)। चलो इसे "HelloVSIX" कहते हैं
3. समाधान में एक नया वर्ग पुस्तकालय परियोजना जोड़ें, और इसे "DebuggeePlugin" कहें
4. हमने प्रोजेक्ट "DebuggeePlugin" पर प्रोजेक्ट "HelloVSIX" का संदर्भ दिया।
5. हमने असेंबली "Microsoft.VisualStudio.Debugger.Engine" का संदर्भ डिबग्यूप्लगिन परियोजना में रखा
6. प्रोजेक्ट "DebuggeePlugin" के लिए nuget पैकेज Microsoft.VSSDK.Debugger.VSDConfigTool का संदर्भ जोड़ें। यह वीएसडी कॉन्फिगरेशन जनरेट करने का हमारा टूल है।

अब, हम अपने प्लगइन को कुछ उपयोगी बनाने के लिए तैयार हैं। आइए सबसे सरल काम करते हैं - इसे एक मैसेजबॉक्स प्रदर्शित करें जो कहता है कि "हैलो VSIX" जब लक्ष्य प्रक्रिया एक प्रवेश बिंदु के पार आती है। ऐसा करने के लिए, हमें एक वर्ग बनाने की ज़रूरत है जो IDkmEntryPointNotification इंटरफ़ेस को लागू करता है, साथ ही कई कॉन्फ़िगरेशन फ़ाइलों को भरता है। DkmEntryPointNotificationService नामक एक नया सार्वजनिक वर्ग जोड़ें, और IDkmEntryPointNotification इंटरफ़ेस इनहेरिट करें, और अभी के लिए डिफ़ॉल्ट कार्यान्वयन छोड़ दें:

using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { throw new NotImplementedException(); } } } 

फ़ाइल को "डीबगेजप्लुगिन" प्रोजेक्ट में "DkmEntryPointNotificationService.vsdconfigxml" जोड़ें। प्रत्येक घोषित वर्ग के लिए जो Microsoft.VisualStudio.Debugger.ComponentInterfaces नामस्थान इंटरफ़ेस के कार्यान्वयन के माध्यम से सूचनाएं प्राप्त करना चाहिए, आपके पास ऐसी फ़ाइल होनी चाहिए। वैसे, एक ही कक्षा में एक साथ कई ऐसे इंटरफेस लागू करना संभव है। अब हमें अपनी ".vsdconfigxml" फ़ाइल की बिल्ड कार्रवाई को बदलने की आवश्यकता है। ऐसा करने के लिए, आपको प्रोजेक्ट फ़ाइल को मैन्युअल रूप से संपादित करना होगा (मैं गंभीरता से)। हम DebuggeePlugin प्रोजेक्ट को अनलोड करते हैं, और इसे स्टूडियो एडिटर के साथ खोलते हैं। हमें निम्नलिखित XLM टैग खोजने की आवश्यकता है:

 <None Include="DkmEntryPointNotificationService.vsdconfigxml" /> 

और इस टैग को अपने स्वयं के ItemGroup पर ले जाएं, प्रकार को कोई नहीं से बदलकर VsdConfigXmlFiles:

 <ItemGroup> <VsdConfigXmlFiles Include="DkmEntryPointNotificationService.vsdconfigxml" /> </ItemGroup> 

आप प्रोजेक्ट को सहेज और पुनः लोड कर सकते हैं।

अब, कॉन्फ़िगर पर जाएं। पहली बात: यदि डिबगनेग.लुगिन परियोजना में vsdconfig.xsd फ़ाइल जोड़ी जाती है, तो उसे हटा दिया जाना चाहिए। हम इसे अब बदल देंगे, क्योंकि कच्चे पाठ के साथ काम करना आसान है। DkmEntryPointNotificationService.vsdconfigxml खोलें और निम्न के साथ पाठ को बदलें:

 <?xml version="1.0" encoding="utf-8"?> <Configuration xmlns="http://schemas.microsoft.com/vstudio/vsdconfig/2008"> <ManagedComponent ComponentId="422413E1-450E-40A6-AE24-7E80A81CC668" ComponentLevel=^_^quot𘙮quot^_^ AssemblyName="DebuggeePlugin"> <Class Name="DebuggeePlugin.DkmEntryPointNotificationService"> <Implements> <InterfaceGroup> <NoFilter/> <Interface Name="IDkmEntryPointNotification"/> </InterfaceGroup> </Implements> </Class> </ManagedComponent> </Configuration> 

ऐसी किसी भी फाइल में, हमें निम्नलिखित बातों का संकेत देना होगा:

1. ComponentId - यह मान GUID पीढ़ी के उपकरण (उपकरण -> CreateGUID) का उपयोग करके उत्पन्न किया जा सकता है
2. कॉम्पोनेन्टवेल पदानुक्रम में हमारे घटक का स्तर है। ऊपर दी गई तालिका देखें और वांछित सीमा का चयन करने के लिए MSDN पर जानकारी में मदद करें।
3. असेंबली नाम हमारी विधानसभा का नाम है (समाधान नहीं!)। इस मामले में, एक DebuggeePlugin होगा
4. वर्ग का नाम - उस नामस्थान सहित इंगित किया जाना चाहिए जिसमें कक्षा स्थित है। इस मामले में, DebuggeePlugin.DkmEntryPointNotificationService
5. InterfaceGroup सरणी - इसमें प्रत्येक प्रविष्टि इस घटक द्वारा लागू किए गए इंटरफ़ेस को इंगित करती है। प्रत्येक इंटरफ़ेसग्रुप नोड के अंदर, इस समूह में, सभी के लिए इंटरफेस को इंगित करने वाला एक उप-नोड होना चाहिए, फ़िल्टर, लेकिन बाद में फ़िल्टर के साथ। अब हमारे पास केवल एक इंटरफ़ेस नोड है, और IdkmEntryPointNotification इंटरफ़ेस का नाम है। यदि हमारे पास कई इंटरफेस होते हैं, तो कई इंटरफ़ेस नोड होंगे।

मुझे आपको याद दिलाना है कि प्रत्येक वर्ग के लिए जिसे डिबगर से सूचनाएं प्राप्त करनी चाहिए, ऐसी फाइल होनी चाहिए। लेकिन मजा यहीं खत्म नहीं होता। इस तरह की प्रत्येक फ़ाइल, बाद में, परियोजना के आउटपुट डायरेक्टरी में .vsdconfig फ़ाइल में एकत्र की जाती है। और उन्हें प्लगइन मेनिफेस्ट में संदर्भित किया जाना चाहिए। यह निम्नानुसार किया जाता है:

1. हमने ".vsdconfigxml" फ़ाइल जनरेट करने के बाद, हमें ... एक बार समाधान एकत्र करना चाहिए, अन्यथा हमारे पास परियोजना के आउटपुट निर्देशिका में कोई .vsdconfig फ़ाइल नहीं होगी)
2. उसके बाद, source.extension.vsixmanifest फ़ाइल के लिए टेक्स्ट एडिटर खोलें और समापन पैकेजमेनिफेस्ट टैग से पहले निम्न कोड जोड़ें:

  <Assets> <Asset Type="DebuggerEngineExtension" d:Source="File" Path="DebuggeePlugin.vsdconfig" /> </Assets> 

यदि पूर्ण क्रियाओं के बाद, HelloVSIX प्रोजेक्ट में "DebuggeePlugin.vsdconfig" फ़ाइल दिखाई देती है, तो इसे परियोजना से हटा दिया जाना चाहिए और समाधान को फिर से एकत्र किया जाना चाहिए, अन्यथा इसे अपडेट नहीं किया जाएगा।

तैयारी का काम खत्म हो चुका है! आप हमारे प्लगइन को डीबग करना शुरू कर सकते हैं। यह VisualStudio का एक प्रायोगिक उदाहरण शुरू करके किया जाता है (VSIX परियोजनाओं के लिए यह डिफ़ॉल्ट डिबग लक्ष्य है, इसलिए कोई अतिरिक्त कदम आवश्यक नहीं हैं)। असल में, हम डीबग-> स्टार्टडेबगिंग पर क्लिक करते हैं और हमें विजुअलस्टैडियो का एक प्रयोगात्मक उदाहरण दिखाई देता है। इसमें, डिफ़ॉल्ट रूप से, हमारा प्लगइन पहले से ही स्थापित होना चाहिए। आप टूल-> एक्सटेंशन और अपडेट मेनू के माध्यम से इसे सत्यापित कर सकते हैं।

इस तथ्य के कारण कि हमने IDkmEntryPointNotification इंटरफ़ेस लागू किया है, हमें VisualStudio के एक प्रायोगिक उदाहरण में एक परीक्षण प्रोजेक्ट बनाना होगा। दरअसल, हम एक नया प्रोजेक्ट बनाते हैं, C ++ -> कंसोल एप्लिकेशन (C ++ का चयन करें, क्योंकि निम्नलिखित उदाहरणों में C ++ स्पेसिफिकेशंस शामिल होंगे) का चयन करें, इसे VSIXTestApp कहें , बिना किसी बदलाव के चलाएं, इकट्ठा करें और देखें कि हमारे प्रयोगात्मक उदाहरण ने डीबगेजप्लगिन विधि के अंदर एक अपवाद को फेंकना बंद कर दिया है। DkmEntryPointNotificationService.OnEntryPoint। बहुत बढ़िया! अब आपको MessageBox दिखाने की आवश्यकता है। ऐसा करने के लिए, डिबग्यूप्लगिन परियोजना के निम्नलिखित संदर्भों को जोड़ना आवश्यक है:

• Microsoft.VisualStudio.Shell.15.0
• Microsoft.VisualStudio.Shell.Interop
• Microsoft.VisualStudio.Shell.Interop.8.0
• Microsoft.VisualStudio.OLE.Interop

DkmEntryPointNotificationService.cs फ़ाइल की शुरुआत में दो प्रयोग जोड़ें:

 using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; 

और DkmEntryPointNotificationService.OnEntryPoint विधि में VsShellUtilities.ShowMessageBox विधि में एक कॉल जोड़ें:

 using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { VsShellUtilities.ShowMessageBox(Microsoft.VisualStudio.Shell.ServiceProvider.GlobalProvider, "Hello VSIX", "Hello VSIX", OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST); } } } 

हम पुनर्निर्माण करते हैं, स्टूडियो के एक प्रयोगात्मक उदाहरण को लॉन्च करते हैं, एक परीक्षण परियोजना और वॉयला लॉन्च करते हैं!

हम देखते हैं कि स्टूडियो के परीक्षण उदाहरण ने MessageBox बनाया!



और क्या, वास्तव में, लाभ?

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

कॉनकॉर्ड एपीआई का उपयोग करने में आगे की मदद के लिए, आप न केवल MSDN, बल्कि निम्नलिखित Microsoft रिपॉजिटरी के लिए भी देख सकते हैं:
github.com/microsoft/PTVS
github.com/Microsoft/ConcordExtensibilitySamples