【工具使用】小白入门idea插件开发

最新推荐文章于 2025-11-12 14:12:19 发布
原创 最新推荐文章于 2025-11-12 14:12:19 发布 · 4.4k 阅读 · 24 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#intellij-idea #java #ide

文章目录

开发流程

下面是一个完整的 IntelliJ IDEA 插件开发流程，从环境搭建到发布，逐步讲解：

一、开发环境准备

  1. 安装 IntelliJ IDEA

    • 推荐使用最新版本的 IntelliJ IDEA Ultimate（社区版也能开发插件，但某些功能受限）。
    • 下载地址：https://www.jetbrains.com/idea/

  2. 安装 JDK

    • 需要 JDK 11 或更高版本（推荐 JDK 17）。
    • 确保环境变量配置正确。

  3. 配置 IntelliJ Plugin SDK

    • 打开 IDEA，进入 File -> Project Structure -> SDKs。
    • 添加 IntelliJ Platform Plugin SDK，选择 IDEA 安装目录（会自动检测所需依赖）。

二、创建插件项目

  1. 新建项目

    • 选择 File -> New -> Project。
    • 项目类型选择 IntelliJ Platform Plugin。
    • 模板可选 Gradle（推荐）或 DevKit（旧版）。
      • Gradle 更灵活，支持依赖管理，适合复杂插件。
      • DevKit 适合简单插件，但已逐渐被弃用。

  2. 配置项目基本信息

    • 填写 GroupId（如 com.yourcompany）、ArtifactId（插件名称）、版本号等。
    • 确保选择正确的 JDK 和 IntelliJ Platform SDK。

  3. 项目结构

    • 生成的项目包含以下关键文件：
      • src/main/java: Java/Kotlin 代码目录。
      • resources/META-INF/plugin.xml: 插件的核心配置文件。
      • build.gradle.kts（或 build.gradle）: Gradle 构建脚本。

三、插件核心配置（plugin.xml）

在 plugin.xml 中定义插件元数据和功能扩展点：

<idea-plugin>
    <id>com.yourcompany.plugin-name</id>
    <name>Your Plugin Name</name>
    <version>1.0.0</version>
    <vendor email="support@yourcompany.com" url="https://yourcompany.com">Your Company</vendor>

    <description><![CDATA[
        插件功能描述，支持 HTML 格式。
    ]]></description>

    <!-- 依赖的插件（可选） -->
    <depends>com.intellij.modules.platform</depends>

    <!-- 扩展点定义 -->
    <extensions defaultExtensionNs="com.intellij">
        <!-- 例如注册工具窗口 -->
        <toolWindow id="MyToolWindow" anchor="right" factoryClass="com.yourcompany.MyToolWindowFactory"/>
    </extensions>

    <!-- 注册动作（Action） -->
    <actions>
        <action id="YourAction" class="com.yourcompany.YourAction" text="Action Text" description="Action Description">
            <add-to-group group-id="ToolsMenu" anchor="first"/>
        </action>
    </actions>
</idea-plugin>

四、编写插件功能

1. 实现 Action（动作）

Action 是插件的入口点，例如菜单项、工具栏按钮等。

public class MyAction extends AnAction {
    @Override
    public void actionPerformed(@NotNull AnActionEvent e) {
        // 点击动作后的逻辑
        Project project = e.getProject();
        Messages.showMessageDialog(project, "Hello World!", "Greeting", Messages.getInformationIcon());
    }
}
2. 使用扩展点（Extensions）
  • 工具窗口（ToolWindow）: 创建自定义界面。
  • 编辑器监听（EditorListener）: 监听编辑器事件。
  • 代码分析（Inspection）: 自定义代码检查规则。
  • 文件类型（FileType）: 支持新文件类型。
3. 界面开发
  • 使用 Swing 或 IntelliJ 的 UI Designer 创建界面。
  • 推荐使用 Kotlin UI DSL（JetBrains 官方推荐）构建现代化界面。

五、调试与运行

  1. 运行插件

    • 点击 Gradle 任务的 runIde，会启动一个沙盒 IDEA 实例，插件已自动加载。
    • 在沙盒中测试插件功能。

  2. 调试

    • 在代码中设置断点，直接以 Debug 模式运行 runIde。
    • 支持热重载（修改代码后无需重启沙盒）。

六、打包与发布

1. 生成 JAR 包
  • 执行 Gradle 任务 buildPlugin，生成的 JAR 文件在 build/libs 目录。
  • 插件 JAR 包含所有依赖（如果配置了 shadowJar）。
2. 发布到 JetBrains 插件市场
  • 访问 JetBrains Plugins Repository。
  • 注册账号并上传 JAR 文件，填写插件描述、截图等信息。
  • 审核通过后，用户可通过 IDEA 内置插件市场安装。
3. 本地安装
  • 用户可将 JAR 文件拖入 IDEA 窗口，或通过 File -> Settings -> Plugins -> Install Plugin from Disk 安装。

七、核心概念与 API

  1. PSI（Program Structure Interface）

    • 用于操作代码的抽象语法树（AST），例如解析、修改 Java/Kotlin 代码。

  2. AnAction

    • 定义用户触发的动作（如菜单项、快捷键）。

  3. Services

    • 插件可以通过 Service 实现单例管理或全局状态。

  4. PersistentState

    • 使用 PersistentStateComponent 保存插件配置。

八、注意事项

  1. 兼容性

    • 在 build.gradle 中指定兼容的 IDEA 版本：
      intellij {
    version = '2023.1' // 指定 IDEA 版本
    type = 'IC' // 社区版，'IU' 为 Ultimate 版
}

  2. 依赖管理

    • 通过 Gradle 添加第三方库依赖：
      dependencies {
    implementation 'com.squareup.okhttp3:okhttp:4.9.3'
}

  3. 性能优化

    • 避免阻塞 UI 线程，长时间任务需在后台线程执行。

  4. 文档与社区

九、常见问题

  • 插件无法加载: 检查 plugin.xml 配置和依赖。
  • API 过时: 使用最新版本的 IntelliJ SDK。
  • UI 卡顿: 确保耗时操作在后台线程执行。

按照这个流程，你可以从零开始开发一个功能完整的 IntelliJ 插件。如果有具体需求（如代码分析、自定义语言支持等），可以进一步深入相关 API！

核心语法

以下是 IntelliJ IDEA 插件开发的核心语法和关键 API 详解，结合代码示例和关键概念，帮助你快速上手：

1. 动作（Action）

Action 是用户触发操作的核心入口（如菜单项、快捷键、工具栏按钮）。

定义 Action
public class MyAction extends AnAction {
    @Override
    public void actionPerformed(@NotNull AnActionEvent e) {
        // 获取当前项目
        Project project = e.getProject();
        // 显示对话框
        Messages.showMessageDialog(project, "Hello Plugin!", "Greeting", Messages.getInformationIcon());
    }

    @Override
    public void update(@NotNull AnActionEvent e) {
        // 动态控制 Action 是否可见/启用
        Project project = e.getProject();
        e.getPresentation().setEnabledAndVisible(project != null);
    }
}
注册 Action（plugin.xml）
<actions>
    <action 
        id="MyPlugin.MyAction" 
        class="com.example.MyAction" 
        text="Say Hello" 
        description="Show a greeting message">
        <!-- 添加到菜单 -->
        <add-to-group group-id="ToolsMenu" anchor="first"/>
        <!-- 绑定快捷键 -->
        <keyboard-shortcut keymap="$default" first-keystroke="ctrl shift H"/>
    </action>
</actions>

2. 扩展点（Extensions）

通过 plugin.xml 扩展 IDEA 的核心功能（如工具窗口、编辑器监听等）。

工具窗口（ToolWindow）
public class MyToolWindowFactory implements ToolWindowFactory {
    @Override
    public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindow toolWindow) {
        // 创建界面组件
        JPanel panel = new JPanel();
        panel.add(new JLabel("My Tool Window"));
        // 将组件添加到工具窗口
        ContentFactory contentFactory = ContentFactory.getInstance();
        Content content = contentFactory.createContent(panel, "", false);
        toolWindow.getContentManager().addContent(content);
    }
}

注册工具窗口（plugin.xml）:

<extensions defaultExtensionNs="com.intellij">
    <toolWindow 
        id="MyToolWindow" 
        anchor="right" 
        factoryClass="com.example.MyToolWindowFactory"/>
</extensions>

3. PSI（Program Structure Interface）

用于操作代码的抽象语法树（AST），支持代码解析和修改。

获取当前文件的 PSI
public void actionPerformed(@NotNull AnActionEvent e) {
    Editor editor = e.getData(CommonDataKeys.EDITOR);
    PsiFile psiFile = e.getData(CommonDataKeys.PSI_FILE);
    if (editor == null || psiFile == null) return;

    // 获取当前光标位置元素
    int offset = editor.getCaretModel().getOffset();
    PsiElement element = psiFile.findElementAt(offset);
}
修改代码
// 在写操作中修改 PSI
WriteCommandAction.runWriteCommandAction(project, () -> {
    PsiElementFactory factory = JavaPsiFacade.getElementFactory(project);
    PsiMethod method = factory.createMethodFromText("public void test() {}", null);
    // 将方法添加到类中
    PsiClass psiClass = ...; // 获取目标类
    psiClass.add(method);
});

4. 服务（Services）

用于管理插件全局状态或单例服务。

定义服务
public interface MyService {
    void doSomething();
}

// 实现类
@Service
public final class MyServiceImpl implements MyService {
    @Override
    public void doSomething() {
        // 具体逻辑
    }
}
使用服务
MyService service = project.getService(MyService.class);
service.doSomething();

5. 持久化状态（PersistentState）

保存插件配置到 IDE 的配置文件。

定义状态类
@State(name = "MyPluginSettings", storages = @Storage("myplugin.xml"))
public class MySettings implements PersistentStateComponent<MySettings.State> {
    public static class State {
        public String username = "default";
        public boolean enabled = true;
    }

    private State state = new State();

    @Override
    public State getState() {
        return state;
    }

    @Override
    public void loadState(@NotNull State state) {
        this.state = state;
    }
}
使用配置
MySettings settings = ServiceManager.getService(MySettings.class);
String username = settings.getState().username;
settings.getState().enabled = false;

6. 界面开发

Swing 组件
JPanel panel = new JPanel(new BorderLayout());
JButton button = new JButton("Click Me");
button.addActionListener(e -> {
    // 按钮点击事件
});
panel.add(button, BorderLayout.CENTER);
Kotlin UI DSL（推荐）
// 在 Kotlin 中使用
panel {
    row {
        button("Click Me") {
            // 点击事件
        }
        checkBox("Enable Feature")
    }
}

7. 监听编辑器事件

public class MyEditorListener implements EditorFactoryListener {
    @Override
    public void editorCreated(@NotNull EditorFactoryEvent event) {
        Editor editor = event.getEditor();
        Document document = editor.getDocument();
        // 监听文档变化
        document.addDocumentListener(new DocumentListener() {
            @Override
            public void documentChanged(@NotNull DocumentEvent event) {
                // 处理变化
            }
        });
    }
}

注册监听器（plugin.xml）:

<applicationListeners>
    <listener 
        class="com.example.MyEditorListener" 
        topic="com.intellij.openapi.editor.event.EditorFactoryListener"/>
</applicationListeners>

8. 代码检查与快速修复

自定义检查器
public class MyInspection extends AbstractBaseJavaLocalInspectionTool {
    @Override
    public @NotNull PsiElementVisitor buildVisitor(
        @NotNull ProblemsHolder holder,
        boolean isOnTheFly
    ) {
        return new JavaElementVisitor() {
            @Override
            public void visitMethod(PsiMethod method) {
                if (method.getName().startsWith("test")) {
                    holder.registerProblem(
                        method.getNameIdentifier(),
                        "方法名不应以 'test' 开头",
                        ProblemHighlightType.WARNING
                    );
                }
            }
        };
    }
}
快速修复（QuickFix）
public class RenameMethodFix implements LocalQuickFix {
    @Override
    public @NotNull String getFamilyName() {
        return "重命名方法";
    }

    @Override
    public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
        PsiMethod method = (PsiMethod) descriptor.getPsiElement();
        method.setName("newName");
    }
}

9. 异步任务

避免阻塞 UI 线程，使用 ApplicationManager.getApplication().executeOnPooledThread() 或 AsyncTask。

ApplicationManager.getApplication().executeOnPooledThread(() -> {
    // 后台任务
    String result = doHeavyWork();
    // 更新 UI（需切回 UI 线程）
    ApplicationManager.getApplication().invokeLater(() -> {
        Messages.showInfoMessage(result, "Result");
    });
});

10. 通知与对话框

显示通知
NotificationGroupManager.getInstance()
    .getNotificationGroup("MyPlugin")
    .createNotification("任务完成", NotificationType.INFORMATION)
    .notify(project);
自定义对话框
public class MyDialog extends DialogWrapper {
    private JTextField textField;

    protected MyDialog(Project project) {
        super(project);
        init();
        setTitle("输入对话框");
    }

    @Override
    protected JComponent createCenterPanel() {
        JPanel panel = new JPanel(new BorderLayout());
        textField = new JTextField();
        panel.add(textField, BorderLayout.CENTER);
        return panel;
    }

    public String getInput() {
        return textField.getText();
    }
}

总结

  • 核心 API：AnAction, ToolWindow, PSI, Services, PersistentStateComponent
  • 线程安全：UI 操作必须在主线程，耗时操作需异步执行
  • 版本兼容：通过 build.gradle 指定兼容的 IDEA 版本
  • 官方文档：IntelliJ Platform SDK Docs

通过掌握这些核心语法和 API，你可以实现从简单的工具插件到复杂的代码分析功能。建议结合官方示例代码实践调试！

【实战篇】Idea 集成主流 AI 插件的方法实战
商务合作|问题讨论|交流学习 请联系作者微信，加微信请务必注明来意，博客主页有联系方式
02-07 4526
通过上面的步骤，我们就成功地在 Idea 里集成了几款主流的 AI 插件。这些插件各有各的特点和优势，在我们写代码的过程中，都能发挥出巨大的作用。它们就像是我们的得力助手，能帮我们提高开发效率，减少代码错误，让我们的编程之旅变得更加轻松愉快。大家在集成插件的过程中，如果遇到什么问题，或者有什么使用心得，都欢迎在评论区留言交流哦。
idea从入门到精通
weixin_74159962的博客
06-04 2002
提示：idea的重要性【1】IntelliJ IDEA就是Java的IDE。【2】市场占有率竹节攀升，超过了Eclipse。提示：以下是本篇文章正文内容，下面内容本人参考了一些资料，如有侵权马上删除。
IDEA插件开发实践
wa_ka_ka的博客
08-12 1197
开启IDEA内部模式（使用UI检查器定位代码）后，我们可以通过 ctrl+alt+鼠标左键点击对应菜单，可以获取到点击信息，然后根据关键类信息，到idea源码中查找到对应的代码，在插件开发中通过调用对应的api就可以修改配置信息。当然，idea中有开关可以控制，但每次都进行设置不太方便，现在开发一个简单插件，实现当同时按下ctrl+alt+win键时，双击鼠标则是驼峰选中，释放时是单词选中。win键抬起，关闭驼峰选中。日常开发过程中，我们鼠标双击会选中整个单词，现在想实现按照驼峰选中，效果如图。
idea插件开发-必备文档
编程是一门实践技术
05-24 3212
intellij plugin开发过程中需要关注的网站及常用的工具
效率翻倍！Spring Boot + IDEA插件开发全指南：手把手打造专属代码生成器
最新发布
小筱在线博客
11-12 1582
在现代企业级开发中，重复性编码工作占据了开发者大量时间。根据JetBrains的开发者调查报告，超过65%的Java开发者每天要花费1-3小时在重复性编码任务上。Spring Boot虽然通过自动配置简化了项目搭建，但在业务代码层面，我们仍然需要大量重复的Controller-Service-Repository编写工作。本文将带你深入探索如何结合Spring Boot与IDEA插件开发技术，打造属于你自己的智能代码生成器，真正实现开发效率的指数级提升。
IntelliJ IDEA插件开发-开发环境搭建
JavaQ
10-12 1533
本节将带你一步一步配置IntelliJ IDEA开发插件所需的环境，通过这些详细步骤完成开发环境的搭建。JDK下载安装IntelliJ IDEA插件开发需要JDK支持，可以使用JDK8或更高版本。插件开发时，JDK主要用于编译和运行Java代码。步骤：前往 Oracle 官方 JDK 下载页面 或使用开源的 OpenJDK，我这里选择Java8，下载适合你系统的JDK版本并安装。安装时记住JDK的...
IntelliJ IDEA插件开发-核心概念介绍
JavaQ
10-29 1506
在深入学习插件开发之前，理解IntelliJ IDEA平台的基础概念至关重要。IntelliJ平台提供了丰富的API，支持插件开发者实现几乎任何功能。以下将介绍插件开发过程中常用的一些核心概念和API。插件代码结构以HelloWorldPlugin项目代码目录结构为例：HelloWorldPlugin/ ├── src/ │ └── main/ │ │── java/ │ ...
idea插件开发入门
qiushily2030的博客
03-06 7490
另外使用IDEA提供的Swing Designer设计器还是挺方便的，自动生成的样式和布局代码为了避免被修改，也不会被我们看到（与NetBeans不同），所以最终代码很简洁。其实很简单，实现方法就是先创建一个Dialog，然后在Swing设计器中设计好Dialog中的控件布局，最后在Action中显示出对话框。运行起来就会发现，原来会启动一个新的Intellij IDEA实例，可以选择新建项目，也可以选择导入项目，我们选择导入一个项目。最终效果就是这样的了，我们在设计器里设计的面板嵌入到了右边。
IDEA插件开发
weixin_44486583的博客
12-21 4455
简易的IDEA的插件开发流程
IDEA入门使用篇-项目实战
天的博客
09-11 763
简单示例下IDEA的使用，如何创建/导入项目等。这里我们以主流的maven+springboot项目为例，对其他的老项目新项目等仍有一定参考意义。因为我们主要示例项目中IDEA的常用操作，所以关于项目的部分会有所忽略，重点放在工具的使用上。
Nexus简介及小白使用IDEA打包上传到Nexus3私服详细教程_ider2021 引用 nexus 上传
2401_84519998的博客
05-17 1123
当我学到一定基础，有自己的理解能力的时候，会去阅读一些前辈整理的书籍或者手写的笔记资料，这些笔记详细记载了他们对一些技术点的理解，这些理解是比较独到，可以学到不一样的思路。网安所有方向的技术点做的整理，形成各个领域的知识点汇总，它的用处就在于，你可以按照上面的知识点去找对应的学习资源，保证自己学得较为全面。观看零基础学习视频，看视频学习是最快捷也是最有效果的方式，跟着视频中老师的思路，从基础到深入，还是很容易入门的。插件仓库，maven 的运行依赖插件，也需要从私服下载插件。profile 的 id。
IntelliJ IDEA插件开发基础（中文）.pdf
01-17
IntelliJ IDEA插件开发基础（中文）.pdf
MyBatis-Plus 快速入门案例(小白教程)
08-24
1. 使用 IDEA 快速搭建 Spring Boot 项目，并填写相关信息。 2. 引入所需要的 Maven 依赖，例如 Lombok 依赖、MyBatis-Plus 启动器依赖、MySQL 驱动依赖等。 3. 创建数据库表和对应的实体类，例如创建用户表和用户...
IDEA | 插件开发
m0_59044499的博客
03-21 1812
不知道大家有没有想过自己开发一款 IDEA 插件呢？这篇文章只是简单带各位小伙伴入门一下 IDEA 插件开发，个人精力有限，暂时不会深入探讨太多。如果你已经有 IDEA 插件开发的相关经验的话，这篇文章就可以不用看了，因为会浪费你 3 分钟的时间。好的废话不多说！咱们直接开始!
idea 插件开发
pjw1217的博客
12-28 6399
前两天遇到一个好玩的事，我的前前前。。。公司的同事，做了一个他们的软件产品介绍的直播，然后中间他有用到ecplise自定义了插件，做一个文件的转换，看起来好像挺好玩的。于是我就想，idea市面上也有很多的插件，我也想自己做一个玩玩。说干就干，开搞，菜鸡就是爱玩！！！
Jetbrains Idea插件开发教程
~
07-31 7204
在idea开发过程中，希望按需驼峰选中文本。现在默认是一整个单词选中，只有在设置–>智能按键 中开启了使用"CamelHumps单词"时能够驼峰选中。但是这种情况比较粗暴，直接全局开启了。但是在日常开发中，其实选中大部分是整个单词一起选中。只有少部分情况是按照驼峰选中。所以就需要一块插件，能够快捷开关驼峰选中的能力，仅在需要的时候开启。
开发idea插件教程
热门推荐
zhouzhenyong的专栏
08-24 1万+
效果 自己也编写了一个代码生成器插件并发布到了仓库中，可以直接搜索“Neo Coder”，开发的这个插件是位于Tool Windows里面的，如下 要功能，就是根据建表语句，直接生成DO和DAO层的代码，不过其中的Orm框架采用的是框架Neo： https://github.com/SimonAlong/Neo 下面讲述下，如果创建自己的idea插件 1.建项目 创建idea插件项目很简单，idea对应的项目就有，如下 其中plugin.xml就是idea给我们的配置文件，后续要将我们的插件在哪些位置
【IDEA插件开发】快速入门系列01 开发一个简单的Idea插件
Vaxue的博客
05-29 4456
英文好的建议阅读官方文档IDEA插件开发官方文档：https://plugins.jetbrains.com/docs/intellij/welcome.html。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

问道飞鱼

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值