手把手教你5分鐘從零開發一款簡易的IDEA插件！專案經驗/畢設不愁了！-有解無憂

我這個人沒事就喜歡推薦一些好用的 IDEA 插件給大家，這些插件極大程度上提高了我們的生產效率以及編碼舒適度，

不知道大家有沒有想過自己開發一款 IDEA 插件呢？

我自己想過，但是沒去嘗試過，剛好有一位讀者想讓我寫一篇入門 IDEA 開發的文章，所以，我在周末就花了一會時間簡單了解一下，

不過，這篇文章只是簡單帶各位小伙伴入門一下 IDEA 插件開發，個人精力有限，暫時不會深入探討太多，如果你已經有 IDEA 插件開發的相關經驗的話，這篇文章就可以不用看了，因為會浪費你 3 分鐘的時間，

好的廢話不多說！咱們直接開始!

01 新建一個基于 Gradle 的插件專案

這里我們基于 Gradle 進行插件開發，這也是 IntelliJ 官方的推薦的插件開發解決方案，

第一步，選擇 Gradle 專案型別并勾選上相應的依賴，

選擇 Gradle 專案型別并勾選上相應的依賴

第二步，填寫專案相關的屬性比如 GroupId、ArtifactId，

填寫專案相關的屬性

第三步，靜靜等待專案下載相關依賴，

第一次創建 IDEA 插件專案的話，這一步會比較慢，因為要下載 IDEA 插件開發所需的 SDK ，

02 插件專案結構概覽

新建完成的專案結構如下圖所示，

插件專案結構概覽

這里需要額外注意的是下面這兩個組態檔，

plugin.xml ：插件的核心組態檔，通過它可以配置插件名稱、插件介紹、插件作者資訊、Action 等資訊，

<idea-plugin>
    <id>github.javaguide.my-first-idea-plugin</id>
    <!--插件的名稱-->
    <name>Beauty</name>
    <!--插件的作者相關資訊-->
    <vendor email="koushuangbwcx@163.com" url="https://github.com/Snailclimb">JavaGuide</vendor>
    <!--插件的介紹-->
    <description><![CDATA[
     Guide哥代碼開發的第一款IDEA插件<br>
    <em>這尼瑪是什么垃圾插件！！！</em>
    ]]></description>

    <!-- please see https://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 -->
    </actions>
</idea-plugin>

build.gradle ：專案依賴組態檔，通過它可以配置專案第三方依賴、插件版本、插件版本更新記錄等資訊，

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '0.6.3'
}

group 'github.javaguide'
// 當前插件版本
version '1.0-SNAPSHOT'

repositories {
    mavenCentral()
}

// 專案依賴
dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

// See https://github.com/JetBrains/gradle-intellij-plugin/
// 當前開發該插件的 IDEA 版本
intellij {
    version '2020.1.2'
}
patchPluginXml {
    // 版本更新記錄
    changeNotes """
      Add change notes here.<br>
      <em>most HTML tags may be used</em>"""
}

沒有開發過 IDEA 插件的小伙伴直接看這兩個組態檔內容可能會有點蒙，所以，我專門找了一個 IDEA 插件市場提供的現成插件來說明一下，小伙伴們對照下面這張圖來看下面的組態檔內容就非常非常清晰了，

插件資訊

這就非常貼心了！如果這都不能讓你點贊，我要這文章有何用!

03 手動創建 Action

我們可以把 Action 看作是 IDEA 提高的事件回應處理器，通過 Action 我們可以自定義一些事件處理邏輯/動作，比如說你點擊某個選單的時候，我們進行一個展示對話框的操作，

第一步，右鍵java目錄并選擇 new 一個 Action

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-rZRC9vKo-1605787283801)(https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/2020-11/新建action (1)].png)

第二步，配置 Action 相關資訊比如展示名稱，

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-mBFLnMCp-1605787283802)(https://guide-blog-images.oss-cn-shenzhen.aliyuncs.com/2020-11/配置動作屬性 (1)].png)

創建完成之后，我們的 plugin.xml 的 <actions>節點下會自動生成我們剛剛創建的 Action 資訊：

<actions>
    <!-- Add your actions here -->
    <action id="test.hello" class="HelloAction" text="Hello" description="IDEA插件入門">
      <add-to-group group-id="ToolsMenu" anchor="first"/>
    </action>
</actions>

并且 java 目錄下為生成一個叫做 HelloAction 的類，并且，這個類繼承了 AnAction ，并覆寫了 actionPerformed() 方法，這個 actionPerformed 方法就好比 JS 中的 onClick 方法，會在你點擊的時候被觸發對應的動作，

我簡單對actionPerformed 方法進行了修改，添加了一行代碼，這行代碼很簡單，就是顯示 1 個對話框并展示一些資訊，

public class HelloAction extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        //顯示對話框并展示對應的資訊
        Messages.showInfoMessage("素材不夠，插件來湊！", "Hello");
    }
}

另外，我們上面也說了，每個動作都會歸屬到一個 Group 中，這個 Group 可以簡單看作 IDEA 中已經存在的選單，

舉個例子，我上面創建的 Action 的所屬 Group 是 ToolsMenu(Tools) ，這樣的話，我們創建的 Action 所在的位置就在 Tools 這個選單下，

再舉個例子，加入我上面創建的 Action 所屬的 Group 是MainMenu （IDEA 最上方的主選單欄）下的 FileMenu(File) 的話，

<actions>
    <!-- Add your actions here -->
    <action id="test.hello" class="HelloAction" text="Hello" description="IDEA插件入門">
      <add-to-group group-id="FileMenu" anchor="first"/>
    </action>
</actions>