IDEA 现在基本上可以一统 Java IDE 的江湖了，eclipse 的用户实在寥寥无几。而 IDEA 的“IntelliJ”很大一部分原因来自于他提供的各种插件，如果插件不合心意也完全可以自己搞一个出来，对有多年开发经验的同学这不是难事。最初是使用同事搞得一个插件，不过有些地方用的不是很顺手，就自己从头学习弄了个新的。Rco Code Genrator，也欢迎装载使用，多提意见，主要提供了根据 Java 接口、Controller 接口自动生成 Markdown 文档；生成 Mockito 的单元测试模板等，就是为了提升编码效率。其实过程中也没特别系统的学习，都是边用边查，在此记录下吧。
创建工程
一直坚信看十遍不如实操一遍，自己动手去实际做一下是学习、理解的最快路径。IDEA 平台提供了很好的说明文档，大多数问题再这里可以得到解答。
IDEA 推荐了三种创建 Plugin 工程的方式，一种是使用 Github 模板，这种没有研究过。再就是使用 IDEA 平台自带的开发套件，一开始也是用这种方式创建工程。不过后来还是改成了使用 Gradle 方法，使用 Gradle 更接近于平常工程的开发，而且可以更好的去管理依赖，切换 IDEA SDK 等，修改完了只需要 Reload 下工程，就会自动帮你下载、添加依赖。这里是官方文档。
在 IDEA 中选择 File -> New -> Project...，在引导面板中选择 Gradle。
选择 Project 使用的 SDK（如果是2020.3及之后的版本需要使用 Java 11），并勾选 Java、IntelliJ Platform Plugin，点击 Next 。
输入工程名、存储位置及 artifact 信息（这个需要展开，建议都修改成自己预期的），然后点击 Finish 就完成工程的创建了。
my_gradle_plugin
├── build.gradle
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
├── main
│ ├── java
│ └── resources
│ └── META-INF
│ └── plugin.xml
└── test
├── java
└── resources
这是官方给的工程结构，大家可以对照看下是否有问题。
遇到的问题
我每次新建的工程并不成功，将会报出如下异常，不知道是否我使用的 IDEA 版本有问题。
Build file '/Users/yuman/workspace/other/roc-demo/build.gradle' line: 22
A problem occurred evaluating root project 'roc-demo'.
> No signature of method: build_4sbts4wfio5ltkvaq379pvwih.patchPluginXml() is applicable for argument types: (build_4sbts4wfio5ltkvaq379pvwih$_run_closure4) values: [build_4sbts4wfio5ltkvaq379pvwih$_run_closure4@f34588c]
* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
这是因为工程中默认生成的 build.gradle 文件有错误：
intellij {
version '2020.3.2'
}
patchPluginXml {
changeNotes """
Add change notes here.<br>
<em>most HTML tags may be used</em>"""
}
在 version 及 changeNotes 后面缺少了“=”号，在官方示例中是有“=”的，这个应该是 Gradel 的语法吧，在修改了这个问题后。点击右边的 Gradle 控制面板，右键工程选择“Reload Gradle Project”，就可以正常构建工程了，如果是第一次使用将下载指定的 IDEA 构建版本，可能需要一些时间。
至此我们的 IDEA Plugin 工程就已经建立完成了。
创建第一个插件
在我们上面创建的工程里面，对 IDEA 插件来说有个最核心的配置项就是“plugin.xm”，这里定义了插件的整体结构及各种组件、监听器、扩展点等，详细的说明可以参照官方文档，而对插件的整体结构描述则可以看这里。
下面来创建第一个简单的 IDEA 插件：通过右键获取类的全名。
public class FirstDialog extends DialogWrapper {
private final String className;
public FirstDialog(String className) {
super(true);
this.className = className;
setTitle("Dialog 示例");
init();
}
@Override
protected JComponent createCenterPanel() {
// 定义展示的面板
JPanel dialogPanel = new JPanel(new BorderLayout());
// 定义输入出的信息
JLabel label = new JLabel("选择的class:" + className);
label.setPreferredSize(new Dimension(100, 100));
dialogPanel.add(label, BorderLayout.CENTER);
return dialogPanel;
}
}
首先创建一个简单的 Dialog，Dialog 构造参数接收选择的类名，展示也用最简单的 JPanel + JLabel。
public class FirstAction extends AnAction {
@Override
public void actionPerformed(@NotNull AnActionEvent e) {
Editor editor = e.getDataContext().getData(CommonDataKeys.EDITOR);
if (editor == null) {
return;
}
PsiFile psiFile = e.getData(CommonDataKeys.PSI_FILE);
if (psiFile == null) {
return;
}
// 获取选择的类
PsiElement referenceAt = psiFile.findElementAt(editor.getCaretModel().getOffset());
PsiClass selectedClass = PsiTreeUtil.getContextOfType(referenceAt, PsiClass.class);
if (Objects.isNull(selectedClass)) {
return;
}
new FirstDialog(selectedClass.getQualifiedName()).showAndGet();
}
}
接着创建一个 Action，也就是一个动作，IDEA中 右键菜单、工具类菜单的展示、选择动作都可以通过 Action 来定义。IDEA Plugin 中定义所有的 Action 都需要继承自 AnAction，后续将详细讲下这些相关的组件。这个 Action 中只是获取了当前选择的类，然后使用全类名创建了上面定义的 Dialog 并执行展示动作。
intellij {
plugins = ['java']
version = '2020.3.2'
}
因为我们这使用了 Java 模块的 Api ，所以需要添加相应的依赖，在 build.gradle 文件中添加“plugins = ['java']”。同时需要在 plugin.xml 中也添加对模块的依赖，如下面代码所示。
<!-- 在 plugin.xml 中声明对模块的依赖 -->
<depends>com.intellij.modules.java</depends>
<actions>
<!-- Add your actions here -->
<action id="roc_demo_first_action" class="com.roc.demo.FirstAction" text="First Action"
description="First action">
<add-to-group group-id="ShowIntentionsGroup" anchor="first" />
</action>
</actions>
最后我们需要在 plugin.xml 中对创建的 Action 进行声明，声明这个 Action 的文本，需要展示的位置，id 需要保证唯一。
接着我们在 Gradle 控制面板中选择 intellij -> runIde，将会启动一个 IDEA 实例，并且默认安装了我们的插件。这样就可以来测试我们的插件。可以选择新建一个工程，或者打开一个已有的工程，启动的 IDEA 实例跟普通的 IDEA 没有太大区别。
打开要测试的 Java 类，右键，可以看到，在弹出的菜单中已经有了我们定义的 Action。
点击 First Action，弹出的窗口中也展示了我们预期的全类名。
