从零开始，开发一款属于自己的 IDEA 插件，要啥功能就做啥！

Java精选 2022-08-09

写Java代码的时候，经常会涉及到重复性的操作，这个时候就会想要是有这样一个插件就好了，如果是大家都会遇到的场景，IDE或许已经提供了，再不然也有可能有人编写了相关的插件。

要是这个操作是你们的编码环境特有的，那就只能自己写工具了。所以这里来学学如何编写IDEA插件，让自己的编程环境更加强大，更好的进行装逼。

开发环境

开发IDEA插件有以下这些依赖：

你可能已经安装了Ultimate版本，但是你还是需要安装[IDEA][]的社区版本。因为商业版是闭源的，所以在调试时无法调试核心代码。

社区版的安装包里是不包含源码的，所以我们需要手动从github上clone一份：

关于从源码运行IDEA的方法参考 Check Out And Build Community Edition：

http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html

虽然不知道原因，但是根据Check Out And Build Community Edition：

http://www.jetbrains.org/intellij/sdk/docs/basics/checkout_and_build_community.html

我们需要建立一个 IDEA jdk来运行插件：

除非你在Mac上使用官方JDK，否则你需要手动添加 /lib/tools.jar到classpath中。关注微信公众号：匠心零度，在后台回复：idea，可以获取我整最新 IDEA 教程，都是干货。

打开 File|ProjectStructure新建一个 IntelliJPlatformSDK：

Java SDK选择我们刚刚建立的 IDEA jdk：

然后我们可以把下载的IDEA社区版源码添加到源码路径中，这样在调试时，就可以调试IDEA自身的代码了：

我们来编写一个最简单的插件来学习编写一个插件的完整步骤。

选择 IntellJPlatformPlugin，然后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. 
most HTML tags may be used
\]\]></description>
<change-notes><!\[CDATA\[
Add change notes here. 
most HTML tags may be used
\]\]>
</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>

插件扩展IDEA最常见的方式就是在菜单栏或者工具栏中添加菜单项，用户通过点击菜单项来触发插件功能。IDEA提供了 AnAction类，这个类有一个虚方法 actionPerformed，这个方法会在每次菜单被点击时调用。

新建一个自定义的Action有两个步骤：

1、继承 AnAction类，在 actionPerformed方法中实现插件逻辑 2、注册action，有两种方式，通过代码注册和通过 plugin.xml注册

我们先写一个简单的Action类：

publicclass 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>