idea 生成sdk_从零开始编写 IntelliJ IDEA 插件

本文介绍了如何从零开始编写IntelliJ IDEA插件,包括设置开发环境、创建IDEA JDK、配置IntelliJ Platform SDK,以及详细步骤如新建工程、编写Action并注册,最后展示了如何运行和测试插件。通过这个教程,读者可以掌握自定义IDEA插件的基本方法。
摘要由CSDN通过智能技术生成

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

开发环境

开发 IDEA 插件有以下这些依赖:IntelliJ IDEA Community Edition

IntelliJ IDEA Community Edition 源码

Plugin DevKit 插件

IntelliJ Platform SDK

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

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

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

添加 IDEA jdk

,我们需要建立一个IDEA jdk来运行插件:

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

配置 IntelliJ Platform SDK

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

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

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

第一个插件

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

新建工程

选择IntellJ Platform Plugin,然后 Project SDK 指定刚刚新建的 plugin sdk:

新建的插件项目:

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

plugin.xml 默认的内容如下:

com.your.company.unique.plugin.id

Plugin display name here

1.0

YourCompany

most HTML tags may be used]]>

most HTML tags may be used]]>

新建一个 Action

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

新建一个自定义的 Action 有两个步骤:继承AnAction类,在actionPerformed方法中实现插件逻辑

注册 action,有两种方式,通过代码注册和通过plugin.xml注册

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

public class TextBoxes extends AnAction {

public TextBoxes() {

super("Text _Boxes");

}

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:

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

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

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

运行插件

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

点击 Text Boxes 就可以看到插件的效果了。作者:木杉

木杉的博客每日福利

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值