IDEA 插件开发入门教程

简介: IntelliJ IDEA 是目前最好用的 JAVA 开发 IDE,它本身的功能已经非常强大了,但是每个人的需求不一样,有些需求 IDEA 本身无法满足,于是我们就需要自己开发插件来解决。工欲善其事,必先利其器,想要提高开发效率,我们可以借助 IDEA 提供的插件功能来满足我们的需求。
+关注继续查看

IntelliJ IDEA 是目前最好用的 JAVA 开发 IDE,它本身的功能已经非常强大了,但是每个人的需求不一样,有些需求 IDEA 本身无法满足,于是我们就需要自己开发插件来解决。工欲善其事,必先利其器,想要提高开发效率,我们可以借助 IDEA 提供的插件功能来满足我们的需求。如果没有我需要的功能怎么办?很简单,我们自己造一个!

插件能做什么?

IDEA 的插件几乎可以做任何事情,因为它把 IDE 本身的能力都封装好开放出来了。主要的插件功能包含以下四种:

  • 自定义语言支持:如果有 IDEA 暂时不支持的语言,你可以自己写一个插件来支持,例如 Go 语言原来的支持就是通过插件做的,后来单独做了一个 Goland。官方有自定义语言插件支持的教程
  • 框架支持:例如Struts 2 的框架支持
  • 工具集成:可以给 IDEA 的自带功能进行增强,例如对 Git 的操作增加 CodeReview 的功能。参考Gerrit
  • 用户界面:自定义的插件改变用户界面。参考BackgroundImage

我为了减少重复代码的编写,写了一个代码生成的插件IDEA代码生成插件CodeMaker,支持自定义代码生成的模板。

Hello world 插件

依照惯例,我们从 Hello world 开始。

新建一个 Gradle 的插件工程

有些教程推荐用 IDEA 默认的插件工程来开始,但是我比较推荐用 Gradle 来管理整个插件工程,后面的依赖管理会很方便,否则都得靠手动管理。

点击新建工程,选择 Gradle

接下来填写项目属性

配置 Gradle,用默认配置就行

新建完工程之后,IDEA 会自动开始解析项目依赖,因为它要下载一个几百兆的 SDK 依赖包,所以会比较久,打开科学上网能快一点。

Gradle 依赖解析完成之后,项目结构如下图,其中 plugin.xml 是插件的配置,build.gradle 是项目依赖的配置(类比 pom.xml)。

下面就是默认生成的 plugin.xml

<idea-plugin>
    <!--插件id-->
    <id>com.xiaokai.test.demo</id>
    <!--插件名称-->
    <name>Demo</name>
    <!--开发者信息-->
    <vendor email="support@yourcompany.com" url="http://www.yourcompany.com">YourCompany</vendor>
    <!--插件说明-->
    <description><![CDATA[
    Enter short description for your plugin here.<br>
    <em>most HTML tags may be used</em>
    ]]></description>

    <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
         on how to target different products -->
    <!-- uncomment to enable plugin in all products
    <depends>com.intellij.modules.lang</depends>
    -->

    <!--依赖的其他插件能力-->
    <extensions defaultExtensionNs="com.intellij">
        <!-- Add your extensions here -->
    </extensions>

    <!--插件动作-->
    <actions>
        <!-- Add your actions here -->
    </actions>
</idea-plugin>

创建一个 Action

Action 是 IDEA 中对事件响应的处理器,它的 actionPerformed 就像是 JS 中的 onClick 方法。可以看出来,插件的开发本质上跟 web、Android 的开发没有什么不同,因为都是事件驱动的编程。

我们可以直接使用 IDEA 提供的 Action 生成器
-w873

-w915

点击 OK 之后会在 src 生成类文件:

package com.xiaokai.test;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;

public class HelloWorldAction extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        // TODO: insert action logic here
    }
}

同时,动作的信息也会注册到 plugin.xml 中

    <!--插件动作-->
    <actions>
        <!-- Add your actions here -->
        <action id="demo.hello.world" class="com.xiaokai.test.HelloWorldAction" text="HelloWorld"
                description="Say Hello World">
            <add-to-group group-id="GenerateGroup" anchor="last"/>
        </action>
    </actions>

弹出对话框

创建完 Action 之后我们就要开始往里面写逻辑了,既然是 Hello World 教学,那我们就来试一下最简单的弹出对话框。

    @Override
    public void actionPerformed(AnActionEvent e) {
        //获取当前在操作的工程上下文
        Project project = e.getData(PlatformDataKeys.PROJECT);

        //获取当前操作的类文件
        PsiFile psiFile = e.getData(CommonDataKeys.PSI_FILE);
        //获取当前类文件的路径
        String classPath = psiFile.getVirtualFile().getPath();
        String title = "Hello World!";

        //显示对话框
        Messages.showMessageDialog(project, classPath, title, Messages.getInformationIcon());
    }

代码写完之后,打开 Gradle 的界面,点击 runIde 就会启动一个安装了插件的 IDEA,然后就可以进行测试。你还可以右键启动 Debug 模式,这样还能进行断点。
-w1066

运行的效果如下图:
pu
可以看到,我们右键打开 Generate 菜单之后,里面最后一项就是我们添加的 Action,

进阶的教程

如果想学习更多的原理和设计理念可以看IntelliJ Platform SDK的官方文档。不过老实说,它的文档写的挺差的,基本上就是简单讲了一下概念和原理,没有深入的分析。所以如果要深入研究还得靠自己。最靠谱的学习方式就是看别人写的插件,举个例子,你想知道怎么样实现自动生成代码,你就去找支持这个功能的插件,看他的源码是怎么写的。

我当时写CodeMaker的时候也是靠自己啃源码之后写出来的。下面我简单介绍一下我用过的一些 API,这些 API 基本都没有文档说明,全靠代码相传。

判断当前光标选择的元素是什么

        //获取当前事件触发时,光标所在的元素
        PsiElement psiElement = anActionEvent.getData(LangDataKeys.PSI_ELEMENT);
        //如果光标选择的不是类,弹出对话框提醒
        if (psiElement == null || !(psiElement instanceof PsiClass)) {
            Messages.showMessageDialog(project, "Please focus on a class", "Generate Failed", null);
            return;
        }

获取当前类文件的所有类对象

一个类文件中可能会有内部类,所以读取的时候返回的是一个列表

    public static List<PsiClass> getClasses(PsiElement element) {
        List<PsiClass> elements = Lists.newArrayList();
        List<PsiClass> classElements = PsiTreeUtil.getChildrenOfTypeAsList(element, PsiClass.class);
        elements.addAll(classElements);
        for (PsiClass classElement : classElements) {
            //这里用了递归的方式获取内部类
            elements.addAll(getClasses(classElement));
        }
        return elements;
    }

格式化代码

    public static void reformatJavaFile(PsiElement theElement) {
        CodeStyleManager codeStyleManager = CodeStyleManager.getInstance(theElement.getProject());
        try {
            codeStyleManager.reformat(theElement);
        } catch (Exception e) {
            LOGGER.error("reformat code failed", e);
        }
    }

使用粘贴板

        CopyPasteManager.getInstance()
            .setContents(new SimpleTransferable(table.toString(), DataFlavor.allHtmlFlavor));

更多

更多的技巧可以参考我的项目CodeMaker,以及其他的开源插件。

目录
相关文章
|
1天前
|
SQL 机器学习/深度学习 Java
8款最新宝藏IDEA插件「含ChatGPT」,不容错过,赶紧试试吧
工欲善其事必先利其器,Intellij IDEA是一款十分流行的编程工具,不仅提供了非常强大的基础功能,还构建了一套插件市场生态,让用户可以根据自己需要安装插件,提升开发效率,这里介绍几款好用的插件,感兴趣的小伙伴赶紧试试吧!
|
1天前
|
Dubbo 关系型数据库 应用服务中间件
【遥遥领先】Eolink IDEA 插件:零代码入侵,自动生成接口
对于开发同学来说,无论是新增还是修改接口文档,都需要在开发工具和接口管理工具上同步最新的数据。而且接口文档变更内容会比较琐碎和频繁。那么是否有更轻便的同步接口数据方式呢? 我们提供了一个高效方案: 在开发工具上基于接口代码片段,一键生成 API 文档,支持在开发工具中调试,并可一键上传至 Eolink Apikit 的代码仓库中。 这样不仅可以减少界面的操作和系统间的切换,还可以在开发工具上完成琐碎和频繁的接口文档更新,是当前 CODE TO API 的最佳实践。
15 0
|
3天前
idea插件grep console最佳实践
idea插件grep console最佳实践
8 0
|
12天前
|
网络协议 IDE Java
基于 IntelliJ IDEA 插件部署微服务应用
基于 IntelliJ IDEA 插件部署微服务应用
29 0
|
16天前
|
JSON NoSQL Java
好用的idea插件
好用的idea插件
38 0
|
21天前
|
人工智能 自然语言处理 Java
当代码遇见AI:IDEA开启ChatGPT插件,分分钟成为高效程序猿!
当代码遇见AI:IntelliJ IDEA开启ChatGPT插件,分分钟成为高效程序猿!
83 0
|
23天前
|
XML SQL JSON
idea 21款插件 YYDS
idea 21款插件 YYDS
|
1月前
|
应用服务中间件
IntelliJ IDEA Community 社区版 Tomcat 插件
IntelliJ IDEA Community 社区版默认没有像旗舰版的 Tomcat 启动配置,那么社区版如何集成 Tomcat 呢?
IntelliJ IDEA Community 社区版 Tomcat 插件
|
1月前
|
机器学习/深度学习 人工智能 IDE
idea的这款代码提示插件爱了
前言 Idea 是一款功能强大的集成开发环境(IDE),它可以帮助开发人员更加高效地编写、调试和部署软件应用程序,Idea 还具有许多插件和扩展,可以根据开发人员的需要进行定制和扩展,从而提高开发效率,今天我们就来介绍一款国产的代码编辑增强工具-Alibaba Cloud AI Coding Assistant。
65 0
|
1月前
|
Arthas Java 测试技术
12 款 yyds 的 IDEA插件,配上18条使用技巧,绝了
工欲善其事,必先利其器。想要提升编程开发效率,必须选择一款顺手的开发工具。 JetBrains 公司提供了一系列功能强大、风格统一的开发工具,深受开发者喜爱。其中,IDEA 是面向 Java 开发的专业 IDE(集成开发环境),90% 以上的企业都在使用 IDEA 进行 Java 开发,而不是用其他的工具如 Eclipse。
推荐文章
更多