手把手教你开发 IntelliJ IDEA 插件

IntelliJ IDEA 是一款功能强大的 Java 集成开发环境（IDE），被广泛应用于各种 Java 项目的开发。除了其核心功能外，IntelliJ IDEA 还提供了强大的插件系统，允许开发者通过编写插件来扩展 IDE 的功能，以满足特定的开发需求或提高开发效率。

本文将详细介绍 IntelliJ IDEA 插件开发的过程，从环境搭建到插件发布，手把手教你开发出属于自己的 IntelliJ IDEA 插件。

一、准备工作：搭建开发环境

1.1 安装 JDK

IntelliJ IDEA 插件开发需要 Java Development Kit (JDK) 的支持。请确保你的电脑上已经安装了 JDK 8 或更高版本。你可以从 Oracle 官网或其他渠道下载并安装 JDK。

安装完成后，请配置好 JAVA_HOME 环境变量，并确保在命令行中可以运行 java -version 命令查看 JDK 版本信息。

1.2 安装 IntelliJ IDEA

IntelliJ IDEA 有两个版本：社区版（Community Edition）和旗舰版（Ultimate Edition）。社区版是免费的，而旗舰版是收费的。对于插件开发来说，社区版已经足够使用。你可以从 JetBrains 官网下载并安装 IntelliJ IDEA 社区版。

1.3 创建插件项目

IntelliJ IDEA 本身就提供了创建插件项目的模板。

1. 打开 IntelliJ IDEA，点击 "Create New Project"。
2. 在左侧的项目类型列表中，选择 "IntelliJ Platform Plugin"。
3. 在右侧的配置中：
   • Project SDK: 选择你安装的 JDK 版本。
   • Plugin SDK: 如果没有，点击 "New..."，选择 IntelliJ IDEA 的安装目录作为 SDK。
   • Project name: 输入你的插件项目名称。
   • Project location: 选择项目存放的目录。
4. 点击 "Next"，然后点击 "Finish"。

IntelliJ IDEA 会自动为你创建一个基本的插件项目结构，并下载所需的依赖。

1.4 项目结构

创建好的插件项目包含以下几个关键文件和目录：

• src/main/java: 存放插件的 Java 源代码。
• src/main/resources: 存放插件的资源文件，如图片、配置文件等。
• src/main/resources/META-INF/plugin.xml: 插件的配置文件，描述插件的基本信息、依赖、扩展点等。这是插件开发中最重要的文件之一。
• build.gradle.kts: 项目的构建脚本，用于配置项目的依赖、构建过程等。

二、plugin.xml 文件详解

plugin.xml 文件是插件的核心配置文件，它定义了插件的各种属性和行为。下面是一个基本的 plugin.xml 文件示例：

```xml

com.yourcompany.yourplugin
Your Plugin Name
Your Company Name
<![CDATA[
Enter short description for your plugin here.
most HTML tags may be used
]]>

com.intellij.modules.platform

```

• <id>: 插件的唯一标识符，通常使用反向域名表示法（例如 com.yourcompany.yourplugin）。
• <name>: 插件的名称，将显示在 IntelliJ IDEA 的插件列表中。
• <vendor>: 插件的开发者信息，包括邮箱、网址和名称。
• <description>: 插件的描述，用于介绍插件的功能和用途。可以使用 HTML 标签。
• <depends>: 插件的依赖项。com.intellij.modules.platform 表示依赖 IntelliJ IDEA 平台的核心模块。如果你的插件需要依赖其他模块或插件，也需要在这里声明。
• <extensions>: 插件的扩展点。IntelliJ IDEA 提供了许多扩展点，允许插件扩展 IDE 的各种功能。例如，你可以添加自定义的编辑器、工具窗口、检查器等。
• <actions>: 插件的操作。操作是插件与用户交互的主要方式。例如，你可以添加自定义的菜单项、工具栏按钮、快捷键等。

三、开发插件功能：Action

Action 是 IntelliJ IDEA 插件中最常见的组件之一，它代表一个用户可以触发的操作。Action 可以添加到菜单、工具栏、快捷键等地方。

3.1 创建 Action

1. 在 src/main/java 目录下，创建一个新的 Java 类，例如 MyAction.java。
2. 让这个类继承 com.intellij.openapi.actionSystem.AnAction 类。
3. 重写 actionPerformed 方法，在这个方法中编写 Action 被触发时要执行的代码。

```java
package com.yourcompany.yourplugin;

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

public class MyAction extends AnAction {

@Override
public void actionPerformed(AnActionEvent e) {
    // 在这里编写 Action 被触发时要执行的代码
    Messages.showMessageDialog("Hello, World!", "My Action", Messages.getInformationIcon());
}

}
```

3.2 注册 Action

要让 Action 生效，需要在 plugin.xml 文件中进行注册。

1. 在 plugin.xml 文件的 <actions> 标签中，添加一个 <action> 标签。
2. 设置 <action> 标签的属性：
   • id: Action 的唯一标识符，建议使用类名。
   • class: Action 类的全限定名。
   • text: Action 的显示文本，将显示在菜单或工具栏上。
   • description: Action 的描述。

xml
<actions>
<action id="com.yourcompany.yourplugin.MyAction"
class="com.yourcompany.yourplugin.MyAction"
text="My Action"
description="This is my first action">
<add-to-group group-id="ToolsMenu" anchor="last"/>
</action>
</actions>
* <add-to-group> 标签用于将 Action 添加到指定的菜单或工具栏。
* group-id指定要添加到的组，ToolsMenu表示添加到"Tools"菜单。
* anchor属性指定 Action 在组中的位置，first 表示添加到开头，last 表示添加到末尾，before 和 after 可以相对于其他 Action 进行定位。

3.3 运行和测试

1. 点击 IntelliJ IDEA 工具栏上的 "Run" 按钮（绿色三角形）。
2. IntelliJ IDEA 会启动一个新的实例，并加载你的插件。
3. 在新实例中，打开 "Tools" 菜单，你应该能看到你添加的 "My Action" 菜单项。
4. 点击 "My Action" 菜单项，你应该能看到一个弹出的对话框，显示 "Hello, World!"。

四、开发插件功能：其他常用组件

除了 Action，IntelliJ IDEA 插件还提供了许多其他常用的组件，可以帮助你实现更复杂的功能。

4.1 Tool Window

Tool Window 是 IntelliJ IDEA 界面中的一个面板，通常位于 IDE 的边缘。你可以创建自定义的 Tool Window 来显示插件的界面和信息。

1. 创建一个 Java 类，继承 com.intellij.openapi.wm.ToolWindowFactory 类。
2. 重写 createToolWindowContent 方法，在这个方法中创建 Tool Window 的内容。
3. 在 plugin.xml 文件中注册 Tool Window Factory。

4.2 Editor

IntelliJ IDEA 提供了强大的编辑器 API，允许你操作编辑器中的文本、光标、选择等。

1. 通过 AnActionEvent 对象获取当前编辑器：Editor editor = e.getData(CommonDataKeys.EDITOR);
2. 使用 Editor 对象提供的 API 操作编辑器。

4.3 Project

IntelliJ IDEA 的 Project API 允许你访问和操作当前打开的项目。

1. 通过 AnActionEvent 对象获取当前项目：Project project = e.getProject();
2. 使用 Project 对象提供的 API 操作项目。

4.4 Virtual File System

IntelliJ IDEA 的 Virtual File System (VFS) API 允许你访问和操作文件系统中的文件和目录。

1. 使用 com.intellij.openapi.vfs.VirtualFile 类表示文件和目录。
2. 使用 com.intellij.openapi.vfs.VirtualFileManager 类管理 VFS。

4.5 PSI (Program Structure Interface)

PSI 是 IntelliJ IDEA 中用于表示代码结构的 API。你可以使用 PSI 来分析、修改代码，实现代码检查、重构等功能。

1. 使用 com.intellij.psi.PsiFile 类表示文件。
2. 使用 com.intellij.psi.PsiElement 类表示代码元素。
3. 使用 PSI API 遍历和操作代码结构。

4.6 Listeners

IntelliJ IDEA提供事件监听机制，可以在特定事件发生时触发插件逻辑。

1. 创建监听器类：

   • 实现相应的监听器接口（例如，com.intellij.openapi.fileEditor.FileEditorManagerListener 用于监听文件打开和关闭事件）。
   • 重写接口中的方法，编写事件处理逻辑。

2. 注册监听器：

   • 方式一：在 plugin.xml 中注册（适用于应用程序级别监听器）：
     ```xml
     
     

   * **方式二：通过代码注册（适用于项目级别监听器）：**java
   project.getMessageBus().connect().subscribe(FileEditorManagerListener.FILE_EDITOR_MANAGER, new MyFileListener());
   ```

4.7 Background Tasks

对于耗时的操作，应在后台线程中执行，避免阻塞UI线程。

1. 使用 com.intellij.openapi.progress.ProgressManager：
   java
ProgressManager.getInstance().run(new Task.Backgroundable(project, "My Background Task") {
@Override
public void run(@NotNull ProgressIndicator indicator) {
// 执行耗时操作
indicator.setText("Processing...");
indicator.setFraction(0.5); // 设置进度
// ...
}
});
2. 使用ReadAction 和 WriteAction:
   ```java
   //ReadAction
   ApplicationManager.getApplication().runReadAction(()->{
   //只读操作，不能修改文件
   });

//WriteAction
ApplicationManager.getApplication().runWriteAction(()->{
//可以修改文件的操作
});
```

五、调试插件

IntelliJ IDEA 提供了强大的调试功能，可以帮助你调试插件代码。

1. 在你的插件代码中设置断点。
2. 点击 IntelliJ IDEA 工具栏上的 "Debug" 按钮（绿色虫子）。
3. IntelliJ IDEA 会启动一个新的实例，并加载你的插件。
4. 在新实例中，执行触发你设置断点的操作。
5. IntelliJ IDEA 会在断点处暂停，你可以查看变量值、单步执行代码等。

六、发布插件

当你完成插件的开发和测试后，就可以将插件发布到 JetBrains Plugin Repository，让其他开发者使用你的插件。

1. 构建插件：

   • 在 IntelliJ IDEA 中，打开 "Build" 菜单，选择 "Build Project"。
   • 确保在build.gradle.kts中的intelliJ{}中,设置好version。
   • 然后打开"Build"菜单，选择"Prepare Plugin Module 'your-plugin-name' For Deployment"。
     这将在项目的 build/distributions 目录下生成一个 ZIP 文件。

2. 创建 JetBrains 账户：

   • 如果你还没有 JetBrains 账户，请访问 JetBrains Account 网站创建一个账户。

3. 上传插件：

   • 访问 JetBrains Plugin Repository 网站。
   • 登录你的 JetBrains 账户。
   • 点击 "Upload Plugin" 按钮。
   • 选择你构建的 ZIP 文件，填写插件的相关信息，然后提交。

4. 审核：

   • JetBrains 团队会对你的插件进行审核。审核通过后，你的插件就会在 Plugin Repository 中发布。

七、总结与进阶

本文详细介绍了 IntelliJ IDEA 插件开发的基本流程和常用组件。通过学习本文，你应该已经掌握了开发简单插件的能力。

要开发更复杂的插件，你还需要深入学习 IntelliJ IDEA 的 API 和插件开发文档。以下是一些有用的资源：

• IntelliJ IDEA Plugin Development Documentation: https://plugins.jetbrains.com/docs/intellij/
• IntelliJ Platform SDK Documentation: https://www.jetbrains.org/intellij/sdk/docs/
• GitHub 上的开源插件: 学习其他开发者开发的插件，可以帮助你了解更多插件开发的技巧和最佳实践。

IntelliJ IDEA 插件开发是一个充满挑战和乐趣的过程。希望本文能帮助你入门 IntelliJ IDEA 插件开发，并开发出更多优秀的插件！