Intellij IDEA插件開發(fā)入門詳解
現(xiàn)今的IDE盡管有如“洪水猛獸”般強大,但要知道再強大的IDE也沒法提供給使用者想要的一切功能,所以IDE一般都提供有API接口供開發(fā)者自行擴展。下面以Intellij IDEA 12下的插件開發(fā)為例,來看一下如何進一步增強IDE以適應開發(fā)者的需求。
1.創(chuàng)建Plugin工程
如果Module SDK中沒有可選的SDK,那么點擊New新添加一個SDK,目錄就選擇Intellij的安裝位置即可。
創(chuàng)建出的Plugin項目結(jié)構很簡單,只是在META-INF下多了一個plugin.xml配置文件,后文會介紹到它的用處。
2.讓插件Say哈嘍
2.1添加Component
在src目錄上Alt+Insert,可以看到New對話框中列出有三種組件,分別對應三種級別:Application、Project、Module Component。這里我們選擇Application Component作為實例,在彈出框中輸入一個名字例如MyComponent,這樣一個組件就創(chuàng)建出來了。
然后在MyComponent中添加一個SayHello的方法,其他方法暫不實現(xiàn),源代碼如下所示:
package com.cdai.plugin.rapidg; import com.intellij.openapi.components.ApplicationComponent; import com.intellij.openapi.ui.Messages; import org.jetbrains.annotations.NotNull; /** * My Component * User: cdai * Date: 13-11-4 * Time: 上午10:08 */ public class MyComponent implements ApplicationComponent { public MyComponent() { } public void initComponent() { // TODO: insert component initialization logic here } public void disposeComponent() { // TODO: insert component disposal logic here } @NotNull public String getComponentName() { return "MyComponent"; } public void sayHello() { // Show dialog with message Messages.showMessageDialog( "Hello World!", "Sample", Messages.getInformationIcon() ); } }
2.2添加Action
現(xiàn)在需要添加一個Action讓使用我們插件的用戶可以通過菜單或其他方式點擊到插件。
Action主要工作是創(chuàng)建一個Application和MyComponent對象,代碼如下:
package com.cdai.plugin.rapidg; import com.intellij.openapi.actionSystem.AnAction; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.openapi.application.Application; import com.intellij.openapi.application.ApplicationManager; /** * Say Hello Action * User: cdai * Date: 13-11-4 * Time: 上午10:16 */ public class SayHelloAction extends AnAction { @Override public void actionPerformed(AnActionEvent e) { Application application = ApplicationManager.getApplication(); MyComponent myComponent = application.getComponent(MyComponent.class); myComponent.sayHello(); } }
2.3配置文件
其實前面兩步新建Component和Action的同時,IDEA在幫我們自動將它們注冊到META-INF/plugin.xml中。
我們剛才添加的Application Component和Action會在<application-components>結(jié)點下,plugin.xml最終是下面的樣子:
<idea-plugin version="2"> <id>com.cdai.plugin.rapidg</id> <name>CDai's Rapid Generator Plugin</name> <version>1.0</version> <vendor email="dc_726@163.com" url="http://www.yourcompany.com">CDai</vendor> <description><![CDATA[ Enter short description for your plugin here.<br> <small>most HTML tags may be used</small> ]]></description> <change-notes><![CDATA[ Add change notes here.<br> <small>most HTML tags may be used</small> ]]> </change-notes> <!-- please see http://confluence.jetbrains.net/display/IDEADEV/Build+Number+Ranges for description --> <idea-version since-build="107.105"/> <!-- please see http://confluence.jetbrains.net/display/IDEADEV/Plugin+Compatibility+with+IntelliJ+Platform+Products on how to target different products --> <!-- uncomment to enable plugin in all products <depends>com.intellij.modules.lang</depends> --> <application-components> <!-- Add your application components here --> <component> <implementation-class>com.cdai.plugin.rapidg.MyComponent</implementation-class> </component> </application-components> <project-components> <!-- Add your project components here --> </project-components> <actions> <!-- Add your actions here --> <action id="SayHello" class="com.cdai.plugin.rapidg.SayHelloAction" text="Say Hello!"> <add-to-group group-id="WindowMenu" anchor="first"/> </action> </actions> <extensions defaultExtensionNs="com.intellij"> <!-- Add your extensions here --> </extensions> </idea-plugin>
3.運行調(diào)試
打開Run/Debug配置對話框,新加一個Plugin類型的,Use classpath of module選擇剛才的示例項目。
運行起來就會發(fā)現(xiàn),原來會啟動一個新的Intellij IDEA實例,重新走一遍啟動配置過程,可以看到插件的名字就是plugin.xml中<name>中的值。我們可以只選中我們剛開發(fā)的插件,忽略掉其他的。現(xiàn)在通過Window->Say Hello!就可以觸發(fā)我們的插件了,效果就是會彈出個對話框。
有趣的是,plugin.xml中其他的一些描述會在插件崩潰時顯示給用戶,將問題報告給插件作者。
4.插件配置面板
很多插件都是在Settings中有配置頁的,現(xiàn)在簡單介紹一下如何為我們的插件添加一個配置頁。
首先改造一下MyComponent類,主要變化就是多實現(xiàn)了一個Configurable接口。這個接口中有一個createComponent方法,這個方法返回Swing的JComponent對象就會顯示到Settings里。另外使用IDEA提供的Swing Designer設計器還是挺方便的,自動生成的樣式和布局代碼為了避免被修改,也不會被我們看到(與NetBeans不同),所以最終代碼很簡潔。
最終效果就是這樣的了,我們在設計器里設計的面板嵌入到了右邊。
5.帶對話框的插件
一種常見的插件就是點擊插件對應的菜單項后,彈出一個對話框(例如搜索工作空間里的類、提交SVN前的代碼確認等等)。其實很簡單,實現(xiàn)方法就是先創(chuàng)建一個Dialog,然后在Swing設計器中設計好Dialog中的控件布局,最后在Action中顯示出對話框。具體代碼就不列舉了,有需求可以找我索取。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
Java concurrency集合之LinkedBlockingDeque_動力節(jié)點Java學院整理
LinkedBlockingDeque是雙向鏈表實現(xiàn)的雙向并發(fā)阻塞隊列。該阻塞隊列同時支持FIFO和FILO兩種操作方式,即可以從隊列的頭和尾同時操作(插入/刪除);并且,該阻塞隊列是支持線程安全。2017-06-06java實現(xiàn)二叉樹的創(chuàng)建及5種遍歷方法(總結(jié))
下面小編就為大家?guī)硪黄猨ava實現(xiàn)二叉樹的創(chuàng)建及5種遍歷方法(總結(jié))。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-04-04淺談Java實現(xiàn)面向?qū)ο缶幊蘪ava oop
這篇文章主要介紹了淺談Java實現(xiàn)面向?qū)ο缶幊蘪ava oop,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-07-07SpringBoot整合Echarts實現(xiàn)用戶人數(shù)和性別展示功能(詳細步驟)
這篇文章主要介紹了SpringBoot整合Echarts實現(xiàn)用戶人數(shù)和性別展示,通過數(shù)據(jù)庫設計、實現(xiàn)數(shù)據(jù)訪問層、業(yè)務邏輯層和控制層的代碼編寫,以及前端頁面的開發(fā),本文詳細地介紹了SpringBoot整合Echarts的實現(xiàn)步驟和代碼,需要的朋友可以參考下2023-05-05