IntelliJ IDEA प्लगइन विकास। भाग २

हम Intellij IDEA प्रलेखन के साथ असमान लड़ाई जारी रखते हैं। पिछला हिस्सा यहाँ है ।

प्लगइन विन्यास फाइल

प्लगइन द्वारा प्रदान की गई सभी कार्यक्षमता, साथ ही लेखक के बारे में विवरण और जानकारी plugin.xml फ़ाइल में सूचीबद्ध हैं।
एक फ़ाइल की संरचना पर विचार करें जिसमें लगभग सभी महत्वपूर्ण तत्व मौजूद हैं।

<!-- url="..."  URL    (  Welcome Screen    "Plugins") --> <idea-plugin url="http://www.jetbrains.com/idea"> <!--   --> <name>VssIntegration</name> <!--   .       .   ,  -  <name> --> <id>VssIntegration</id> <!--   --> <description>Vss integration plugin</description> <!--     .      Web- --> <change-notes>Initial release of the plugin.</change-notes> <!--   --> <version>1.0</version> <!--  .   "url"     .   "email"     .   "logo"    1616,   JAR --> <vendor url="http://www.jetbrains.com" email="support@jetbrains.com" logo="icons/plugin.png">Foo Inc.</vendor> <!--        --> <depends>MyFirstPlugin</depends> <!--   --> <depends optional="true" config-file="mysecondplugin.xml">MySecondPlugin</depends> <!--       ( JavaHelp )  IDEA.  "file"   JAR   "help".  "path"     helpset. --> <helpset file="myhelp.jar" path="/Help.hs" /> <!--     ,    --> <idea-version since-build="3000" until-build="3999"/> <!--      --> <resource-bundle>messages.MyPluginBundle</resource-bundle> <!--    --> <application-components> <component> <!--  --> <interface-class>com.foo.Component1Interface</interface-class> <!--    --> <implementation-class>com.foo.impl.Component1Impl</implementation-class> </component> </application-components> <!--    --> <project-components> <component> <!--     --> <interface-class>com.foo.Component2</interface-class> <!--  "workspace"   "true",     *.iws   *.ipr (     JDOMExternalizable). --> <option name="workspace" value="true" /> <!--    "loadForDefaultProject",     - --> <loadForDefaultProject> </component> </project-components> <!--    --> <module-components> <component> <interface-class>com.foo.Component3</interface-class> </component> </module-components> <!--  --> <actions> <action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Collect _Garbage" description="Run garbage collector"> <keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/> </action> </actions> <!--  ,   .        .  "beanClass"  ,   . --> <extensionPoints> <extensionPoint name="testExtensionPoint" beanClass="com.foo.impl.MyExtensionBean"/> </extensionPoints> <!-- ,      ,    IDEA   .  "defaultExtensionNs"   ID    "com.intellij"     IDEA Core.    <extensions>      --> <extensions xmlns="VssIntegration"> <testExtensionPoint implementation="com.foo.impl.MyExtensionImpl"/> </extensions> </idea-plugin> 

क्रिया करना और अपडेट करना

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

क्रियाओं को समूहों में जोड़ा जा सकता है, जो बदले में, उपसमूहों को शामिल कर सकते हैं।
प्रत्येक क्रिया या समूह को एक विशिष्ट पहचानकर्ता सौंपा जाना चाहिए। अधिकांश मानक क्रियाओं के पहचानकर्ता वर्ग com.intellij.openapi.actionSystem.IdeActions में परिभाषित किए गए हैं।
प्रत्येक कार्रवाई को कई समूहों में शामिल किया जा सकता है, इसलिए उन्हें उपयोगकर्ता इंटरफ़ेस के विभिन्न स्थानों में प्रदर्शित किया जा सकता है। वे स्थान जहाँ क्रियाएँ प्रदर्शित की जा सकती हैं, ActionPlaces इंटरफ़ेस (उसी पैकेज से) में स्थिरांक के रूप में परिभाषित की जाती हैं। प्रस्तुति वर्ग का एक उदाहरण प्रत्येक स्थान के लिए बनाया गया है, इसलिए एक ही क्रिया में इंटरफ़ेस पर अलग-अलग स्थानों में एक अलग पाठ या आइकन हो सकता है। AnAction.getTemplatePresentation () विधि से वापसी मान की प्रतिलिपि बनाकर अलग-अलग अभ्यावेदन बनाए जाते हैं।

किसी क्रिया की स्थिति को अद्यतन करने के लिए, AnAction.update () विधि को समय-समय पर कहा जाता है। AnActionEvent प्रकार का एक ऑब्जेक्ट विधि को दिया जाता है, जो वर्तमान संदर्भ के बारे में जानकारी देता है और विशेष रूप से, विशिष्ट दृश्य जिसे अपडेट किया जाना चाहिए।

IDE की वर्तमान स्थिति के बारे में जानकारी प्राप्त करने के लिए, जिसमें सक्रिय प्रोजेक्ट, चयनित फ़ाइल, संपादक में चयनित पाठ, आदि, AnActionEvent.getData () विधि का उपयोग किया जा सकता है। इस विधि द्वारा स्वीकृत विभिन्न कुंजियों का वर्णन डेटाकेय वर्ग में किया गया है। प्रकार AnActionEvent का एक ऑब्जेक्ट भी एक्शनपेरफॉर्म () विधि से पास होता है।

एक्शन रिकॉर्डिंग

किसी क्रिया को पंजीकृत करने के लिए दो विकल्प हैं: plugin.xml फ़ाइल में या मैन्युअल रूप से घटक इनिशियलाइज़ेशन चरण में सूचीबद्ध करके।
पहले विकल्प पर विचार करें।

 <actions> <!--  <action>  ,    .   "id"    .   "class"   ,  .   "text"      .   "use-shortcut-of"    ,       .   "description"     .   "icon"     . --> <action id="VssIntegration.GarbageCollection" class="com.foo.impl.CollectGarbage" text="Collect _Garbage" description="Run garbage collector" icon="icons/garbage.png"> <!--  <add-to-group> ,        ( ).   "group-id"    .     DefaultActionGroup.   "anchor"    ("first", "last", "before"  "after").  "relative-to-action" ,  anchor  "before"  "after". --> <add-to-group group-id="ToolsMenu" relative-to-action="GenerateJavadoc" anchor="after"/> <!--  <keyboard-shortcut>   .   "first-keystroke"   .     Swing-.   "second-keystroke"   .   "keymap"  .     com.intellij.openapi.keymap.KeymapManager. --> <keyboard-shortcut first-keystroke="control alt G" second-keystroke="C" keymap="$default"/> <!--  <mouse-shortcut>     .     ,  : "button1", "button2", "button3"  ; "shift", "control", "meta", "alt", "altGraph"  ; "doubleClick" –   . --> <mouse-shortcut keystroke="control button3 doubleClick" keymap="$default"/> </action> <!--  <group>  .  <action>, <group>  <separator>      .   "popup" ,    .  popup="true",    ;  popup="false",     . --> <group class="com.foo.impl.MyActionGroup" id="TestActionGroup" text="Test Group" description="Group with test actions" icon="icons/testgroup.png" popup="true"> <action id="VssIntegration.TestAction" class="com.foo.impl.TestAction" text="My Test Action" description="My test action"/> <!--  <separator>    .      <add-to-group>. --> <separator/> <group id="TestActionGroup"/> <!--  <reference>      .   "ref"   . --> <reference ref="EditorCopy"/> <add-to-group group-id="MainMenu" relative-to-action="HelpMenu" anchor="before"/> </group> </actions> 

जावा कोड से सीधे कार्रवाई दर्ज करने के मामले में, दो चरणों का प्रदर्शन किया जाना चाहिए। सबसे पहले, पहचानकर्ता बाइंडिंग बनाने के लिए AnAction से प्राप्त एक वर्ग का एक उदाहरण ActionManager.registerAction () विधि से पास होना चाहिए। इसके बाद, कार्रवाई को एक या अधिक समूहों में जोड़ा जाना चाहिए। पहचानकर्ता द्वारा एक समूह का एक उदाहरण प्राप्त करने के लिए, ActionManager.getAction () पर कॉल करें और परिणाम को DefaultAAgGroup टाइप करें।
IDEA स्टार्टअप के दौरान कार्रवाई को पंजीकृत करने के लिए निम्न चरणों का पालन आवश्यक है:

1. एक वर्ग बनाएं जो ApplicationComponent इंटरफ़ेस को लागू करता है;
2. getComponentName, initComponent, और disComComponent तरीकों को ओवरराइड करें;
3. plugin.xml फ़ाइल के <application-components> अनुभाग में कक्षा को पंजीकृत करें।

स्पष्टता के लिए, हम एक उदाहरण कोड देते हैं जो वर्णित प्रक्रिया करता है।

 public class MyPluginRegistration implements ApplicationComponent { //      @NotNull public String getComponentName() { return "MyPlugin"; } //    MyPluginRegistration   <application-components> //      IDEA. public void initComponent() { ActionManager am = ActionManager.getInstance(); TextBoxes action = new TextBoxes(); //  . am.registerAction("MyPluginAction", action); //  ,      . DefaultActionGroup windowM = (DefaultActionGroup) am.getAction("WindowMenu"); //      . windowM.addSeparator(); windowM.add(action); } //      . public void disposeComponent() { } } 

कार्यों के लिए एक इंटरफ़ेस बनाना

यदि प्लगइन को किसी विशिष्ट इंटरफ़ेस के साथ टूलबार या पॉप-अप मेनू प्रदर्शित करने की आवश्यकता है, तो यह ActionPopupMenu और ActionToolbar कक्षाओं का उपयोग करके किया जा सकता है। उनकी वस्तुओं को ActionManager.createActionPopupMenu () और ActionManager.createActionToolbar () विधि से कॉल करके बनाया जा सकता है।

यदि क्रिया एक विशिष्ट घटक (उदाहरण के लिए, एक पैनल) में निहित है, तो आपको आमतौर पर ActionToolbar.setTargetComponent () कॉल करने की आवश्यकता होती है और इसे पैरामीटर के रूप में घटक की आवृत्ति के रूप में पास किया जाता है। यह सुनिश्चित करता है कि टूलबार बटन की स्थिति केवल संबंधित घटक की स्थिति पर निर्भर करती है, न कि आईडीई फ्रेम पर ध्यान केंद्रित करने पर।

घटक की स्थिति का संरक्षण

इंटेलीज आईडीईए एक एपीआई प्रदान करता है जो आईडीई लॉन्च के बीच अपने राज्य को बनाए रखने के लिए घटकों या सेवाओं की अनुमति देता है। आप PersistentStateComponent इंटरफ़ेस के उपयोग के माध्यम से आदिम प्रकार और समग्र ऑब्जेक्ट दोनों को बचा सकते हैं।

सरल मूल्यों को संग्रहीत करने के लिए PropertiesComponent का उपयोग करना

यदि आप केवल कुछ आदिम प्रकारों को सहेजना चाहते हैं, तो इसे प्राप्त करने का सबसे आसान तरीका है com.intellij.ide.util.PropertiesComponent सेवा। इसका उपयोग एप्लिकेशन स्तर और परियोजना स्तर (डेटा को कार्यक्षेत्र फ़ाइल में रखा गया है) दोनों के मूल्यों को बचाने के लिए किया जा सकता है।
PropertiesComponent.getInstance () विधि का उपयोग एप्लिकेशन स्तर मानों को सहेजने के लिए किया जाता है, और PropertiesComponent.getInstance (प्रोजेक्ट) का उपयोग प्रोजेक्ट स्तर मानों के लिए किया जाता है।

PersistentStateComponent Interface का उपयोग करना

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

PersistentStateComponent इंटरफ़ेस कार्यान्वयन

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

 class MyService implements PersistentStateComponent<MyService.State> { class State { public String value; } State myState; public State getState() { return myState; } public void loadState(State state) { myState = state; } } 

दूसरे मामले में, आप निम्नलिखित टेम्पलेट का उपयोग कर सकते हैं:

 class MyService implements PersistentStateComponent<MyService> { public String stateValue; public MyService getState() { return this; } public void loadState(MyService state) { XmlSerializerUtil.copyBean(state, this); } } 

राज्य वर्ग कार्यान्वयन

सहेजने से पहले, सेम फ़ील्ड के सार्वजनिक फ़ील्ड और गुणों को XML प्रारूप में क्रमबद्ध किया जाता है। निम्नलिखित प्रकारों को बचाया जा सकता है:

• पूर्णांक और भिन्नात्मक संख्या;
• बूलियन मान;
• लाइन;
• संग्रह;
• शब्दकोशों;
• लिस्टिंग।

सार्वजनिक क्षेत्र को क्रमिक मूल्यों से बाहर करने के लिए, इसे @Transient के साथ चिह्नित किया जाना चाहिए।
एक राज्य वर्ग में मापदंडों के बिना एक निर्माता होना चाहिए, जो डिफ़ॉल्ट मानों के साथ सभी क्षेत्रों को आरंभ करता है (XML फ़ाइल में सहेजने से पहले कक्षा को एक सुसंगत स्थिति में लाना आवश्यक है)।

भंडारण स्थान

यह निर्दिष्ट करने के लिए कि डेटा को विशेष रूप से कहाँ सहेजना है, आपको घटक वर्ग में @State एनोटेशन जोड़ना चाहिए, जिसमें आपको निम्नलिखित फ़ील्ड निर्दिष्ट करनी होंगी:

• "नाम" (आवश्यक) - राज्य का नाम (रूट टैग का नाम) परिभाषित करता है;
• एक या अधिक @Storage एनोटेशन (आवश्यक) - * .ipr फ़ाइलों के लिए भंडारण स्थानों को परिभाषित करता है;
• "रोमिंग टाइप" - रोमिंग का प्रकार (वैकल्पिक) - यह निर्धारित करता है कि सर्वर प्लगइन का उपयोग किए जाने पर राज्य विभिन्न आईडीईए उदाहरणों के बीच सिंक्रनाइज़ किया जाएगा या नहीं;
• "पुनः लोड करने योग्य" (वैकल्पिक) - यदि गलत है, तो बदले हुए स्थिति फ़ाइल को पुनः लोड करने के लिए पर्यावरण का एक पूरा पुनरारंभ आवश्यक है।

@Storage एनोटेशन का उपयोग करने के उदाहरण:

• @Storage(id="other", file = StoragePathMacros.APP_CONFIG + "/other.xml") - आवेदन स्तर के मूल्यों के लिए;
• @Storage(id="other", file = StoragePathMacros.PROJECT_FILE) - परियोजना फ़ाइल ( @Storage(id="other", file = StoragePathMacros.PROJECT_FILE) में संग्रहीत मानों के लिए;
• @Storage(id = "dir", file = StoragePathMacros.PROJECT_CONFIG_DIR + "/other.xml", scheme = StorageScheme.DIRECTORY_BASED)}) - प्रोजेक्ट निर्देशिका में संग्रहीत मानों के लिए;
• @Storage(id="other", file = StoragePathMacros.WORKSPACE_FILE) - कार्यक्षेत्र फ़ाइल में संग्रहीत मानों के लिए।

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

 @State( name = "AntConfiguration", storages = { @Storage(id = "default", file = StoragePathMacros.PROJECT_FILE), @Storage(id = "dir", file = StoragePathMacros.PROJECT_CONFIG_DIR + "/ant.xml", scheme = StorageScheme.DIRECTORY_BASED) } ) 

XML प्रारूप सेटिंग

यदि जारी राज्य सरल जावाबीन के लिए मैप नहीं करता है, तो राज्य वर्ग को org.jdom.Element से विरासत में प्राप्त करना संभव है। इस स्थिति में, गेटस्ट्रेट () विधि का उपयोग एक मनमाना संरचना के साथ एक्सएमएल तत्व के निर्माण के लिए किया जाता है। लोडस्टेट () विधि में, JDOM तत्व को डिसेर्बलाइज करना आवश्यक है।
बीन वर्गों के मानक क्रमांकन का उपयोग करने के लिए, एक कस्टम प्रारूप के साथ संयोजन में, आप एनोटेशन @Tag, @Attribute, @Property, @MapAnnotation, @AbstractCollection उपयोग कर सकते हैं।

अगले भाग में: प्रोजेक्ट संरचना, VFS।

चक्र के सभी लेख: 1 , 2 , 3 , 4 , 5 , 6 , 7 ।