从 0 编写自己的第一款 IDEA 插件!
写java代码的时候,经常会涉及到重复性的操作,这个时候就会想要是有这样一个插件就好了,如果是大家都会遇到的场景,ide或许已经提供了,再不然也有可能有人编写了相关的插件。
要是这个操作是你们的编码环境特有的,那就只能自己写工具了。所以这里来学学如何编写idea插件,让自己的编程环境更加强大,更好的进行装逼。
开发环境
开发idea插件有以下这些依赖:
-
intellij idea community edition
-
intellij idea community edition 源码
-
plugin devkit 插件
-
intellij platform sdk
安装intellij idea community edition
你可能已经安装了ultimate版本,但是你还是需要安装idea的社区版本。因为商业版是闭源的,所以在调试时无法调试核心代码。
下载intellij idea community edition源码
社区版的安装包里是不包含源码的,所以我们需要手动从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,否则你需要手动添加/lib/tools.jar
到classpath中。关注微信公众号:java技术栈,在后台回复:idea,可以获取我整理的 n 篇最新 idea 教程,都是干货。
配置intellij platform sdk
打开file | project structure
新建一个intellij platform sdk
:
java sdk选择我们刚刚建立的idea jdk
:
然后我们可以把下载的idea社区版源码添加到源码路径中,这样在调试时,就可以调试idea自身的代码了:
第一个插件
我们来编写一个最简单的插件来学习编写一个插件的完整步骤。
新建工程
选择intellj platform plugin
,然后project sdk指定刚刚新建的plugin sdk:
新建的插件项目:
插件根目录下有两个目录src
和resources
。src
是插件代码目录,resource
是插件资源目录,其中meta-inf/plugin.xml
是插件的描述文件,就像java web项目的web.xml
一样。
plugin.xml默认的内容如下:
<idea-plugin> <id>com.your.company.unique.plugin.id</id> <name>plugin display name here</name> <version>1.0</version> <vendor email="support@yourcompany.com" url="http://www.yourcompany.com">yourcompany</vendor> <description><!\[cdata\[ enter short description for your plugin here.<br> <em>most html tags may be used</em> \]\]></description> <change-notes><!\[cdata\[ add change notes here.<br> <em>most html tags may be used</em> \]\]> </change-notes> <!\-\- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting\_started/build\_number_ranges.html for description --> <idea-version since-build="145.0"/> <!\-\- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting\_started/plugin\_compatibility.html on how to target different products --> <!\-\- uncomment to enable plugin in all products <depends>com.intellij.modules.lang</depends> --> <extensions defaultextensionns="com.intellij"> <!\-\- add your extensions here --> </extensions> <actions> <!\-\- add your actions here --> </actions> </idea-plugin>
新建一个action
插件扩展idea最常见的方式就是在菜单栏或者工具栏中添加菜单项,用户通过点击菜单项来触发插件功能。idea提供了anaction
类,这个类有一个虚方法actionperformed
,这个方法会在每次菜单被点击时调用。
新建一个自定义的action有两个步骤:
-
继承
anaction
类,在actionperformed
方法中实现插件逻辑 -
注册action,有两种方式,通过代码注册和通过
plugin.xml
注册
我们先写一个简单的action类:
public class textboxes extends anaction { // 如果通过java代码来注册,这个构造函数会被调用,传给父类的字符串会被作为菜单项的名称 // 如果你通过plugin.xml来注册,可以忽略这个构造函数 public textboxes() { // 设置菜单项名称 super("text _boxes"); // 还可以设置菜单项名称,描述,图标 // super("text _boxes","item description",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就可以看到插件的效果了。
来源:木杉的博客
推荐去我的博客阅读更多:
2.spring mvc、spring boot、spring cloud 系列教程
3.maven、git、eclipse、intellij idea 系列工具教程
生活很美好,明天见~
上一篇: Redis启动服务和String常用命令