开发环境
开发IDEA插件有以下这些依赖:
- IntelliJ IDEA Community Edition
- IntelliJ IDEA Community Edition 源码
- Plugin DevKit 插件
- IntelliJ Platform SDK
本地可能已经安装了Ultimate版本,但是还是需要安装IDEA的社区版本。因为商业版是闭源的,所以在调试时无法调试核心代码。社区版的安装包里是不包含源码的,所以需要手动从github上clone一份:
git clone --depth 1 git://git.jetbrains.org/idea/community.git idea
关于从源码运行IDEA的方法参考:Check Out And Build Community Edition
添加 IDEA jdk
虽然不知道原因,但是根据Check Out And Build Community Edition,需要建立一个IDEA jdk 来运行插件:
除非在Mac上使用官方JDK,否则需要手动添加%20/lib/tools.jar%20到classpath中。
配置%20IntelliJ%20Platform%20SDK
打开%20File%20|%20Project%20Structure%20新建一个%20IntelliJ%20Platform%20SDK:Java%20SDK%20选择刚刚建立的%20IDEA%20jdk:
然后可以把下载的%20IDEA%20社区版源码添加到源码路径中,这样在调试时,就可以调试%20IDEA%20自身的代码了:
第一个插件
新建工程
选择IntellJ%20Platform%20Plugin,然后Project%20SDK指定刚刚新建的plugin%20sdk:新建的插件项目:
插件根目录下有两个目录src和resources。src是插件代码目录,resource是插件资源目录,其中META-INF/plugin.xml是插件的描述文件,就像Java%20web项目的web.xml一样。plugin.xml%20默认的内容如下:
<idea-plugin>%20%20<id>com.your.company.unique.plugin.id</id>%20%20<name>Plugin%20display%20name%20here</name>%20%20<version>1.0</version>%20%20<vendor%20email="[email protected]"%20url="http://www.yourcompany.com">YourCompany</vendor>%20%20<description><![CDATA[%20%20%20%20%20%20Enter%20short%20description%20for%20your%20plugin%20here.<br>%20%20%20%20%20%20<em>most%20HTML%20tags%20may%20be%20used</em>%20%20%20%20]]></description>%20%20<change-notes><![CDATA[%20%20%20%20%20%20Add%20change%20notes%20here.<br>%20%20%20%20%20%20<em>most%20HTML%20tags%20may%20be%20used</em>%20%20%20%20]]>%20%20</change-notes>%20%20<!--%20please%20see%20http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html%20for%20description%20-->%20%20<idea-version%20since-build="145.0"/>%20%20<!--%20please%20see%20http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html%20%20%20%20%20%20%20on%20how%20to%20target%20different%20products%20-->%20%20<!--%20uncomment%20to%20enable%20plugin%20in%20all%20products%20%20<depends>com.intellij.modules.lang</depends>%20%20-->%20%20<extensions%20defaultExtensionNs="com.intellij">%20%20%20%20<!--%20Add%20your%20extensions%20here%20-->%20%20</extensions>%20%20<actions>%20%20%20%20<!--%20Add%20your%20actions%20here%20-->%20%20</actions></idea-plugin>
新建一个%20Action
插件扩展%20IDEA%20最常见的方式就是在菜单栏或者工具栏中添加菜单项,用户通过点击菜单项来触发插件功能。IDEA%20提供了%20AnAction%20类,这个类有一个虚方法%20actionPerformed,这个方法会在每次菜单被点击时调用。新建一个自定义的%20Action%20有两个步骤:
- 继承%20AnAction%20类,在%20actionPerformed%20方法中实现插件逻辑
- 注册%20action,有两种方式,通过代码注册和通过%20plugin.xml%20注册
先写一个简单的Action类:
public%20class%20TextBoxes%20extends%20AnAction%20{%20%20%20%20//%20如果通过Java代码来注册,这个构造函数会被调用,传给父类的字符串会被作为菜单项的名称%20%20%20%20//%20如果你通过plugin.xml来注册,可以忽略这个构造函数%20%20%20%20public%20TextBoxes()%20{%20%20%20%20%20%20%20%20//%20设置菜单项名称%20%20%20%20%20%20%20%20super("Text%20_Boxes");%20%20%20%20%20%20%20%20//%20还可以设置菜单项名称,描述,图标%20%20%20%20%20%20%20%20//%20super("Text%20_Boxes","Item%20description",IconLoader.getIcon("/Mypackage/icon.png"));}public void actionPerformed(AnActionEvent event) {Project project = event.getData(PlatformDataKeys.PROJECT);String txt= Messages.showInputDialog(project, "What is your name?", "Input your name", Messages.getQuestionIcon());Messages.showMessageDialog(project, "Hello, " + txt + "!\n I am glad to see you.", "Information", Messages.getInformationIcon());}}
然后在plugin.xml中注册这个Action:
<actions><group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu"><add-to-group group-id="MainMenu" anchor="last" /><action id="Myplugin.Textboxes" class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" /></group></actions>
这里新建了一个菜单组,其中 text 字符串的下划线表示这个字母作为快捷键。这个菜单显示的效果如下:
除了手动新建Action,IDEA还提供了快速新建的方法,在代码目录上点击新建,可以看到Action:
可以在这个面板中填写要新建的Action信息,IDEA会新建类,还有在plugin.xml中注册:
运行插件
运行插件特别简单,和运行普通Java代码一样,点击运行或者调试的按钮,就会启动一个新的IDEA实例,这个实例中插件是生效的。点击 Text Boxes 就可以看到插件的效果了。
版权声明
本站仅做备份收录,仅供研究与教学参考之用。
读者将信息用于其他用途的,全部法律及连带责任由读者自行承担,本站不承担任何责任。









评论