IDEA 現(xiàn)在基本上可以一統(tǒng) Java IDE 的江湖了，eclipse 的用戶實在寥寥無幾。而 IDEA 的“IntelliJ”很大一部分原因來自于他提供的各種插件，如果插件不合心意也完全可以自己搞一個出來，對有多年開發(fā)經(jīng)驗的同學這不是難事。最初是使用同事搞得一個插件，不過有些地方用的不是很順手，就自己從頭學習弄了個新的。Rco Code Genrator，也歡迎裝載使用，多提意見，主要提供了根據(jù) Java 接口、Controller 接口自動生成 Markdown 文檔；生成 Mockito 的單元測試模板等，就是為了提升編碼效率。其實過程中也沒特別系統(tǒng)的學習，都是邊用邊查，在此記錄下吧。

創(chuàng)建工程

一直堅信看十遍不如實操一遍，自己動手去實際做一下是學習、理解的最快路徑。IDEA 平臺提供了很好的說明文檔，大多數(shù)問題再這里可以得到解答。

IDEA 推薦了三種創(chuàng)建 Plugin 工程的方式，一種是使用 Github 模板，這種沒有研究過。再就是使用 IDEA 平臺自帶的開發(fā)套件，一開始也是用這種方式創(chuàng)建工程。不過后來還是改成了使用 Gradle 方法，使用 Gradle 更接近于平常工程的開發(fā)，而且可以更好的去管理依賴，切換 IDEA SDK 等，修改完了只需要 Reload 下工程，就會自動幫你下載、添加依賴。這里是官方文檔。

在 IDEA 中選擇 File -> New -> Project...，在引導面板中選擇 Gradle。

創(chuàng)建工程

選擇 Project 使用的 SDK（如果是2020.3及之后的版本需要使用 Java 11），并勾選 Java、IntelliJ Platform Plugin，點擊 Next 。

創(chuàng)建工程

輸入工程名、存儲位置及 artifact 信息（這個需要展開，建議都修改成自己預(yù)期的），然后點擊 Finish 就完成工程的創(chuàng)建了。

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

這是官方給的工程結(jié)構(gòu)，大家可以對照看下是否有問題。

遇到的問題

我每次新建的工程并不成功，將會報出如下異常，不知道是否我使用的 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 后面缺少了“=”號，在官方示例中是有“=”的，這個應(yīng)該是 Gradel 的語法吧，在修改了這個問題后。點擊右邊的 Gradle 控制面板，右鍵工程選擇“Reload Gradle Project”，就可以正常構(gòu)建工程了，如果是第一次使用將下載指定的 IDEA 構(gòu)建版本，可能需要一些時間。

至此我們的 IDEA Plugin 工程就已經(jīng)建立完成了。

創(chuàng)建第一個插件

在我們上面創(chuàng)建的工程里面，對 IDEA 插件來說有個最核心的配置項就是“plugin.xm”，這里定義了插件的整體結(jié)構(gòu)及各種組件、監(jiān)聽器、擴展點等，詳細的說明可以參照官方文檔，而對插件的整體結(jié)構(gòu)描述則可以看這里。

下面來創(chuàng)建第一個簡單的 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;
    }
}

首先創(chuàng)建一個簡單的 Dialog，Dialog 構(gòu)造參數(shù)接收選擇的類名，展示也用最簡單的 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();
    }
}

接著創(chuàng)建一個 Action，也就是一個動作，IDEA中 右鍵菜單、工具類菜單的展示、選擇動作都可以通過 Action 來定義。IDEA Plugin 中定義所有的 Action 都需要繼承自 AnAction，后續(xù)將詳細講下這些相關(guān)的組件。這個 Action 中只是獲取了當前選擇的類，然后使用全類名創(chuàng)建了上面定義的 Dialog 并執(zhí)行展示動作。

intellij {
    plugins = ['java']
    version = '2020.3.2'
}

因為我們這使用了 Java 模塊的 Api ，所以需要添加相應(yīng)的依賴，在 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 中對創(chuàng)建的 Action 進行聲明，聲明這個 Action 的文本，需要展示的位置，id 需要保證唯一。

接著我們在 Gradle 控制面板中選擇 intellij -> runIde，將會啟動一個 IDEA 實例，并且默認安裝了我們的插件。這樣就可以來測試我們的插件。可以選擇新建一個工程，或者打開一個已有的工程，啟動的 IDEA 實例跟普通的 IDEA 沒有太大區(qū)別。

action

打開要測試的 Java 類，右鍵，可以看到，在彈出的菜單中已經(jīng)有了我們定義的 Action。

結(jié)果

點擊 First Action，彈出的窗口中也展示了我們預(yù)期的全類名。