Intellij IDEA के लिए एक प्लगइन लिखना: फ़ाइल प्रकार पंजीकरण

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

इस लेख में, मैं Intellij IDEA में अपने फ़ाइल प्रकार को पंजीकृत करने के तरीके के बारे में बात करूंगा। यह आवश्यक हो सकता है यदि आप अपना स्वयं का भाषा प्लगइन लिख रहे हैं या फ़ाइलों के लिए एक बाहरी संपादक चलाना चाहते हैं। आइए Apache JMeter फ़ाइलों को एक उदाहरण के रूप में लेते हैं ( JMeter स्थापना की आवश्यकता नहीं है)।

तो, एक प्लगइन मॉड्यूल के साथ एक मौजूदा परियोजना खोलें या एक नया बनाएं। यह कैसे करना है इसका उल्लेख लेख में और आधिकारिक ट्यूटोरियल में किया जा सकता है।

नई फ़ाइल प्रकार

हमें 16x16 पिक्सेल के आइकन की आवश्यकता होगी। इसे /resources/icons फ़ोल्डर में सहेजें और स्रोत रूट के रूप में फ़ोल्डर को चिह्नित करें। आप आइकन को सीधे src में रख सकते हैं।


IntelliJ में प्रत्येक फ़ाइल प्रकार को com.intellij.openapi.fileTypes.FileType इंटरफ़ेस के कार्यान्वयन के रूप में com.intellij.openapi.fileTypes.FileType है। अपना खुद का कार्यान्वयन बनाएँ:

 public class JMeterFileType implements FileType { public static final JMeterFileType INSTANCE = new JMeterFileType(); @NotNull @Override public String getName() { return "JMeter"; } @NotNull @Override public String getDescription() { return "JMeter file"; } @NotNull @Override public String getDefaultExtension() { return "jmx"; } @Override public boolean isBinary() { return false; } @Override public boolean isReadOnly() { return false; } @Override public Icon getIcon() { return IconLoader.getIcon("/icons/beaker.png"); } @Override public String getCharset(@NotNull VirtualFile file, byte[] bytes) { return CharsetToolkit.UTF8; } } 

विधियों का उद्देश्य इंटरफ़ेस में JavaDoc'ah में पढ़ा जा सकता है , मैं केवल कुछ बिंदुओं का उल्लेख करूंगा।

• Intellij IDEA कोड में सिंगलेट्स का व्यापक रूप से उपयोग किया जाता है। आमतौर पर मैं उनसे बचने की कोशिश करता हूं, लेकिन यहां मैं सामान्य शैली का पालन करके INSTANCE फील्ड बना रहा हूं, जिसकी हमें जल्द ही आवश्यकता होगी।
• यदि isReadOnly सही है, तो फ़ाइल प्रकार फ़ाइल> सेटिंग्स> फ़ाइल प्रकार सेटिंग्स में बदला जा सकता है।
• isBinary प्रभावित करता है कि क्या फ़ाइल एक पाठ संपादक में खोली जाएगी। JMeter फ़ाइलें XML में XStream का उपयोग करके अनुक्रमित जावा ऑब्जेक्ट हैं। इस तरह की फ़ाइलों को अपने हाथों से लिखने का कोई मतलब नहीं है, लेकिन आप संस्करण नियंत्रण प्रणाली में परिवर्तन को ट्रैक कर सकते हैं।

फ़ाइल प्रकार पंजीकरण

अगला चरण सिस्टम में फ़ाइल प्रकार को पंजीकृत करना है। ऐसा करने के लिए, हमें com.intellij.openapi.fileTypes.FileTypeFactory वर्ग के वारिस की आवश्यकता है:

 public class JMeterFileTypeFactory extends FileTypeFactory { @Override public void createFileTypes(@NotNull FileTypeConsumer consumer) { consumer.consume(JMeterFileType.INSTANCE); } } 

यह JMeterFileTypeFactory में plugin.xml पंजीकृत करने के लिए बनी हुई है

 <idea-plugin version="2"> ... <extensions defaultExtensionNs="com.intellij"> ... <fileTypeFactory implementation="idea.plugin.jmeter.JMeterFileTypeFactory"/> </extensions> </idea-plugin> 

हो गया!

आइए देखें क्या हुआ। प्लगइन चलाएँ, और Intellij IDEA का एक नया उदाहरण शुरू होगा। फ़ाइल> सेटिंग> फ़ाइल प्रकार खोलें और देखें कि हमारी फ़ाइल प्रकार कैसे पंजीकृत है:


एक नया प्रोजेक्ट बनाएं और उसमें JMeter फ़ाइल जोड़ें। प्रोजेक्ट ट्री में, हम देखते हैं कि फ़ाइल में एक आइकन है, और फ़ाइल स्वयं संपादक में सादे पाठ के रूप में खुलती है।

सिंटेक्स हाइलाइटिंग

चूंकि JMeter फाइलें सादे XML हैं, इसलिए सिंटैक्स हाइलाइटिंग जोड़ते हैं। यह plugins.xml में एक पंक्ति के साथ किया जाता है:

 <idea-plugin version="2"> ... <extensions defaultExtensionNs="com.intellij"> ... <syntaxHighlighter key="JMeter" implementationClass="com.intellij.ide.highlighter.XmlFileHighlighter"/> </extensions> </idea-plugin> 

... अच्छा, या लगभग एक। यहां:

• key JMeterFileType.getName() द्वारा लौटाया गया मान है।
• implementationClass SyntaxHighlighter कार्यान्वयन है।

कार्यान्वयन के लिए कई तैयार किए गए वाक्यविन्यास हाइलाइटिंग हैं: HTML, Java, Regexp, आदि। आप खुद ही अपना सिंटैक्सHighlighter बना सकते हैं। लेकिन यह लेख के दायरे से परे है।

हम शुरू करते हैं और परिणाम देखते हैं:


भाषा प्लगइन्स के लिए सिंटैक्स हाइलाइटिंग थोड़ा अलग है। मैं विस्तार से नहीं बताऊंगा। मैं केवल उन वर्गों की सूची दूंगा जिन पर आपको ध्यान देना चाहिए:

• com.intellij.lang.Language
• com.intellij.openapi.fileTypes.LanguageFileType
• com.intellij.openapi.fileTypes.SyntaxHighlighterFactory (या LanguageFileTypeHighlighterProvider)

कुल मिलाकर

इसलिए, हम एक आइकन और सिंटैक्स हाइलाइटिंग के साथ Intellij IDEA में एक नया फ़ाइल प्रकार पंजीकृत करने में कामयाब रहे। प्लग-इन विकास के बारे में अधिक जानकारी आधिकारिक दस्तावेज , इंटेलीज आईडीईए स्रोत कोड, या फ़ोरम में देखी जा सकती है। पूरा पोस्ट कोड GitHub पर पाया जा सकता है ।