手把手教你5分钟从零开发一款简易的IDEA插件！项目经验/毕设不愁了！

2021-09-10 01:00:21

我这个人没事就喜欢推荐一些好用的 IDEA 插件给大家。这些插件极大程度上提高了我们的生产效率以及编码舒适度。

不知道大家有没有想过自己开发一款 IDEA 插件呢？

我自己想过，但是没去尝试过。刚好有一位读者想让我写一篇入门 IDEA 开发的文章，所以，我在周末就花了一会时间简单了解一下。

不过，这篇文章只是简单带各位小伙伴入门一下 IDEA 插件开发，个人精力有限，暂时不会深入探讨太多。如果你已经有 IDEA 插件开发的相关经验的话，这篇文章就可以不用看了，因为会浪费你 3 分钟的时间。

好的废话不多说！咱们直接开始!

01 新建一个基于 Gradle 的插件项目

这里我们基于 Gradle 进行插件开发，这也是 IntelliJ 官方的推荐的插件开发解决方案。

第一步，选择 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

第二步，配置 Action 相关信息比如展示名称。

创建完成之后，我们的 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>

我们创建的 Action 所在的位置就在 File 这个菜单下。