सोनारक्यूब और इंटेलीज आईडीईए: सही एकीकरण

सोनारक्यूब सॉफ्टवेयर विकास प्रक्रिया में स्थैतिक कोड विश्लेषण शुरू करने के लिए एक उत्कृष्ट उपकरण है। यह हमारी कंपनी में उपयोग किए गए दोनों जावा और बड़ी संख्या में अन्य प्रोग्रामिंग भाषाओं का समर्थन करता है।

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

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

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

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

• CheckStyle
• स्पॉटबग्स (जिसे पहले फाइंडबग्स कहा जाता था, लेकिन इसका नाम बदलने के साथ-साथ एनालाइजर का भी नाम बदल दिया गया)
• PMD

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

इस समस्या को हल करने के लिए, विभिन्न आईडीई में प्लगइन्स होते हैं जो आपको सोनारक्यूब सर्वर से जानकारी निकालने और इसे सीधे कोड संपादक में प्रदर्शित करने की अनुमति देते हैं। IntelliJ IDEA के मामले में, यह सबसे पहले है, सोनारलिंट - सोनारक्यूब के डेवलपर्स से आधिकारिक प्लगइन। यह सक्रिय निरीक्षण की सेटिंग्स के साथ सर्वर से केवल एक प्रोफ़ाइल लेता है, और विश्लेषण खुद आईडीई में एक छापा बनाता है। यह विकास की गुणवत्ता में काफी सुधार करता है, जिससे आप तुरंत सभी नई टिप्पणियों को देख सकते हैं और उन्हें जल्दी ठीक कर सकते हैं। लेकिन मरहम में एक मक्खी है। सोनारलिंट सोनारक्यूब के स्वयं के निरीक्षणों के साथ विशेष रूप से काम करता है, अन्य सभी निरीक्षणों को पूरी तरह से अनदेखा करता है। आप FindBugs, या CheckStyle या PMD से टिप्पणियां नहीं देखेंगे। लेकिन इसमें बहुत सारी मूल्यवान जानकारी हो सकती है।

लेकिन निराशा न करें: सोनारक्यूब सर्वर सभी विश्लेषणकर्ताओं के लिए सेटिंग्स निर्यात कर सकता है, जिसका अर्थ है कि मानक आईडीईए प्लग-इन को कॉन्फ़िगर करना संभव है ताकि वे सर्वर एक के बराबर एक परिणाम उत्पन्न करें।

आइए इन सेटिंग्स से क्रम में निपटें।

सोनारलिंट को कॉन्फ़िगर करें

यहां कोई चाल नहीं है। हम IDEA सेटिंग्स में जाते हैं और Plugins सेक्शन में हम सोनारलिंट प्लगइन खोजते हैं और इसे इंस्टॉल करते हैं।

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

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

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

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

सोनारलिंट के साथ काम करने का एक उदाहरण नीचे देखा जा सकता है (चित्र क्लिक करने योग्य है):

अगर कुछ गलत हुआ

ऐसे हालात होते हैं जब सोनारलिंट किसी कारण से काम करने से मना कर देता है। इस मामले में, सोनारलिंट की खिड़की में, आप लॉग टैब पर जा सकते हैं और देख सकते हैं कि क्या हुआ। लेकिन, दुर्भाग्य से, इस लॉग में जानकारी हमेशा स्पष्ट और पर्याप्त नहीं है।

उदाहरण के लिए, IntelliJ IDEA (2019.2) की अंतिम रिलीज़ के बाद, मैंने इस त्रुटि के साथ काम करना बंद कर दिया:

यह बहुत जानकारीपूर्ण है ... और मुझे यह पता नहीं चल सका कि मुझे अपने बारे में अधिक जानकारी कैसे प्राप्त करनी है।

सोनारक्यूब वेबसाइट पर एफएक्यू द्वारा स्थिति को बचाया गया था। यह पता चलता है कि IDEA में सोनारलिंट विंडो में, आप त्रुटि लॉगिंग के स्तर को बदल सकते हैं:

यदि आप चयनित आइटम का चयन करते हैं, तो एक अधिक विस्तृत लॉग दिखाई देना शुरू हो जाएगा, जिससे आप पहले से ही समझ सकते हैं कि क्या हो रहा है:

अहा! अब त्रुटि दिखाई दी, और यह स्पष्ट हो गया कि क्या हो रहा था।

वास्तव में, एक अप्रिय संस्करण संघर्ष था। हमारे अनुप्रयोग अभी भी जावा 8 का उपयोग करते हैं और सोनारक्यूब 7.1 पर परीक्षण किए जाते हैं। इसी समय, मुख्य विकास शाखा और पुल अनुरोध के बीच त्रुटियों में अंतर का विश्लेषण करने के लिए पूरी उत्पादन प्रक्रिया सोनारक्यूब की क्षमताओं से बंधी है।

लेकिन सबसे अप्रिय बात यह है कि सोनारक्यूब 7.2 के बाद से यह सुविधा भुगतान हो गई है, यही वजह है कि हम अभी भी नवीनतम संस्करण में अपडेट नहीं हुए हैं। और जावा 11 के लिए समर्थन केवल सोनारक्यूब 7.3 में लागू किया गया था।

एक अन्य महत्वपूर्ण बिंदु यह है कि कोड का विश्लेषण करते समय सोनारलिंट प्लगइन, जेआरई इंटेलीजे आईडिया चलाने वाले की मदद से स्रोत कोड को संकलित करता है। जबकि IDEA ने जावा 8 पर काम किया, हमारे साथ सब कुछ ठीक था। लेकिन जब उसने 2019.2 संस्करण में जावा 11 का उपयोग करने के लिए स्विच किया, तो सब कुछ अलग हो गया, क्योंकि वास्तव में जावा 11 बायटेकोड ( कक्षा फ़ाइल प्रमुख संस्करण 55 ) में संकलन है, और इसका विश्लेषण सर्वर पर स्थापित विश्लेषक के संस्करण द्वारा किया गया है, टी यानी इस बायोटेक प्रारूप का समर्थन नहीं कर रहा है। और यह एक ज्ञात मुद्दा है ।

जाहिरा तौर पर, आपको तत्काल नवीनतम संस्करण में सोनारक्यूब को अपडेट करने के तरीकों की तलाश करनी होगी। शायद एक तीसरे पक्ष के प्लगइन का उपयोग करके सोनारक्बी-समुदाय-शाखा-प्लगइन जो हमें आवश्यक फ़ंक्शन प्रदान करता है।

सोनारक्यूब से विश्लेषक सेटिंग डाउनलोड करना

सोनारलिंट को छोड़कर प्रत्येक प्लगइन्स को अपनी कॉन्फ़िगरेशन फ़ाइलों की आवश्यकता होती है, प्रत्येक अपने स्वयं के प्रारूप में। सौभाग्य से, सोनारक्यूब इन फ़ाइलों को डाउनलोड कर सकता है। वे विश्लेषण प्रोफ़ाइल सेटिंग्स विंडो में स्थित हैं।

वहां पहुंचने के लिए, आपको सोनारक्यूब सर्वर के वेब इंटरफेस में Quality Profile अनुभाग पर जाना होगा और उस प्रोफ़ाइल का चयन करना होगा जिसका उपयोग परियोजना का विश्लेषण करने के लिए किया जाता है:

खुलने वाले पृष्ठ पर, एक खंड प्रकट होता है जो प्रत्येक विश्लेषक के लिए सेटिंग्स को निर्यात करने के लिए लिंक प्रदान करता है:

FindBugs और PMD के लिए सेटिंग्स को XML एक्सटेंशन के साथ एक स्थानीय डिस्क पर अपलोड किया जाना चाहिए, लेकिन CheckStyle के लिए सेटिंग्स का उपयोग सीधे साइट से URL से किया जा सकता है।

CheckStyle कॉन्फ़िगर करें

IDEA में, प्लगइन को CheckStyle-IDEA कहा जाता है। उपयोग के संदर्भ में यह शायद सबसे अधिक समस्या-मुक्त प्लगइन है, क्योंकि यह आपको URL द्वारा सीधे सेटिंग्स लोड करने की अनुमति देता है और सोनारलिंट जैसे मॉड्यूल के बीच स्विच करने की आवश्यकता नहीं होती है।

कॉन्फ़िगरेशन कनेक्ट करने के लिए, IDEA सेटिंग्स पर जाएं और CheckStyle सेक्शन चुनें। अगला, आपको Configuration File तालिका में एक नया आइटम जोड़ने की आवश्यकता है:

और कॉन्फ़िगरेशन के स्रोत को इंगित करें:

इसके अलावा, सेटिंग्स विंडो टेबल में सक्रिय रूप से नए जोड़े गए कॉन्फ़िगरेशन को चिह्नित करना न भूलें।

यही है, अब आप CheckStyle विंडो पर जा सकते हैं और विश्लेषण (ऊपरी चयनित बटन) शुरू कर सकते हैं:

यदि सोनारक्यूब सर्वर पर प्रोफ़ाइल बदल गई है, तो आपको उसी विंडो में संबंधित बटन (नीचे चिह्नित बटन) पर क्लिक करके सेटिंग्स को अपडेट करना होगा।

FindBugs की स्थापना

IDEA में, प्लगइन FindBugs-IDEA कहा जाता है। पिछले प्लगइन्स की समीक्षा के विपरीत, यह सर्वर से सीधे सेटिंग्स नहीं ले सकता है और इसके लिए स्थानीय फ़ाइल की आवश्यकता होती है।

कॉन्फ़िगरेशन कनेक्ट करने के लिए, IDEA सेटिंग्स पर जाएं और FindBugs-IDEA सेक्शन का चयन करें। अगला, Filter टैब पर, Include filter files तालिका में Include filter files करने के लिए एक नया आइटम जोड़ें:

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

महत्वपूर्ण नोट 1: प्लगइन सेटिंग्स में एक Share टैब है, जिसमें सोनारक्यूब सेटिंग्स फ़ाइल को कनेक्ट करने का प्रस्ताव है। मैं इस सेटिंग का उपयोग करने की अनुशंसा नहीं करता, क्योंकि यह सही ढंग से काम नहीं करता था, लेकिन इसके परिणामों का गैर-तुच्छ व्यवहार किया जाता है। तथ्य यह है कि सिर्फ इस सेटिंग को हटाने से काम नहीं हुआ। प्लगइन ने सामान्य रूप से काम करना शुरू नहीं किया। काम को बहाल करने के लिए, मुझे परियोजना निर्देशिका में .idea/findbugs-idea.xml को हटाना पड़ा और सब कुछ फिर से कॉन्फ़िगर करना पड़ा।

महत्वपूर्ण नोट 2: यदि सोनारक्यूब सर्वर पर सेटिंग्स बदल गई हैं, तो आपको इसे फिर से डिस्क पर अपलोड करना होगा।

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

PMD सेटअप

IDEA में, प्लगइन को PMDPlugin कहा जाता है। FindBugs के समान, इस प्लगइन को डिस्क पर सेटिंग्स फ़ाइल की आवश्यकता होती है। कॉन्फ़िगर करने के लिए, IDEA सेटिंग्स पर जाएं और सोनारक्यूब से डाउनलोड की गई फ़ाइल जोड़ें:

फ़ाइल नाम एक महत्वपूर्ण भूमिका निभाता है, क्योंकि भविष्य में इसका उपयोग विश्लेषण शुरू करने के लिए संबंधित मेनू आइटम बनाने के लिए प्लगइन द्वारा किया जाएगा।

पड़ोसी योगदान में भी, आपको जावा के संस्करण को निर्दिष्ट करना होगा जो परियोजना का उपयोग करता है (ठीक है, उसी समय एन्कोडिंग):

अब आप संदर्भ मेनू का उपयोग करके वर्तमान फ़ाइल का विश्लेषण शुरू कर सकते हैं:

 Run PMD->Custom Rules-><  > 

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

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

निष्कर्ष

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

मुझे उम्मीद है कि यहां प्रस्तुत जानकारी से किसी को सामान्य रूप से और विशेष रूप से सोनारक्यूब के साथ स्थिर विश्लेषक के साथ दोस्ती करने में आसानी होगी।

मैं अपने सहकर्मियों को भी धन्यवाद देना चाहता हूं जिन्होंने मुझे इस लेख की प्रासंगिकता को लिखने और समर्थन करने में मदद की: दिमित्री ज़िमिचव, यूरी क्रुपिन और अर्योम गनेव।