idea中project sdk_自己写 IDEA 插件，要啥功能就有啥功能！

今天药忘吃喽~ 2023-01-02 04:28 107阅读 0赞

点击上方“Java技术前线”，选择“置顶或者星标”

与你一起成长

![97ab5abcdd07639b46d0488dd6b09453.png][]

来源：imushan.com

*  开发环境
    
     *  安装IntelliJ IDEA Community Edition
     *  下载IntelliJ IDEA Community Edition源码
     *  添加IDEA jdk
     *  配置IntelliJ Platform SDK
 *  第一个插件
    
     *  新建工程
     *  新建一个Action
     *  运行插件

--------------------

写Java代码的时候，经常会涉及到重复性的操作，这个时候就会想要是有这样一个插件就好了，如果是大家都会遇到的场景，IDE或许已经提供了，再不然也有可能有人编写了相关的插件。要是这个操作是你们的编码环境特有的，那就只能自己写工具了。所以这里来学学如何编写IDEA插件，让自己的编程环境更加强大，更好的进行装逼。

# 开发环境 #

开发IDEA插件有以下这些依赖：

*  IntelliJ IDEA Community Edition
 *  IntelliJ IDEA Community Edition 源码
 *  Plugin DevKit 插件
 *  IntelliJ Platform SDK

## **安装IntelliJ IDEA Community Edition** ##

你可能已经安装了Ultimate版本，但是你还是需要安装IDEA的社区版本。因为商业版是闭源的，所以在调试时无法调试核心代码。

## **下载IntelliJ IDEA Community Edition源码** ##

社区版的安装包里是不包含源码的，所以我们需要手动从github上clone一份：

git clone --depth 1 git://git.jetbrains.org/idea/community.git idea

关于从源码运行IDEA的方法参考：Check Out And Build Community Edition

## **添加IDEA jdk** ##

虽然不知道原因，但是根据Check Out And Build Community Edition，我们需要建立一个`IDEA jdk`来运行插件：

![be9452fd4093b88ce29405929989ca6c.png][]

除非你在Mac上使用官方JDK，否则你需要手动添加`/lib/tools.jar`到classpath中。

## **配置IntelliJ Platform SDK** ##

打开`File | Project Structure`新建一个`IntelliJ Platform SDK`：

![36887261f55d01575930ea682367d2f8.png][]

Java SDK选择我们刚刚建立的`IDEA jdk`：

![35805ecfee8c4f0892dc279661dfcb51.png][]

然后我们可以把下载的IDEA社区版源码添加到源码路径中，这样在调试时，就可以调试IDEA自身的代码了：

![474a692c89f3eac4b33e386ab3745ee4.png][]

![4c67eff7c1266ab1907c6bfc03ea081d.png][]

> “
> 
> 推荐一个艿艿写的 6000+ Star 的 SpringBoot + SpringCloud + Dubbo 教程的仓库：https://github.com/YunaiV/SpringBoot-Labs

# 第一个插件 #

我们来编写一个最简单的插件来学习编写一个插件的完整步骤。

## **新建工程** ##

选择`IntellJ Platform Plugin`，然后Project SDK指定刚刚新建的plugin sdk：

![ac8564cf4ea3d5a0698bca55d658352c.png][]

新建的插件项目：

![be330717d2d985a66972c9c77c5a710b.png][]

插件根目录下有两个目录`src`和`resources`。`src`是插件代码目录，`resource`是插件资源目录，其中`META-INF/plugin.xml`是插件的描述文件，就像Java web项目的`web.xml`一样。

plugin.xml默认的内容如下：

com.your.company.unique.plugin.idPlugin display name here1.0"support@yourcompany.com" url="http://www.yourcompany.com">YourCompany      Enter short description for your plugin here.most HTML tags may be used     ]]>      Add change notes here.most HTML tags may be used     ]]>"145.0"/>"com.intellij">

## **新建一个Action** ##

插件扩展IDEA最常见的方式就是在菜单栏或者工具栏中添加菜单项，用户通过点击菜单项来触发插件功能。IDEA提供了`AnAction`类，这个类有一个虚方法`actionPerformed`，这个方法会在每次菜单被点击时调用。

新建一个自定义的Action有两个步骤：

1.  继承`AnAction`类，在`actionPerformed`方法中实现插件逻辑
2.  注册action，有两种方式，通过代码注册和通过`plugin.xml`注册

我们先写一个简单的Action类：

public class TextBoxes extends AnAction {     // 如果通过Java代码来注册，这个构造函数会被调用，传给父类的字符串会被作为菜单项的名称     // 如果你通过plugin.xml来注册，可以忽略这个构造函数     public TextBoxes() {         // 设置菜单项名称         super("Text _Boxes");         // 还可以设置菜单项名称，描述，图标         // super("Text _Boxes","Item description",IconLoader.getIcon("/Mypackage/icon.png"));     }     public void actionPerformed(AnActionEvent event) {         Project project = event.getData(PlatformDataKeys.PROJECT);         String txt= Messages.showInputDialog(project, "What is your name?", "Input your name", Messages.getQuestionIcon());         Messages.showMessageDialog(project, "Hello, " + txt + "!\n I am glad to see you.", "Information", Messages.getInformationIcon());     } }

然后我们在`plugin.xml`中注册这个Action：

<actions>   <group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">     <add-to-group group-id="MainMenu" anchor="last"  />        <action id="Myplugin.Textboxes" class="Mypackage.TextBoxes" text="Text _Boxes" description="A test menu item" />   group> actions>

这里我们新建了一个菜单组，其中text字符串的下划线表示这个字母作为快捷键。这个菜单显示的效果如下：

![f44903579524a49bbd439f31cd85fde6.png][]

除了手动新建Action，IDEA还提供了快速新建的方法，在代码目录上点击新建，可以看到Action：

![c6d2eadece597827403528409949c33d.png][]

可以在这个面板中填写你要新建的Action信息，IDEA会帮你新建类，还有在plugin.xml中帮你注册：

![498f47d0eca18eec0232e59e6fba1013.png][]

## **运行插件** ##

运行插件特别简单，和运行普通Java代码一样，点击运行或者调试的按钮，就会启动一个新的IDEA实例，这个实例中插件是生效的。

点击Text Boxes就可以看到插件的效果了。

\- end -

![5196d177e70f44a37dce2e92d2c1a4c3.png][]

用心分享面试知识，做有温度的攻城狮

每天记得对自己说：你是最棒的！

往期推荐：

*  为什么有些大公司技术弱爆了？
 *  Spring Boot 微信点餐开源系统!

*  怒爬某破Hub站资源，只为撸这个鉴黄平台！

*  记一次 Linux 被入侵，服务器变“矿机”全过程
 *  为什么不建议在 MySQL 中使用 UTF-8？
 *  面试官问: 在Redis中设置了过期时间的Key，需要注意哪些问题？
 *  一千个不用 Null 的理由！

每一个“ **好看** ”，都是对我们最大的帮助

[97ab5abcdd07639b46d0488dd6b09453.png]: /images/20221120/0ee8fb5fbea64806a868d74adf0822a6.png
[be9452fd4093b88ce29405929989ca6c.png]: /images/20221120/b8c95c1ec2fe478093c1caaf7e08244a.png
[36887261f55d01575930ea682367d2f8.png]: /images/20221120/026ff6fe5d5d4e61a92e958b1bb95525.png
[35805ecfee8c4f0892dc279661dfcb51.png]: /images/20221120/f50b8b7384084b2d8a49a768333a814c.png
[474a692c89f3eac4b33e386ab3745ee4.png]: /images/20221120/5867bf092b2b4ae7be2504af000fbec9.png
[4c67eff7c1266ab1907c6bfc03ea081d.png]: /images/20221120/ea65cc735f9f41ff99eda2c7280b6546.png
[ac8564cf4ea3d5a0698bca55d658352c.png]: /images/20221120/4dbac302787041de9eca3281284d84e5.png
[be330717d2d985a66972c9c77c5a710b.png]: /images/20221120/aff7c8b93e104262aea0f0d4e6969251.png
[f44903579524a49bbd439f31cd85fde6.png]: /images/20221120/41e2350f744647459870023d6017cda1.png
[c6d2eadece597827403528409949c33d.png]: /images/20221120/0766175cf5764bd7b0e14df225000672.png
[498f47d0eca18eec0232e59e6fba1013.png]: /images/20221120/e5ddfce003724e4b8acef110c4db54a7.png
[5196d177e70f44a37dce2e92d2c1a4c3.png]: /images/20221120/cc7d02fe0a7d4f73a4f5ebc121303dad.png