IntelliJ IDEA插件开发初探：打造专属的通义千问代码补全助手

你是不是也遇到过这样的场景？面对一段复杂的业务逻辑代码，想快速理解它的意图，或者想给一个刚写完的方法加上清晰的中文注释，却一时不知从何下笔。又或者，看着自己写的代码总觉得不够优雅，想寻求一些重构建议，却只能求助于同事或者去论坛大海捞针。

对于Java开发者来说，IntelliJ IDEA是我们的主力武器，它强大的智能提示和代码分析能力已经极大地提升了开发效率。但如果我们能让这个武器更“聪明”一点，直接集成一个AI大脑，让它不仅能理解代码的语法，还能理解代码的“意图”，甚至能根据我们的需求生成或优化代码，那会怎样？

今天，我们就来动手实现这个想法：开发一个简单的IDEA插件，让它集成通义千问这类大模型的API，成为你专属的智能编码助手。我们将实现几个核心功能：一键获取代码解释、自动生成方法注释、以及提供代码重构建议。整个过程就像给IDEA装上一个“外挂”，让它从工具升级为伙伴。

1. 为什么要在IDEA里集成AI助手？

在深入代码之前，我们先聊聊为什么这件事值得做。传统的IDE插件，比如代码格式化、静态检查，都是基于预设的规则。而集成大模型后，插件的“智能”来自于对自然语言和代码语义的理解，这带来了几个质的变化：

  • 从“检查”到“理解”：插件不再只是告诉你哪里语法错了，还能告诉你这段代码“是干什么的”、“为什么这么写可能有风险”。
  • 从“被动”到“主动”：你可以主动提问，比如“帮我解释一下这个设计模式的应用场景”，或者“给这个方法想个更好的名字”。
  • 上下文感知：插件运行在IDE内部，能直接获取当前文件的完整上下文（类信息、导入的包、项目结构），这让AI给出的建议远比在网页聊天框中粘贴一段代码要精准得多。

想象一下，你选中一段陌生的工具类代码，按个快捷键，侧边栏就清晰列出了它的功能、输入输出和调用示例。或者写完一个核心算法方法，插件自动生成包含参数说明、返回值描述和异常抛出的标准Javadoc注释。这些都能让编码过程更流畅，把精力更集中在核心逻辑设计上。

2. 搭建你的第一个IDEA插件项目

开发IDEA插件，官方推荐使用IntelliJ IDEA Ultimate版（社区版功能受限），并安装“IntelliJ Platform Plugin”插件。我们从头开始创建一个项目。

2.1 创建插件项目

  1. 打开IDEA，选择 File -> New -> Project...。
  2. 在左侧选择 IntelliJ Platform Plugin，右侧的Project SDK需要选择你本地安装的JDK（建议JDK 11或以上）。点击Next。
  3. 输入项目名称，例如 MyAICodeAssistant，选择项目位置，点击Finish。

项目创建好后，你会看到一个标准的Gradle项目结构。IDEA插件现在主要使用Gradle进行构建和依赖管理。核心的配置文件是 build.gradle.kts。

2.2 理解项目结构与核心配置

我们先看看自动生成的 build.gradle.kts 文件，并做一些关键修改：

plugins {
    id("java")
    id("org.jetbrains.intellij") version "1.17.3" // 使用较新的插件版本
}

group = "com.yourname"
version = "1.0-SNAPSHOT"

repositories {
    mavenCentral()
}

// 配置IntelliJ平台相关设置
intellij {
    version.set("2023.3.6") // 指定要兼容的IDEA版本，建议选择一个较新且稳定的版本
    type.set("IC") // IC: IntelliJ IDEA Community, IU: IntelliJ IDEA Ultimate
    plugins.set(listOf(/* 可在此添加依赖的其他插件，如Kotlin */))
}

tasks {
    patchPluginXml {
        sinceBuild.set("233") // 插件支持的最低构建版本
        untilBuild.set("242.*") // 插件支持的最高构建版本（使用通配符）
    }

    signPlugin {
        certificateChain.set(System.getenv("CERTIFICATE_CHAIN"))
        privateKey.set(System.getenv("PRIVATE_KEY"))
        password.set(System.getenv("PRIVATE_KEY_PASSWORD"))
    }

    publishPlugin {
        token.set(System.getenv("PUBLISH_TOKEN"))
    }
}

这里最重要的是 intellij 块中的 version，它决定了你的插件编译和运行时所依赖的IDEA API版本。选择与你日常开发相近的版本即可。

另一个关键文件是 src/main/resources/META-INF/plugin.xml，这是插件的“身份证”和“功能清单”。

<idea-plugin>
    <id>com.yourname.my-ai-code-assistant</id>
    <name>My AI Code Assistant</name>
    <vendor email="your@email.com" url="https://yourwebsite.com">Your Name</vendor>

    <description><![CDATA[
        一个集成大模型API的智能编码助手插件，提供代码解释、注释生成和重构建议功能。
    ]]></description>

    <depends>com.intellij.modules.platform</depends>
    <depends>com.intellij.modules.java</depends> <!-- 因为我们主要针对Java -->

    <extensions defaultExtensionNs="com.intellij">
        <!-- 后续我们会在这里添加扩展点，比如工具窗口、服务等 -->
    </extensions>

    <actions>
        <!-- 后续我们会在这里定义具体的菜单和按钮动作 -->
    </actions>
</idea-plugin>

3. 封装通义千问API调用

插件的大脑是AI模型，我们需要一个可靠的方式来与它通信。这里我们假设你已经获得了类似通义千问模型的API访问密钥和端点。我们将创建一个专门的服务类来封装HTTP请求。

3.1 创建API配置与请求类

首先，在 src/main/java 下创建包结构，例如 com.yourname.ai。然后创建一个配置类，用于管理API密钥和URL（注意：在实际开发中，密钥不应硬编码，应通过设置界面配置）。

package com.yourname.ai;

public class AIConfig {
    // 这些值应该从插件的持久化配置中读取
    public static final String API_KEY = "your-api-key-here";
    public static final String API_URL = "https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation";
    public static final String MODEL_NAME = "qwen-plus"; // 例如 qwen-turbo, qwen-plus

    public static String getAuthHeader() {
        return "Bearer " + API_KEY;
    }
}

接下来，创建一个用于构建请求体的数据类。不同的模型API格式可能不同，以下是一个通用示例：

package com.yourname.ai;

import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.ArrayList;
import java.util.List;

public class ChatCompletionRequest {
    private String model;
    private List<Message> messages;
    private double temperature = 0.7; // 控制创造性

    // 静态工厂方法，方便创建
    public static ChatCompletionRequest createUserRequest(String userContent) {
        ChatCompletionRequest request = new ChatCompletionRequest();
        request.setModel(AIConfig.MODEL_NAME);
        request.messages = new ArrayList<>();
        request.messages.add(new Message("user", userContent));
        return request;
    }

    // Getters and Setters
    public String getModel() { return model; }
    public void setModel(String model) { this.model = model; }
    public List<Message> getMessages() { return messages; }
    public void setMessages(List<Message> messages) { this.messages = messages; }
    public double getTemperature() { return temperature; }
    public void setTemperature(double temperature) { this.temperature = temperature; }

    // 内部消息类
    public static class Message {
        private String role;
        private String content;

        public Message(String role, String content) {
            this.role = role;
            this.content = content;
        }

        @JsonProperty("role")
        public String getRole() { return role; }
        @JsonProperty("content")
        public String getContent() { return content; }
    }
}

3.2 实现API服务客户端

现在，我们实现一个真正的服务类，使用IDEA平台推荐的 RestClient 或通用的HTTP客户端（如OkHttp）来发送请求。这里使用Java自带的 HttpClient 进行演示。

package com.yourname.ai;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.intellij.openapi.diagnostic.Logger;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class AIClientService {
    private static final Logger LOG = Logger.getInstance(AIClientService.class);
    private static final HttpClient HTTP_CLIENT = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(30))
            .build();
    private static final ObjectMapper MAPPER = new ObjectMapper();

    public String getChatCompletion(String userPrompt) throws Exception {
        ChatCompletionRequest request = ChatCompletionRequest.createUserRequest(userPrompt);
        String requestBody = MAPPER.writeValueAsString(request);

        HttpRequest httpRequest = HttpRequest.newBuilder()
                .uri(URI.create(AIConfig.API_URL))
                .header("Authorization", AIConfig.getAuthHeader())
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .timeout(Duration.ofSeconds(60))
                .build();

        HttpResponse<String> response = HTTP_CLIENT.send(httpRequest, HttpResponse.BodyHandlers.ofString());

        if (response.statusCode() == 200) {
            // 这里需要根据通义千问API的实际返回JSON结构来解析
            // 假设返回格式为 {"output":{"text":"这里是AI回复的内容"}}
            var rootNode = MAPPER.readTree(response.body());
            return rootNode.path("output").path("text").asText("未能解析出回复内容。");
        } else {
            LOG.warn("API请求失败，状态码：" + response.statusCode() + "，响应体：" + response.body());
            throw new RuntimeException("AI服务请求失败: " + response.statusCode());
        }
    }
}

这个 AIClientService 类就是插件与外部AI模型通信的桥梁。它接收一个提示词（userPrompt），发送请求，并返回模型的文本回复。

4. 连接IDE：创建动作与界面交互

有了AI服务，下一步就是让它在IDEA里“动”起来。我们需要创建用户触发的“动作”（Action），并设计一个地方来显示AI的回复。

4.1 创建第一个动作：解释选中代码

我们创建一个动作，当用户在编辑器中选中一段代码并点击右键菜单时，可以触发AI解释。

package com.yourname.actions;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.Messages;
import com.yourname.ai.AIClientService;
import org.jetbrains.annotations.NotNull;

public class ExplainCodeAction extends AnAction {

    @Override
    public void update(@NotNull AnActionEvent e) {
        // 仅在编辑器中有文本被选中时，该动作才可用
        final Editor editor = e.getData(CommonDataKeys.EDITOR);
        boolean hasSelection = editor != null && editor.getSelectionModel().hasSelection();
        e.getPresentation().setEnabledAndVisible(hasSelection);
    }

    @Override
    public void actionPerformed(@NotNull AnActionEvent e) {
        final Editor editor = e.getRequiredData(CommonDataKeys.EDITOR);
        final Project project = e.getProject();
        String selectedText = editor.getSelectionModel().getSelectedText();

        if (selectedText == null || selectedText.trim().isEmpty()) {
            Messages.showInfoMessage(project, "请先选择一段代码。", "提示");
            return;
        }

        // 在后台线程执行网络请求，避免阻塞UI
        new Thread(() -> {
            try {
                String prompt = "请解释以下Java代码的功能和工作原理：\n```java\n" + selectedText + "\n```";
                String explanation = new AIClientService().getChatCompletion(prompt);

                // 回到UI线程显示结果
                com.intellij.openapi.application.ApplicationManager.getApplication().invokeLater(() ->
                        Messages.showMessageDialog(project, explanation, "代码解释", Messages.getInformationIcon())
                );
            } catch (Exception ex) {
                com.intellij.openapi.application.ApplicationManager.getApplication().invokeLater(() ->
                        Messages.showErrorDialog(project, "获取解释失败: " + ex.getMessage(), "错误")
                );
            }
        }).start();
    }
}

创建了动作类之后，我们需要在 plugin.xml 的 <actions> 部分注册它，并绑定到编辑器的右键菜单。

<actions>
    <action id="MyAICodeAssistant.ExplainCode" class="com.yourname.actions.ExplainCodeAction"
            text="AI解释代码" description="使用AI解释选中的代码">
        <add-to-group group-id="EditorPopupMenu" anchor="first"/>
        <keyboard-shortcut keymap="$default" first-keystroke="ctrl alt E"/>
    </action>
</actions>

这样，在代码编辑器中右键，菜单顶部就会出现“AI解释代码”的选项，并且我们为其设置了快捷键 Ctrl+Alt+E。

4.2 创建工具窗口显示结果

用对话框显示结果一次性的，体验不好。我们可以创建一个工具窗口（ToolWindow），像IDEA的“运行”、“终端”窗口一样，持续显示交互历史和结果。

这涉及到创建 ToolWindowFactory、一个自定义的Swing组件（比如 JTextPane）来显示内容，以及更复杂的事件监听。核心步骤是：

  1. 实现 ToolWindowFactory 接口，在 createToolWindowContent 方法中创建你的界面组件。
  2. 在 plugin.xml 中注册这个工厂。
  3. 在你的动作 actionPerformed 中，获取或激活这个工具窗口，并将AI返回的内容追加到显示组件中。

由于篇幅所限，这里不展开详细代码，但思路是提供一个可滚动、可保留历史记录的侧边栏，让与AI的对话更像一个持续的会话。

5. 实现核心功能与优化

基于上面的框架，我们可以轻松扩展其他功能。

5.1 生成方法注释

创建一个新的动作 GenerateJavaDocAction。其核心是构建一个特定的提示词（Prompt），将当前方法的方法签名、参数名、返回值，以及可能的方法体（可选）发送给AI，要求它生成符合Javadoc规范的注释。

String prompt = String.format("""
        请为以下Java方法生成一个简洁专业的Javadoc注释。
        要求：包含对方法功能的描述、对每个参数（@param）的说明、对返回值（@return）的说明，如果方法可能抛出异常也请说明（@throws）。
        只需输出注释部分，不要输出方法代码本身。
        
        方法签名：
        %s
        """, methodSignature);

然后，在收到AI回复后，使用IDEA的 PSI (Program Structure Interface) API 定位到当前方法在AST（抽象语法树）中的位置，并将生成的注释文本插入到方法声明之前。这需要用到 PsiElement 和 PsiDocumentManager 等API。

5.2 提供重构建议

重构建议功能更开放。我们可以将当前选中的代码块、或当前整个类文件作为上下文发送给AI，并提出开放式问题，例如：“请分析以下Java代码，指出其中可以改进的设计、潜在的坏味道，并提供具体的重构建议。”

结果显示在工具窗口中，可以是一条条清晰的建议列表。更高级的玩法是，结合IDEA的“意图动作”（Intention Action）API，尝试将某些简单的重构建议（如“重命名这个变量”）直接转化为可一键执行的IDE操作。

5.3 优化与注意事项

  • 性能与异步：所有网络调用必须放在后台线程，绝不能阻塞UI线程（EDT）。使用 ApplicationManager.getApplication().executeOnPooledThread 或 Task.Backgroundable 是更好的选择。
  • 错误处理：网络可能不稳定，API可能有频率限制。需要完善的错误处理和用户友好的提示。
  • 提示词工程：功能好坏很大程度上取决于你发给AI的提示词。需要精心设计，提供清晰的指令和上下文。可以为不同功能（解释、生成、重构）预定义不同的提示词模板。
  • 配置化：API密钥、模型端点、超时时间等都应该做成插件设置（Configurable），允许用户自行配置。
  • 上下文限制：大模型有输入长度限制。需要合理截取代码上下文，比如只发送当前方法及其直接相关的类成员，而不是整个庞大的Java文件。

6. 总结

开发这样一个插件，就像是在熟悉的IDE环境中开辟了一块新的实验田。它不仅仅是一个工具，更是一种新的、交互式的编程范式的初探。你将IDEA强大的代码分析能力（PSI）与大型语言模型的语义理解和生成能力相结合，创造出的助手能真正“理解”你的代码意图。

整个过程涉及了插件开发的基本流程（项目创建、配置、打包）、IDE底层API的使用（动作系统、PSI、工具窗口），以及外部服务的集成。虽然我们实现的只是一个雏形，但它已经清晰地展示了这条路径的可行性。

实际用下来，你会发现它对于阅读复杂遗留代码、快速生成文档草稿、获取重构灵感特别有帮助。当然，它给出的建议并非总是正确或最优，需要你作为经验丰富的开发者进行判断和筛选。这正体现了“人机协同”的价值——AI提供思路和草稿，人类负责决策和精修。

如果你对这个小项目感兴趣，不妨动手试试。可以从最简单的“解释代码”功能开始，逐步添加更多你想要的特性。也许在不久的将来，这种深度集成AI的编码环境，会成为每个开发者的标配。

获取更多AI镜像

想探索更多AI镜像和应用场景？访问 CSDN星图镜像广场，提供丰富的预置镜像，覆盖大模型推理、图像生成、视频生成、模型微调等多个领域，支持一键部署。

Logo
DeepSeek技术社区

欢迎加入DeepSeek 技术社区。在这里，你可以找到志同道合的朋友，共同探索AI技术的奥秘。

更多推荐

cover

AI动态简报之算力基建篇

avatar DeepSeek技术社区
cover

端侧小模型 vs 云端大模型双轨部署：规则分流还是训练路由器的工程选择

avatar DeepSeek技术社区
cover

Agent 工具权限爆炸？最小权限原则与 DeepSeek 多租户隔离实践

avatar DeepSeek技术社区