IntelliJ IDEA插件之開發兩種方式創建插件工程
本文轉載自微信公眾號「bugstack蟲洞棧」，作者小傅哥。轉載本文請聯系bugstack蟲洞棧公眾號。
一、前言
并不是所有的不會，都是真不會!
對于碼農這一行業的編程學習生涯來說，會遇到很多的不會，不會搭建IDEA工程、不會寫老師的案例、不會完成書中的效果、不會做項目的需求、不會實現復雜的邏輯、不會抽象工程的結構等等。但這些不會當中并不是所有的不會，都因為太復雜學不會，而是很大一部分內容因為找不到好的資料、沒有清晰的文檔、缺少完整的案例，導致不知道所以不會。
正好最近在折騰IDEA插件開發的時候，市面的資料確實不多，也沒有成體系完整的開發指導手冊，所以就遇到了很多不知道就不會的事情，需要一點點查詢搜索源碼、驗證API接口，最終把各項功能實現，當然在這個過程中也確實踩了不少坑!
好!沉淀下來，接下來在這個專欄會把一些關于 IDEA 插件開發用到的各項知識做成案例輸出出來，一方面可以讓自己縷清所有的知識項，另一方面也可以幫助到更多的有需要的研發人員使用。
二、需求目的
可能你會想什么場景會需要用到插件開發，其實插件開發算是一種通用的解決方案，由服務平臺定義標準讓各自使用方進行自需的擴展。
這就像我們非常常用的 P3C 代碼檢查插件、代碼審計插件、腳手架工程創建插件、自動化API提取插件、單元測試統計插件等等，這些都是在 IDEA 代碼開發平臺擴展出來的各項功能插件。
插件也可以說是一種解決方案，其實與你在代碼編程時使用人家已經定義好的標準結構和功能下，擴展出自己的功能時是一樣的。而這種方式也可以非常好的解決一些屬于代碼開發期間不易于放到代碼提測后問題場景，并能及時提醒研發人員作出響應的修改處理。
三、環境說明
- IntelliJ Platform Plugin JDK 不是自己安裝的JDK1.8等，只有插件JDK才能開發插件
- IntelliJ IDEA 2019.3.1 x64 如果你是其他版本，會涉及到 插件工程創建后版本修改
- gradle-5.2.1 與 2019 IDEA 版本下的插件開發匹配，如果遇到一些環境問題可以參考我們開篇介紹
在官方文檔 https://plugins.jetbrains.com/docs/intellij/disposers.html 介紹開發 IDEA 插件的工程方式有兩種，分別是模板方式和 Gradle 工程方式。這里我們分別演示下不同方式下工程的創建和所涉及到知識點內容的介紹，雖然兩種方式都能創建 IDEA 插件工程，但更推薦使用 Gradle 方式。
四、模板方式創建
1. 創建引導
- New -> Project -> IntelliJ Platform Plugin
2. 工程結構
guide-idea-plugin-create-project-by-platform
├── resources
│ └── META-INF
│ └── plugin.xml
└── src
└── cn.bugstack.guide.idea.plugin
└── MyAction.java
源碼：https://github.com/fuzhengwei/guide-idea-plugin-create-project-by-platform
- plugin.xml 插件配置：開發描述、版本信息、Action事件入口、擴展信息(數據存放等)
- src 具體的事件、UI窗體、工程邏輯代碼開發
- 另外類似 MyAction 的創建并不是直接創建普通類，而是通過 New -> Plugin DevKit -> Action 的方式進行創建，因為這樣的創建方式可以在 plugin.xml 中自動添加 action 配置。當然如果你要是自己手動創建普通類那樣創建 Action 類，則需要自己手動處理配置信息。
3. plugin.xml 配置
- <idea-plugin>
- <id>cn.bugstack.guide.idea.plugin</id>
- <name>CreateProjectByPlatform</name>
- <version>1.0</version>
- <vendor email="184172133@qq.com" url="https://bugstack.cn">小傅哥</vendor>
- <description><![CDATA[
- 基于IDEA插件模板方式創建測試工程<br>
- <em>1. 學習IDEA插件工程搭建</em>
- <em>2. 驗證插件基礎功能實現</em>
- ]]></description>
- <change-notes><![CDATA[
- 插件開發學習功能點<br>
- <em>1. 工程搭建</em>
- <em>2. 菜單讀取</em>
- <em>3. 獲取配置</em>
- <em>4. 回顯頁面</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="173.0"/>
- <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
- on how to target different products -->
- <depends>com.intellij.modules.platform</depends>
- <extensions defaultExtensionNs="com.intellij">
- <!-- Add your extensions here -->
- </extensions>
- <actions>
- <!-- Add your actions here -->
- <action id="MyAction" class="cn.bugstack.guide.idea.plugin.MyAction" text="MyAction" description="MyAction">
- <add-to-group group-id="FileMenu" anchor="first"/>
- </action>
- </actions>
- </idea-plugin>
這里重點看 actions 其他上面的工程信息、版本描述、個人資料都按照自己的信息填寫就行，不會影響插件運行。
actions 下是關于所有事件入口的配置，也就是你希望讓你的 IDEA 插件在 IDEA 窗體中什么地方展示，以及配置快捷鍵等。這里的配置說明是在 FileMenu 下的第一個入口即為你的插件。
4. MyAction 事件入口
- public class MyAction extends AnAction {
- @Override
- public void actionPerformed(AnActionEvent e) {
- Project project = e.getData(PlatformDataKeys.PROJECT);
- PsiFile psiFile = e.getData(CommonDataKeys.PSI_FILE);
- String classPath = psiFile.getVirtualFile().getPath();
- Messages.showMessageDialog(project, "guide-idea-plugin-create-project-by-platform: " + classPath, "Hi IDEA Plugin", Messages.getInformationIcon());
- }
- }
- 在 MyAction 事件入口中獲取 Project 工程信息、PsiFile 文件信息，以及對應的類路徑。
- 最后在 Messages.showMessageDialog 下打印，這樣把鼠標放到工程類下，在點這個按鈕的時候就可以看到類的路徑彈窗了。
5. 運行測試
運行過程
- 點擊 Plugin 綠色箭頭，和正常啟動程序一樣
- 這個時候它會打開一個新的 IDEA 工程，并在這個工程中默認安裝你開發好的插件
- 在新打開的 IDEA 插件工程中，選中工程類后，點擊 File -> MyAction
運行結果
通過測試運行效果可以看到，已經可以打出工程下類的路徑信息了。你也可以嘗試把Action的入口放到其他按鈕下進行測試
五、Gradle 方式創建
1. 創建引導
New -> Project -> Gradle 選中 Java & IntelliJ Platform Plugin
2. 工程結構
- guide-idea-plugin-create-project-by-gradle
- ├── .gradle
- └── src
- ├── main
- │ └── java
- │ └── cn.bugstack.guide.idea.plugin
- │ └── MyAction.java
- ├── resources
- │ └── META-INF
- │ └── plugin.xml
- ├── build.gradle
- └── gradle.properties
源碼：https://github.com/fuzhengwei/guide-idea-plugin-create-project-by-gradle
- 與模板方式創建 Gradle 主要差異在 build.gradle、gradle.properties 內容的配置，這兩個文件主要是處理 Gradle 相關信息的，其中 gradle.properties 用于配置 JVM Xmx 參數的，避免下載耗費資源較大崩潰。
- plugin.xml 配置插件入口等內容，MyAction 是事件入口。
3. build.gradle 配置
- plugins {
- id 'java'
- id 'org.jetbrains.intellij' version '0.6.3'
- }
- group 'cn.bugstack.guide.idea.plugin'
- version '1.0-SNAPSHOT'
- sourceCompatibility = 1.8
- repositories {
- mavenCentral()
- }
- dependencies {
- testCompile group: 'junit', name: 'junit', version: '4.12'
- }
- // See https://github.com/JetBrains/gradle-intellij-plugin/
- intellij {
- version '2019.3.1'
- }
- patchPluginXml {
- changeNotes """
- <![CDATA[
- 插件開發學習功能點<br>
- <em>1. 工程搭建</em>
- <em>2. 菜單讀取</em>
- <em>3. 獲取配置</em>
- <em>4. 回顯頁面</em>
- ]]>"""
- }
gradle 與 maven 的使用配置上，還是可以相通的找到一些類似的地方的，如果沒有使用過 gradle 也是可以使用的。
這里需要注意 plugins 中 id 'org.jetbrains.intellij' version '0.6.3' 默認創建工程的版本有點高，與 gradle 5.x 不匹配。不過你可以嘗試調試合適版本進行使用
4. MyAction 事件入口
- public class MyAction extends AnAction {
- @Override
- public void actionPerformed(AnActionEvent e) {
- Project project = e.getData(PlatformDataKeys.PROJECT);
- PsiFile psiFile = e.getData(CommonDataKeys.PSI_FILE);
- String classPath = psiFile.getVirtualFile().getPath();
- Messages.showMessageDialog(project, "guide-idea-plugin-create-project-by-gradle: " + classPath, "Hi IDEA Plugin", Messages.getInformationIcon());
- }
- }
這里與模板方式創建的案例是一樣的，為了區別兩個插件測試，我們這里打印了工程的名稱。當然你也可以使用 project.getName() 獲取工程名稱。
5. 運行測試
Gradle 測試運行相當于是運行 :runIde ,也是和普通的代碼調試一樣。
運行結果
通過測試運行效果可以看到，已經可以打出工程下類的路徑信息了。
六、總結
整篇內容的學習還是蠻簡單的，哪怕你之前沒開發過 IDEA 插件，按照這樣的套路往下折騰也是可以完成插件開發的。類似這樣的知識內容只是平時常做業務開發所以接觸的也不多，乍一聽上去還是很陌生的，不過有這樣的資料就可以上手了。
本章節初步介紹 IDEA 插件的方式和一個非常簡單的基本功能，后續我們在 Gradle 創建插件的基礎上，繼續開發其他案例功能，逐步學習 IDEA 插件開發用到的各項技巧用于完成所需要解決的問題。
在學習的過程中可以自行嘗試擴展一些其他組件入口，打印不同的工程信息。就像你使用的一些的插件一樣，幫助你生成get、set，或者提取采集接口信息，也包括你寫了多少行代碼，思考它們是如何實現的。
