IntelliJ के लिए प्लगइन्स विकसित करने के बारे में थोड़ा और

हाल ही में इंटेलीज आईडीई के लिए एक्सटेंशन के निर्माण के लेख हैबे पर दिखाई देने लगे - एक , और यहां एक और ।

मैं इस शानदार प्रवृत्ति को जारी रखूंगा और इन्टेलिज ओपनएपीआई के उन स्थानों का वर्णन करने की कोशिश करूंगा जिन्हें अभी तक छुआ नहीं गया है; और एक उदाहरण मज़ेदार कॉमिक्स के साथ प्लग-इन होगा।





विस्तार, वास्तव में, बस एक साधारण बात करता है - यह सॉकेट में मेरे पसंदीदा गीक एंड पोक से ताजा तस्वीरें प्रदर्शित करता है, समय-समय पर उन्हें साइट से डाउनलोड करके डिस्क पर कैशिंग करता है। सूत्र, वैसे, GitHub'e पर।

जो लोग विशेष रूप से सतर्क हैं - कॉमिक्स CC BY-SA 3.0 के अच्छे लाइसेंस के तहत हैं, इसलिए सब कुछ कानूनी है :)

प्रोजेक्ट के निर्माण के बाद से, plugin.xml और अन्य बुनियादी चीजों को लिखना - साथ ही प्रासंगिक प्रलेखन के लिंक - पहले से ही उपरोक्त लेखों में वर्णित हैं, हम इसे दोहराएंगे नहीं; और मैं उनके समाधानों के साथ विकास करते समय मेरे पास कुछ प्रश्नों का वर्णन करता हूँ।

प्रॉक्सी समर्थन

इंटेलीज आईडीईए (और अन्य आईडीई) एक प्रॉक्सी के माध्यम से नेटवर्क से कनेक्ट करने में सक्षम हैं, सेटिंग्स को प्रलेखन में विस्तार से वर्णित किया गया है ।

लेकिन अपने एक्सटेंशन को वैश्विक आईडीई सेटिंग्स का उपयोग करने के लिए, यह com.intellij.util.net.HttpConfigurable वर्ग की दिशा में देखने लायक है। इसके सार्वजनिक क्षेत्रों में सभी आवश्यक जानकारी हैं: USE_HTTP_PROXY ध्वज, उदाहरण के लिए, कहते हैं कि हम प्रॉक्सी का उपयोग करते हैं या नहीं; साथ ही मेजबान, बंदरगाह और उपयोगकर्ता के बारे में जानकारी।

सबसे आसान तरीका यह है कि आप प्रत्येक कनेक्शन के लिए इसे तैयार करके, विधि विधि का उपयोग करें:

  /** * Call this function before every HTTP connection. * If system configured to use HTTP proxy, this function * checks all required parameters and ask password if * required. * @param url URL for HTTP connection * @throws IOException */ public void prepareURL (String url) throws IOException { 

उदाहरण के लिए, कुछ url के लिए कोड में url यह इस तरह दिख सकता है:

  // Ensure that proxy (if any) is set up for this request. final HttpConfigurable httpConfigurable = HttpConfigurable.getInstance(); httpConfigurable.prepareURL(url.toExternalForm()); 

JetBrains फ़ोरम में, कोई शपथ लेता है कि यह विधि मदद नहीं करती है - लेकिन, मेरी राय में, वे व्यर्थ हैं।

प्लग-इन इनिशियलाइज़ेशन के दौरान प्रक्रिया शुरू करना

मुझे एक अलग धागा शुरू करने की आवश्यकता थी, जो समय-समय पर अपडेट के लिए मुख्य पृष्ठ की जांच करेगा।

यह ApplicationComponent मदद करेगा। प्लगिन संरचना लेख में, प्रलेखन में घटकों के प्रकार और उनके निर्माण को उल्लेखनीय रूप से वर्णित किया गया है।

हमारे घटक को plugin.xml जोड़ें:

  <application-components> <component> <implementation-class>com.abelsky.idea.geekandpoke.ComicsPlugin</implementation-class> <interface-class>com.abelsky.idea.geekandpoke.ComicsPlugin</interface-class> </component> </application-components> 

और इसमें हम initComponent विधि को परिभाषित करते हैं:

 public class ComicsPlugin implements ApplicationComponent { private static final int UPDATE_PERIOD = 15 * 60 * 60 * 1000; //         ; //    ProjectComponent -    . @Override public void initComponent() { startUpdateTimer(); } private void startUpdateTimer() { final Timer timer = new Timer("Geek and Poke updater"); timer.schedule(new TimerTask() { @Override public void run() { //   -   15 ... } }, 0, ComicsPlugin.UPDATE_PERIOD); } 

स्थानीयकरण

स्थानीयकरण के लिए इस स्निपेट का उपयोग करना सुविधाजनक है:

 package com.abelsky.idea.geekandpoke.messages; // ... public class MessageBundle { private static Reference<ResourceBundle> bundleRef; //     com/abelsky/idea/geekandpoke/messages/MessageBundle.properties // -  key-value .properties-. @NonNls private static final String BUNDLE = "com.abelsky.idea.geekandpoke.messages.MessageBundle"; private MessageBundle() { } public static String message(@PropertyKey(resourceBundle = BUNDLE)String key, Object... params) { return CommonBundle.message(getBundle(), key, params); } private static ResourceBundle getBundle() { ResourceBundle bundle = null; if (MessageBundle.bundleRef != null) { bundle = MessageBundle.bundleRef.get(); } if (bundle == null) { bundle = ResourceBundle.getBundle(BUNDLE); MessageBundle.bundleRef = new SoftReference<ResourceBundle>(bundle); } return bundle; } } 

यहां यह कई बिंदुओं पर ध्यान देने योग्य है।

सबसे पहले SoftBeference में ResourceBundle को स्टोर करना है। यह IDEA स्रोत कोड में एक काफी सामान्य अभ्यास है - गैर-लिंक में यथासंभव अधिक से अधिक वस्तुओं को रखने के लिए।

वैसे, मैं आपको com.intellij.reference.SoftReference वर्ग को देखने की सलाह देता हूं - यह स्वयं डेवलपर्स हैं जो java.lang.ref से कार्यान्वयन के बजाय इसका उपयोग करते java.lang.ref । अंतर यह है कि यदि आपको स्मृति रिसाव पर संदेह है, तो com.intellij.reference.SoftReference जल्दी से एक कड़ी से कड़ी में परिवर्तित हो सकता है, और यह प्रोफाइलिंग में मदद करेगा।

दूसरा है एनोटेशन org.jetbrains.annotations.PropertyKey । यह इंगित करता है कि एनोटेट विधि का तर्क केवल संसाधनबल पैरामीटर में निर्दिष्ट बंडल से एक स्ट्रिंग हो सकता है। इसके उपयोग से विश्वास होता है कि .properties फ़ाइल और कोड में चाबियाँ सिंक से बाहर नहीं हैं (और यहां तक ​​कि IDEA में रिफ्लेक्टिंग बहुत कुछ सीखता है, क्योंकि कुंजी और बंडल के बीच एक संबंध है)।

तीसरा, एनोटेशन org.jetbrains.annotations.NonNls / org.jetbrains.annotations.Nls , लाइनों को चिह्नित करना चाहिए जो (या, इसके विपरीत, नहीं) का अनुवाद किया जाना चाहिए। उपयोग के लिए JetBrains प्रलेखन यहाँ है ।

अधिसूचना

कुछ घटनाओं के लिए, मैं एक सुंदर अधिसूचना दिखाना चाहता हूं। उदाहरण के लिए:



यहाँ यह वर्ग com.intellij.notification.Notifications ओर देखने लायक है। उदाहरण के लिए, इस तरह:

  private void notifyNewEntry() { final Notification newEntryNotification = new Notification( /*   */ MessageBundle.message("notification.new.strip.group"), /*  */ MessageBundle.message("notification.new.strip.title"), /*  */ MessageBundle.message("notification.new.strip.content"), NotificationType.INFORMATION); //     UI- -      invokeLater. Notifications.Bus.notify(newEntryNotification); } 

अधिसूचना समूह आईडीई सेटिंग्स में प्रदर्शित होता है, अधिक विवरण के लिए, प्रलेखन देखें।

सेटिंग्स

दस्तावेज़ में प्लग-इन के लिए सेटिंग पृष्ठ को कैसे विस्तार से वर्णित किया गया है ।

लेकिन संक्षेप में, तो, सबसे पहले, plugin.xml में plugin.xml :

  <extensions defaultExtensionNs="com.intellij"> <!-- ... --> <applicationConfigurable instance="com.abelsky.idea.geekandpoke.ui.SettingsPanel"/> </extensions> 

दूसरे, हम com.intellij.openapi.options.Configurable इंटरफ़ेस com.intellij.openapi.options.Configurable लागू करते हैं। इनमें से, सबसे महत्वपूर्ण - createComponent - उस घटक को वापस करना चाहिए जिस पर हमारी सेटिंग्स प्रदर्शित होती हैं।

ऑफ़लाइन कैश

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

%USERPROFILE%/.IdeaIC11/config/plugins/PLUGIN_NAME में डिफ़ॉल्ट रूप से एक्सटेंशन स्थापित हैं; हालाँकि, यह पथ परिवर्तनशील idea.plugins.path को idea.properties में सेट करके बदला जा सकता है।

  // PLUGIN_ID -   id  plugin.xml. final PluginId id = PluginId.getId(PLUGIN_ID); final IdeaPluginDescriptor plugin = PluginManager.getPlugin(id); //    . File path = plugin.getPath(); 

परिणामी पथ, वैसे, आसानी से एक JAR फ़ाइल हो सकती है - यदि एक्सटेंशन एक अलग निर्देशिका में अनपैक नहीं किया गया है।

पुनश्च

मुझे उम्मीद है कि यह संक्षिप्त FAQ IntelliJ प्लेटफ़ॉर्म में शुरुआत करने वालों के लिए उपयोगी होगा। और इस बीच, मैं उस बिंदु पर आगे बढ़ता हूं जिसके लिए मैं यह सब समझने लगा था - एक बहुत ही रोचक प्रोग्रामिंग भाषा का समर्थन करने के लिए एक आईडिया प्लग-इन;)