IDEA插件开发入门指南

IntelliJ IDEA是在业界被公认为最好的java开发工具之一，尤其是代码提示、重构、各种工具的集成，让Java开发如虎添翼，一爽到底，并且它还提供了插件机制，让我们可以定制化的对IDEA进行扩展，那现在开始插件开发入门步骤说明，来实现一个hello的插件，功能很简单，就是弹出hello world

打开IDEA，创建项目，file > new > project

idea插件开发有两种方式

1、gradle intellij plugin 官方推荐

使用gradle的好处是，一是可以很方便的引入插件开发需要依赖的jar包，二是可以使用idea沙盒

这里使用gradle进行插件开发的演示，我环境使用的java版本11，gradle版本6.8.1，gradle intellij plugin插件版本1.5.2（目前最新的是1.14.1），使用1.5.2是因为我的gradle版本低了，不支持高版本插件，感兴趣的可以使用高版本

项目创建过程比较慢，中间会去下载更新一些jar包，idea ce版本，耐心等待

创建gradle项目

2、intellij platform plugin

创建intellij platform plugin项目

整体上跟gradle项目过程差不多

项目创建好后，会自动创建一个plugin.xml的配置文件

plugin.xml

我们的重点是actions这个配置节点，其他的都是一些描述性的内容

action就是一个动作，比如点击菜单中的某个菜单后，需要执行某种操作，这个就是我们具体要实现的插件功能了

右键创建一个action

创建Action

action创建弹窗

打开弹窗后可以看到，需要填写几个内容

• action id：给操作定义一个id，注意需要唯一避免冲突，可以带上公司名称作为前缀
• class name：类名，不解释
• name：action取一个名字，在idea中显示
• description：描述，不解释
• add to group：需要增加到哪个菜单分组里，我选择加在tools菜单下最后一个
• keyboard shortcuts：菜单快捷键，不解释

action创建好后，会自动在plugin.xml中的actions节点下增加一个action的定义

打开HelloAction，编辑插件功能代码，没有业务逻辑，就是弹出一个提示框

import com.intellij.openapi.actionSystem.AnAction; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.openapi.ui.Messages; public class HelloAction extends AnAction { /** * 点击后触发事件，弹出提示框 * @param e */ @Override public void actionPerformed(AnActionEvent e) { Messages.showMessageDialog(e.getProject(), "Hello plugin world!", "提示", Messages.getInformationIcon()); } }5、运行插件

在gradle的操作面板，运行runIde，编译完成后，会打开一个idea(沙盒)，创建一个项目，然后进入项目，点击我们配置的菜单，弹出hello提示框

编译并运行插件

hello提示框

在gradle的操作面板，运行buildPlugin，就会打包构建插件，打包好的插件在build\distributions下，复制出来，在idea中用本地安装的方式安装插件即可，也可以发布到插件市场，通过在线安装

打包构建插件

打包后的插件

到这里，一个简单的插件示例就完成了

中间可能会碰到一些问题，我列举一下，有其他问题欢迎留言交流讨论

插件中文乱码

在build.gradle 文件中，增加如下配置，将字符集配置为utf8后，重新运行

tasks.withType(JavaCompile) { options.encoding = "UTF-8" }

gradle下载速度很慢

配置阿里云镜像，在build.gradle 文件中，增加如下配置

repositories { maven { url 'https://maven.aliyun.com/repository/public/' } mavenLocal() mavenCentral() }

gradle编译时报：Unsupported class file major version 60

jdk版本问题，需要Java11，下载安装后，配置gradle jvm

配置gradle jvm

后续还会再分享一下，一些常用的组件，监听器等操作，完成一个实际插件功能

喜欢的朋友可以点赞转发收藏， 你们的支持是我的动力，谢谢大家阅读！