如何开发一款自己的IntelliJ IDEA插件

最新推荐文章于 2024-08-19 23:25:31 发布

Java-之父

最新推荐文章于 2024-08-19 23:25:31 发布

阅读量231

点赞数 4

文章标签： intellij-idea java ide

本文链接：https://blog.csdn.net/CTZL123456/article/details/141323153

版权

IntelliJ IDEA是JetBrains旗下的一款功能强大的Java集成开发环境（IDE），以其强大的插件支持和灵活的定制功能著称。通过开发插件，开发者能够为IDEA增加定制功能，提升生产力，并满足团队特定的需求。本指南将带你深入了解如何从零开始开发一个完整的IntelliJ IDEA插件。

1. 开发环境的准备

在开始��件开发之前，首先需要设置好开发环境。以下是详细步骤：

安装IntelliJ IDEA Ultimate版：尽管你可以使用社区版开发插件，但Ultimate版提供了更多的功能支持，如对更多语言和框架的支持，这对复杂插件的开发十分有用。
安装JDK：插件开发通常使用JDK 8或更高版本，建议使用JDK 11或17以获得更好的性能和功能支持。
安装Gradle：Gradle是推荐的构建工具，虽然Maven也可用，但Gradle的灵活性和脚本化支持使其更适合插件开发。

确保你安装的工具版本都与最新的IntelliJ IDEA版本兼容，以避免不必要的兼容性问题。

2. 创建和配置插件项目

IntelliJ IDEA提供了快捷的项目模板，帮助开发者快速启动插件项目。以下是具体步骤：

新建项目：启动IntelliJ IDEA，选择“New Project” -> “IntelliJ Platform Plugin”。
项目配置：设置项目名称、位置、JDK版本。你可以选择Java或Kotlin作为主要开发语言，Kotlin是JetBrains推荐的语言，因其简洁的语法和强大的特性。
插件模块配置：IDE自动为你配置IntelliJ Platform SDK，它包含了插件开发所需的所有依赖和API。你可以选择需要支持的IDE版本，并根据需要添加额外的模块，如UI Designer或DevKit.

3. 理解插件项目的基本结构

了解插件项目的结构有助于你快速找到需要修改的地方：

plugin.xml：插件的核心配置文件，定义了插件的元数据、扩展点（Extension Points）、组件和服务。你在开发过程中会经常编辑此文件。
src/ ：存放插件的源代码。你可以根据需要创建多个包来组织代码。
resources/ ：用于存放非代码资源，如插件图标、国际化资源文件、模板文件、UI布局文件等。

xml

代码解读

复制代码

<idea-plugin> <id>com.example.myplugin</id> <name>My Plugin</name> <version>1.0.0</version> <vendor email="developer@example.com" url="https://example.com">My Company</vendor>  <extensions defaultExtensionNs="com.intellij">  </extensions>  <depends>com.intellij.modules.platform</depends> </idea-plugin>

4. 开发一个功能丰富的插件

为了更深入了解插件开发的过程，我们将创建一个具有以下功能的插件：

在工具菜单中添加一个新的菜单项“Say Hello”。
单击菜单项时，弹出一个对话框，显示“Hello World”。
在对话框中允许用户输入文本，并显示用户输入的文本。
将用户输入的数据存储在本地文件中，以便在下次启动IDE时恢复。

4.1 定义Action

首先，我们在plugin.xml中定义一个新的Action。这是插件的基础功能点，它将出现在IDEA的工具菜单中。

ini

代码解读

复制代码

<extensions defaultExtensionNs="com.intellij"> <actions> <action id="MyPlugin.HelloWorldAction" class="com.example.plugin.HelloWorldAction" text="Say Hello" description="Says Hello World"> <add-to-group group-id="ToolsMenu" anchor="last"/> </action> </actions> </extensions>

4.2 实现Action类

然后，在src/目录下创建com.example.plugin.HelloWorldAction类，实现Action的功能。

这边整理了一份核心Java面试笔记包括了：Java面试、Spring、JVM、MyBatis、Redis、MySQL、并发编程、微服务、Linux、Springboot、SpringCloud、MQ、Kafka 面试专题

需要全套面试笔记的【点击此处即可】免费获取

scala

代码解读

复制代码

package com.example.plugin; import com.intellij.openapi.actionSystem.AnAction; import com.intellij.openapi.actionSystem.AnActionEvent; import com.intellij.openapi.ui.Messages; public class HelloWorldAction extends AnAction { @Override public void actionPerformed(AnActionEvent e) { String name = Messages.showInputDialog(e.getProject(), "What is your name?", "Input Your Name", Messages.getQuestionIcon()); if (name != null && !name.trim().isEmpty()) { Messages.showMessageDialog(e.getProject(), "Hello " + name + "!", "Greeting", Messages.getInformationIcon()); // Save name to a local file for future use saveNameToFile(name); } } private void saveNameToFile(String name) { // Implement the logic to save name to a local file } }

4.3 持久化数据

为了在IDE重新启动后恢复用户数据，可以将数据持久化到本地文件或IDE的持久化存储中。以下是将数据存储在用户目录下的一个简单实现：

java

代码解读

复制代码

import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Paths; public class HelloWorldAction extends AnAction { private static final String FILE_PATH = System.getProperty("user.home") + "/.idea-plugin-data.txt"; @Override public void actionPerformed(AnActionEvent e) { String name = Messages.showInputDialog(e.getProject(), "What is your name?", "Input Your Name", Messages.getQuestionIcon()); if (name != null && !name.trim().isEmpty()) { Messages.showMessageDialog(e.getProject(), "Hello " + name + "!", "Greeting", Messages.getInformationIcon()); saveNameToFile(name); } } private void saveNameToFile(String name) { try (FileWriter writer = new FileWriter(FILE_PATH)) { writer.write(name); } catch (IOException ex) { ex.printStackTrace(); } } private String loadNameFromFile() { try { return new String(Files.readAllBytes(Paths.get(FILE_PATH))); } catch (IOException ex) { ex.printStackTrace(); return ""; } } }

4.4 运行和调试插件

为了测试你的插件，使用Gradle的runIde任务。这将启动一个新的IntelliJ实例，并加载你的插件。你可以在新的实例中使用你的插件，并通过断点和日志调试它。

ini

代码解读

复制代码

tasks.named("runIde").configure { jvmArgs = ["-Xmx2g", "-XX:+HeapDumpOnOutOfMemoryError"] }

通过修改jvmArgs，你可以为插件调试提供更多的内存，或启用更详细的日志。

5. 扩展插件功能

除了基本的UI交互和数据持久化，你还可以为插件添加更多功能，例如：

代码补全：提供智能提示和代码补全功能。
文件模板：定义自定义的代码模板，帮助快速生成常用代码。
自定义视图：在IDE中创建独立的工具窗口或对话框，显示插件的特定信息。
外部工具集成：与外部工具或服务集成，如CI/CD系统或数据库。

5.1 添加代码补全

假设你要为特定的文件类型提供代码补全，首先需要定义一个扩展点，在plugin.xml中添加：

ini

代码解读

复制代码

<extensions defaultExtensionNs="com.intellij"> <completion.contributor language="JAVA" implementationClass="com.example.plugin.MyCompletionContributor"/> </extensions>

然后，创建MyCompletionContributor类，实现代码补全逻辑：

less

代码解读

复制代码

package com.example.plugin; import com.intellij.codeInsight.completion.CompletionContributor; import com.intellij.codeInsight.completion.CompletionParameters; import com.intellij.codeInsight.completion.CompletionProvider; import com.intellij.codeInsight.completion.CompletionResultSet; import com.intellij.util.ProcessingContext; import org.jetbrains.annotations.NotNull; public class MyCompletionContributor extends CompletionContributor { public MyCompletionContributor() { extend(CompletionType.BASIC, PlatformPatterns.psiElement(), new CompletionProvider<>() { @Override protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet result) { result.addElement(LookupElementBuilder.create("myCustomCompletion")); } }); } }

5.2 自定义视图

要创建一个自定义工具窗口，可以使用ToolWindowFactory：

java

代码解读

复制代码

package com.example.plugin; import com.intellij.openapi.project.DumbAware; import com.intellij.openapi.wm.ToolWindow; import com.intellij.openapi.wm.ToolWindowFactory; import com.intellij.ui.content.Content; import com.intellij.ui.content.ContentFactory; public class MyToolWindowFactory implements ToolWindowFactory, DumbAware { @Override public void createToolWindowContent(Project project, ToolWindow toolWindow) { MyToolWindow myToolWindow = new MyToolWindow(toolWindow); ContentFactory contentFactory = ContentFactory.SERVICE.getInstance(); Content content = contentFactory.createContent(myToolWindow.getContent(), "", false); toolWindow.getContentManager().addContent(content); } }