IntelliJ IDEA插件开发-核心概念介绍

在深入学习插件开发之前，理解IntelliJ IDEA平台的基础概念至关重要。IntelliJ平台提供了丰富的API，支持插件开发者实现几乎任何功能。以下将介绍插件开发过程中常用的一些核心概念和API。

插件代码结构

以HelloWorldPlugin项目代码目录结构为例：

HelloWorldPlugin/
├── src/
│   └── main/
│       │── java/
│       │   └── com/example/helloworld/
│       │       └── HelloWorldAction.java
│       └── resources/
│           └── META-INF/ 
│               └── plugin.xml
├── build.gradle
└── settings.gradle

IntelliJ IDEA插件项目的结构基本遵循以下模式：

• src/main/java：java源代码目录。

• src/main/resources/ ：资源文件目录，包括 plugin.xml(位于META-INF目录下)、本地化资源、图标等。

• **build.gradle：**项目的构建脚本，它包含了项目的构建逻辑和配置信息，用于定义项目的构建过程和依赖管理。

• settings.gradle：用于配置项目的构建范围和属性， 它定义了项目的基本信息和项目之间的依赖关系。

plugin.xml文件

plugin.xml 文件是插件的核心配置，它定义了插件的行为、监听器、扩展点（extension points）、依赖等，例如HelloWorldPlugin项目代码中plugin.xml内容如下：

<!-- idea插件定义：url会在插件页面显示，可选属性;
require-restart确定插件安装、更新或卸载是否需要IDE重新启动的布尔值，可选属性，默认值为false。
-->
<idea-plugin url="https://example.com/hellworld" require-restart="false">
    <!-- id是插件的唯一标识符。它应该是类似于Java包的完全限定名称，并且不得与现有插件的ID冲突；
    使用字符、数字和'.'、'-'、'_'符号，并保持合理的长度；如果没有设置默认值取<name>元素的值。
    -->
    <id>com.example.helloworld</id>
    <!-- 插件显示名称 -->
    <name>Hello World</name>
    <!-- 插件版本 -->
    <version>1.0</version>
    <!-- 插件开发商信息：email电子邮件(可选)；开发商名称；url网址(可选) -->
    <vendor email="your-email@example.com" url="http://www.example.com">Your Name</vendor>
    <!-- 插件支持的IDE版本信息：since-build插件兼容的最低IDE版本(必要属性)；until-build插件兼容的最高IDE版本(可选) -->
    <idea-version since-build="201" />


    <description>
        插件描述信息，允许使用简单的HTML元素，例如文本格式、段落、列表等，并且必须将其包含在<![CDATA[... ]]>部分中。
        <![CDATA[
            <p>hello world插件</p>
        ]]>
    </description>


    <change-notes>
        最新插件版本提供的新功能、错误修复和更改的简短摘要。允许使用简单的HTML元素，例如文本格式、段落、列表等，并且必须将其包含在<![CDATA[... ]]>部分中。
        <![CDATA[
            <p>版本说明</p>
        ]]>
    </change-notes>


    <!-- 指定对基于IntelliJ平台的产品的另一个插件或模块的依赖关系。单个<idea-plugin>元素可以包含多个<depends>元素。
    例如，依赖IntelliJ IDEA Java模块
    -->
    <depends>com.intellij.modules.java</depends>


    <!-- 定义插件actions，单个<actions>元素可以包含多个<action>元素 -->
    <actions>
        <!-- 注册action：id唯一标识；class即action实现类的完全限定名称；
        text为action显示的默认文字(工具栏按钮的工具提示或菜单项的文本)；use-shortcut-of为action的键盘快捷键。
        -->
        <action id="HelloWorldAction" class="com.example.helloworld.HelloWorldAction" text="Say Hello">
            <!-- 指定将action添加到现有组中，可以将单个操作添加到多个组。
             group-id指定添加操作的组的ID，该组必须是DefaultActionGroup类的实现；
             anchor指定action相对于其他action的位置，允许值有first、last、before、after
             -->
            <add-to-group group-id="MainToolbar" anchor="last"/>
        </action>
    </actions>
</idea-plugin>

plugin.xml 文件更多配置请查阅官方文档Plugin Configuration File。

Actions概述

IntelliJ平台提供了Actions的概念，Actions 是插件开发中最常见的组件。Actions可以理解为用户触发事件后的响应，不论是点击菜单中的选项、点击工具栏的按钮，还是按下快捷键，背后都对应着一个Action。如果想在IDEA界面的菜单栏或工具栏新增一个菜单项或按钮，点击时触发设想的业务功能，就可以使用Actions 。一个Action代表用户可以通过界面（如菜单、工具栏、快捷键）触发的操作。Action类必须继承AnAction抽象类，当选择其菜单项或工具栏按钮时，该菜单项或工具栏按钮绑定的Action中的actionPerformed()方法将会被调用。通过Action，你可以控制IntelliJ IDEA的行为，例如打开对话框、编辑文件、执行命令等。

Action的使用分两步：定义Action和注册Action。

• 定义Action

定义Action就是写一个类继承自AnAction，AnAction 是IntelliJ平台中用于处理用户动作的基础类，每个Action类必须继承 com.intellij.openapi.actionSystem.AnAction 类，并实现 actionPerformed 方法，在这个方法中编写具体要实现的功能。例如，HelloWorldAction类继承AnAction，在actionPerformed方法中执行弹出一个对话框并显示"Hello World!"。

示例代码：

public class HelloWorldAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent event) {
        // 弹出一个对话框，显示 "Hello World!"
        Messages.showMessageDialog("Hello World!", "Greeting", Messages.getInformationIcon());
    }
}

• 注册Action：

有了Action，还需要将它注册到IDEA，目的是让IDEA知道这个Action该出现在菜单的哪里、工具栏的哪个地方，或者绑定哪个快捷键。Action需要在 plugin.xml 中注册，通常绑定到菜单项、工具栏或快捷键上。例如，注册HelloWorldAction，将其绑定到工具栏。

示例代码：

<actions>
    <action id="HelloWorldAction" class="com.example.helloworld.HelloWorldAction" text="Say Hello" description="This is my custom action">
        <add-to-group group-id="MainToolbar" anchor="last"/>
    </action>
</actions>

Extensions 和**Extension Points概述**

Extension Points

Extension Points 就像是插座 ，它们定义了一个连接点 ，告诉开发者："这里可以插入新的功能！" 。这些插座是由IntelliJ平台（或插件）提前预留好的，允许开发者通过它来扩展IDEA的功能，每个Extension Points都是为某种特定功能预留的。例如，IDEA提供了一个 "工具栏扩展点"，通过这个扩展点开发者可以在工具栏里添加新的按钮。

IntelliJ平台提供了许多Extension Points，例如：

• 增加工具栏按钮

• 增加新的代码检查规则

• 自定义编辑器中的右键菜单项

• 在项目结构中增加新的视图或展示

当你开发插件时，关键步骤之一就是找到适合你功能的Extension Point ，然后把你写的Extension插入进去。

当然，开发者也可以自定义一些扩展点，用于提供插件扩展功能。

Extensions

Extensions 就像是插头 ，它们是实际的功能或逻辑，开发者可以将自己的功能（比如新按钮、新菜单项）定义为一个Extension，然后将它插到某个Extension Point 上，让IDEA认识并执行它。通俗地理解，Extensions 就是你提供的"扩展功能"，通过插入到IDEA的插座**(Extension Points)** 中，才能让这些功能在IDEA中生效。例如，自定义一个工具栏按钮，这时候需要写一个Extension。

Extensions 和**Extension Points** 注册使用

在IntelliJ IDEA插件开发中，我们通常通过 plugin.xml 文件来注册Extensions和使用Extension Points，例如：

<extensions defaultExtensionNs="com.intellij">
    <applicationService serviceImplementation="com.example.MyServiceClass"/>
</extensions>

在这个例子中，applicationService 是IDEA提供的一个Extension Point ，通过 MyServiceClass 这个Extension扩展了IDEA的应用级服务功能。

Project和Module概述

在IntelliJ平台中，Project 和 Module是两个重要的概念：

• Project ：代表IntelliJ IDEA中的整个项目。一个项目可以包含多个模块，插件通过 Project 对象可以访问整个项目的结构、文件系统、配置等。

• Module ：是项目的一部分，通常对应于某种逻辑或物理单位，如一个Java模块、一个Gradle子项目等。模块封装了源代码、依赖等，插件可以通过 Module 对象访问模块级别的资源。

PSI概述

PSI 在IntelliJ IDEA插件开发中是一个非常重要的概念，它是Program Structure Interface 的缩写。简单来说，PSI是IntelliJ IDEA用来表示代码结构的抽象模型，通过它，插件开发者可以以编程的方式解析、分析和修改源代码。

PSI是什么

PSI是IntelliJ平台的一部分，它提供了一种面向抽象语法树（AST，Abstract Syntax Tree）的访问方式。可以将它看作是IntelliJ IDEA对源代码的抽象表示。不同语言的代码（如Java、Kotlin、Python等）都可以通过PSI表示，形成统一的模型。

在代码编辑器中，代码实际上只是文本文件。但PSI通过解析这些代码，将其表示为一个可遍历的树形结构，每个节点表示代码中的某一部分（如类、方法、变量、注释等）。开发者可以通过PSI访问、操作这些节点，从而实现对代码的分析、理解和修改。

PSI用途

PSI的主要作用 是为IntelliJ IDEA提供对源代码的深度分析和操作能力。通过PSI，开发者可以编写代码检查、自动补全、重构工具等。例如，编写一个插件来检查代码中的命名规范，或在特定上下文中自动补全方法。

PSI主要组件

PSI的主要组成部分：

• PSI Element（PSI元素）PSI元素是PSI系统的基础，每一个PSI元素对应代码中的一个语法节点。例如，一个类是一个PSI元素，一个方法也是一个PSI元素。通过PSI元素，你可以获取语法树中的各种信息。

• PSI FilePSI File是一个特殊的PSI元素，它表示一个源代码文件。所有代码都是通过PSI File这个入口访问的。比如，一个Java文件可以表示为一个PsiJavaFile。

• PSI Tree（PSI树）PSI树表示源代码的层级结构，整个文件可以被看作一个树，而PSI元素就是树的节点。例如，一个类包含若干个方法，方法里面包含若干个语句，每个语句都是树的一部分。

Virtual File System概述

IntelliJ平台中的Virtual File System (VFS) 是一个抽象层，它用来管理IntelliJ IDEA 中的所有文件资源。VFS不直接操作磁盘文件，而是提供一个虚拟文件的视图，插件可以通过它高效地访问和修改文件。

• 用途：插件可以通过VFS读取、写入、监听文件变化。它与PSI相结合时尤其强大，可以同时操作文件的物理结构和语法结构。

• 主要类：

  • VirtualFile：表示一个虚拟文件或目录。

  • VirtualFileManager：管理和监听虚拟文件系统的变化。

示例代码：

VirtualFile file = VirtualFileManager.getInstance().findFileByUrl("file://path/to/file");
if (file != null) {
    String content = new String(file.contentsToByteArray(), StandardCharsets.UTF_8);
    System.out.println("File Content: " + content);
}

DataContext和Data Keys概述

DataContext 是 IntelliJ 平台中用于在不同组件之间传递数据的机制。通过它，插件可以在执行 Action 或 Extension 时获取上下文相关的数据。

• 用途 ：在用户执行操作时，插件可能需要访问当前的文件、光标位置、选中的文本等上下文数据。DataContext 提供了一种统一的方式来访问这些信息。

• Data Keys ：IntelliJ提供了一些预定义的 DataKey，例如 CommonDataKeys.PROJECT、CommonDataKeys.EDITOR。这些 DataKey 可以用来获取具体的数据。

  示例代码：

Project project = CommonDataKeys.PROJECT.getData(event.getDataContext());
if (project != null) {
    // 对项目进行操作
}

Messages API概述

在插件中，有时需要与用户交互，比如显示提示框、错误信息等。IntelliJ平台提供了Messages API，可以方便地展示对话框和提示框。

• 用途：用来向用户展示信息，如确认对话框、输入框、消息提示框等。

  示例代码：

Messages.showMessageDialog(project, "Hello, World!", "Information", Messages.getInformationIcon());

IntelliJ平台提供了许多强大的API和扩展机制，帮助开发者创建功能丰富的插件。在本章节中，我们介绍了插件代码结构、Action、扩展点、PSI、虚拟文件系统、DataContext及其相关概念。在后续章节中，我们将进一步探讨如何利用这些API来创建更复杂、更有用的插件。