Spring AI + IDEA 插件：定制化 Java 代码助手实战

2.1 后端核心：Spring AI + 工具调用体系

2.1.1 Spring AI 核心配置

先把模型客户端接起来，后面的 Prompt、工具调用、结果校验才有落点。

/**
 * Spring AI 核心配置类
 */
@Configuration
public class SpringAiConfig {
    /**
     * 配置 OpenAI 客户端
     */
    @Bean
    public OpenAiChatClient openAiChatClient() {
        // 从配置文件读取 API Key 和 Base URL
        String apiKey = System.getenv("OPENAI_API_KEY");
        String baseUrl = "https://api.openai.com/v1";
        OpenAiApi openAiApi = new OpenAiApi(baseUrl, apiKey);
        // 创建客户端并配置默认参数
        OpenAiChatClient client = new OpenAiChatClient(openAiApi);
        client.setTemperature(0.2); // 低温度保证代码稳定性
        client.setModel("gpt-4");
        return client;
    }
}

2.1.2 工具调用层：JavaParser + Maven API

真正让它和'普通聊天机器人'拉开差距的，是这层上下文解析。光靠模型猜，生成结果很容易飘；把 pom、包结构、源码目录这些信息喂进去，代码才更像是给当前项目现写的。

/**
 * 项目上下文解析服务：基于 Maven API+JavaParser 解析项目信息
 */
@Service
public class ProjectContextParser {
    /**
     * 解析 Maven 项目的包结构、依赖信息
     * @param pomPath pom.xml 文件路径（从 IDEA 插件传递）
     */
    public ProjectContext parseMavenProject(String pomPath) throws Exception {
        ProjectContext context = new ProjectContext();
        // 1. 解析 pom.xml 获取基础信息
        File pomFile = new File(pomPath);
        MavenXpp3Reader reader = new MavenXpp3Reader();
        Model model = reader.read(new FileReader(pomFile));
        // 设置 groupId、artifactId、版本
        context.setGroupId(model.getGroupId());
        context.setArtifactId(model.getArtifactId());
        context.setBasePackage(model.getGroupId() + "." + model.getArtifactId());
        // 2. 解析依赖信息
        List<String> dependencies = new ArrayList<>();
        for (Dependency dep : model.getDependencies()) {
            dependencies.add(dep.getGroupId() + ":" + dep.getArtifactId() + ":" + dep.getVersion());
        }
        context.setDependencies(dependencies);
        // 3. 解析项目源码目录（简化版）
        File srcDir = new File(pomFile.getParentFile(), "src/main/java");
        if (srcDir.exists()) {
            context.setSrcRootPath(srcDir.getAbsolutePath());
            // 解析已存在的包结构
            List<String> packages = parsePackages(srcDir);
            context.setPackages(packages);
        }
        return context;
    }

    /**
     * 解析源码目录下的所有包
     */
    private List<String> parsePackages(File srcDir) {
        List<String> packages = new ArrayList<>();
        // 递归遍历源码目录，解析包名（简化版）
        File[] files = srcDir.listFiles();
        if (files == null) return packages;
        for (File file : files) {
            if (file.isDirectory()) {
                String packageName = file.getAbsolutePath().replace(srcDir.getAbsolutePath(), "")
                        .replace(File.separator, ".");
                if (!packageName.isEmpty()) {
                    packages.add(packageName.substring(1)); // 去掉开头的.
                }
                packages.addAll(parsePackages(file));
            }
        }
        return packages;
    }

    /**
     * 解析 Java 代码 AST，校验语法正确性
     */
    public boolean validateJavaCode(String code) {
        try {
            // 使用 JavaParser 解析代码，检测语法错误
            CompilationUnit cu = StaticJavaParser.parse(code);
            List<Problem> problems = cu.getProblems();
            return problems.isEmpty();
        } catch (Exception e) {
            return false;
        }
    }
}

// 项目上下文实体类
@Data
public class ProjectContext {
    private String groupId; // 项目 groupId
    private String artifactId; // 项目 artifactId
    private String basePackage; // 基础包名
    private List<String> dependencies; // 依赖列表
    private List<String> packages; // 包结构
    private String srcRootPath; // 源码根路径
    private String projectId; // IDEA 插件传递的项目唯一标识
}

2.2 前端核心：IDEA 插件开发基础

2.2.1 IDEA 插件工程搭建

插件侧没有做太多花活，先把入口、窗口和快捷键跑通。IDEA 插件开发最容易浪费时间的地方，不是业务逻辑，而是各种生命周期、上下文和 UI 线程问题。

<idea-plugin>
    <id>com.ai.code.assistant</id>
    <name>AI Code Assistant</name>
    <version>1.0</version>
    <vendor email="[email protected]" url="https://your.site">Your Name</vendor>
    <description>
        基于 Spring AI 的 Java 代码助手，支持上下文感知的代码生成与优化
    </description>
    <!-- 注册 Action，用于打开对话窗口 -->
    <actions>
        <action text="AI Code Assistant" description="Open AI Code Assistant Dialog">
            <add-to-group group-id="EditorPopupMenu" anchor="first"/>
            <keyboard-shortcut keymap="$default" first-keystroke="ctrl alt A"/>
        </action>
    </actions>
    <extensions defaultExtensionNs="com.intellij">
        <!-- 注册自定义窗口 -->
        <toolWindow anchor="right" factoryClass="com.ai.code.assistant.window.AiToolWindowFactory"/>
    </extensions>
</idea-plugin>

2.2.2 对话窗口开发（Swing）

窗口本身不复杂，重点是：别阻塞编辑器，别让插入代码时把当前光标位置和选区搞乱。

/**
 * AI 代码助手对话窗口
 */
public class AiCodeDialog extends JDialog {
    private JTextArea inputArea; // 需求输入框
    private JTextPane resultArea; // 代码结果展示框
    private JButton generateBtn; // 生成按钮
    private JButton insertBtn; // 插入代码按钮
    private Project currentProject; // 当前 IDEA 项目

    public AiCodeDialog(Project project) {
        super(WindowManager.getInstance().getFrame(project), "AI Code Assistant", Dialog.ModalityType.MODELESS);
        this.currentProject = project;
        initUI(); // 初始化 UI
        setSize(800, 600);
        setLocationRelativeTo(null);
    }

    /**
     * 初始化 UI 组件
     */
    private void initUI() {
        // 1. 输入区域
        inputArea = new JTextArea(5, 50);
        inputArea.setPlaceholder("请输入代码生成需求，例如：生成用户管理的 Controller+Service+Mapper");
        JScrollPane inputScroll = new JScrollPane(inputArea);
        // 2. 结果展示区域（支持语法高亮）
        resultArea = new JTextPane();
        resultArea.setContentType("text/java");
        JScrollPane resultScroll = new JScrollPane(resultArea);
        // 3. 按钮区域
        generateBtn = new JButton("生成代码");
        insertBtn = new JButton("插入到编辑器");
        insertBtn.setEnabled(false); // 初始禁用
        // 4. 布局
        JPanel panel = new JPanel(new BorderLayout());
        JPanel topPanel = new JPanel(new BorderLayout());
        topPanel.add(new JLabel("需求描述："), BorderLayout.NORTH);
        topPanel.add(inputScroll, BorderLayout.CENTER);
        JPanel btnPanel = new JPanel();
        btnPanel.add(generateBtn);
        btnPanel.add(insertBtn);
        panel.add(topPanel, BorderLayout.NORTH);
        panel.add(resultScroll, BorderLayout.CENTER);
        panel.add(btnPanel, BorderLayout.SOUTH);
        // 5. 绑定事件
        generateBtn.addActionListener(e -> generateCode());
        insertBtn.addActionListener(e -> insertCodeToEditor());
        add(panel);
    }

    /**
     * 生成代码：调用后端接口
     */
    private void generateCode() {
        // 1. 采集项目上下文
        ProjectContext context = collectProjectContext();
        // 2. 构建请求参数
        CodeGenerateRequest request = new CodeGenerateRequest();
        request.setRequirement(inputArea.getText());
        request.setProjectContext(context);
        // 3. 调用后端接口（OkHttp 实现，略）
        OkHttpClient client = new OkHttpClient();
        // ... 发送 POST 请求，获取生成的代码
        // 4. 展示结果
        resultArea.setText(generatedCode);
        insertBtn.setEnabled(true);
    }

    /**
     * 采集当前 IDEA 项目的上下文
     */
    private ProjectContext collectProjectContext() {
        ProjectContext context = new ProjectContext();
        // 1. 获取项目根路径
        String projectPath = currentProject.getBasePath();
        // 2. 获取 pom.xml 路径（Maven 项目）
        VirtualFile pomFile = currentProject.getBaseDir().findChild("pom.xml");
        if (pomFile != null) {
            context.setPomPath(pomFile.getPath());
        }
        // 3. 获取当前编辑器的包路径
        Editor editor = FileEditorManager.getInstance(currentProject).getSelectedTextEditor();
        if (editor != null) {
            PsiFile psiFile = PsiDocumentManager.getInstance(currentProject).getPsiFile(editor.getDocument());
            if (psiFile instanceof PsiJavaFile) {
                PsiJavaFile javaFile = (PsiJavaFile) psiFile;
                context.setCurrentPackage(javaFile.getPackageName());
            }
        }
        context.setProjectId(currentProject.getName());
        return context;
    }

    /**
     * 将生成的代码插入到当前编辑器
     */
    private void insertCodeToEditor() {
        Editor editor = FileEditorManager.getInstance(currentProject).getSelectedTextEditor();
        if (editor == null) return;
        // 获取选中区域，无选中则插入到光标位置
        Document document = editor.getDocument();
        SelectionModel selectionModel = editor.getSelectionModel();
        int start = selectionModel.getSelectionStart();
        int end = selectionModel.getSelectionEnd();
        // 写入代码
        WriteCommandAction.runWriteCommandAction(currentProject, () -> {
            document.replaceString(start, end, resultArea.getText());
        });
        // 取消选中，光标移到末尾
        selectionModel.removeSelection();
        editor.getCaretModel().moveToOffset(start + resultArea.getText().length());
    }
}

三、核心功能实现

3.1 代码生成：Controller+Service+Mapper 完整生成

3.1.1 Prompt 工程核心逻辑

Prompt 不只是'把需求塞给模型'这么简单。要让它知道项目基础包、已有包、依赖版本，还要把'只返回代码'这类约束写得足够硬，不然后面处理结果会很烦。

/**
 * Prompt 工程服务：动态拼接上下文，生成高质量 Prompt
 */
@Service
public class PromptEngineeringService {
    /**
     * 生成代码生成的 Prompt
     * @param requirement 用户需求
     * @param context 项目上下文
     */
    public Prompt buildGeneratePrompt(String requirement, ProjectContext context) {
        // 1. 构建系统提示词（核心规则）
        String systemPrompt = "你是一位资深 Java 后端开发工程师，精通 Spring Boot、MyBatis、MySQL。\n" +
                "请根据以下需求和项目上下文，生成符合规范的 Java 代码：\n" +
                "1. 包结构必须符合项目基础包：%s\n" +
                "2. 代码必须兼容项目依赖版本，优先使用项目已引入的依赖\n" +
                "3. 生成完整的 Controller+Service+Mapper 层，包含必要的注释、异常处理\n" +
                "4. 代码风格符合阿里巴巴 Java 开发手册\n" +
                "5. 只返回代码，不返回多余解释\n" +
                "项目上下文：\n" +
                " - 基础包名：%s\n" +
                " - 已存在的包：%s\n" +
                " - 项目依赖：%s";
        String formattedSystemPrompt = String.format(systemPrompt,
                context.getBasePackage(),
                context.getBasePackage(),
                String.join(",", context.getPackages()),
                String.join(",", context.getDependencies()));
        // 2. 构建用户提示词
        String userPrompt = "需求：" + requirement;
        // 3. 创建 Prompt 对象
        return new Prompt(List.of(
                new SystemMessage(formattedSystemPrompt),
                new UserMessage(userPrompt)
        ));
    }
}

3.1.2 代码生成核心接口

/**
 * 代码生成核心接口
 */
@RestController
@RequestMapping("/api/code")
public class CodeGenerateController {
    @Autowired
    private OpenAiChatClient openAiChatClient;
    @Autowired
    private PromptEngineeringService promptService;
    @Autowired
    private ProjectContextParser contextParser;
    @Autowired
    private ProjectContextRepository contextRepository;

    /**
     * 生成代码接口
     */
    @PostMapping("/generate")
    public Result<String> generateCode(@RequestBody CodeGenerateRequest request) {
        try {
            // 1. 解析项目上下文（如果未存储）
            ProjectContext context;
            if (request.getProjectContext().getProjectId() != null) {
                context = contextRepository.findByProjectId(request.getProjectContext().getProjectId());
                if (context == null) {
                    // 解析 pom.xml 生成上下文
                    context = contextParser.parseMavenProject(request.getProjectContext().getPomPath());
                    context.setProjectId(request.getProjectContext().getProjectId());
                    contextRepository.save(context); // 存储上下文
                }
            } else {
                context = request.getProjectContext();
            }
            // 2. 构建 Prompt
            Prompt prompt = promptService.buildGeneratePrompt(request.getRequirement(), context);
            // 3. 调用 Spring AI 生成代码
            AiResponse response = openAiChatClient.generate(prompt);
            String generatedCode = response.getGeneration().getText();
            // 4. 校验代码语法
            boolean isValid = contextParser.validateJavaCode(generatedCode);
            if (!isValid) {
                // 重新生成（简化版，实际可加入重试逻辑）
                generatedCode = regenerateCode(prompt);
            }
            return Result.success(generatedCode);
        } catch (Exception e) {
            log.error("生成代码失败", e);
            return Result.error("生成代码失败：" + e.getMessage());
        }
    }

    /**
     * 代码校验失败时重新生成
     */
    private String regenerateCode(Prompt prompt) {
        // 追加提示词，要求修复语法错误
        Prompt newPrompt = new Prompt(
                prompt.getMessages().stream()
                        .collect(Collectors.toList())
                        .add(new UserMessage("以上代码存在语法错误，请修复后重新生成，只返回修复后的代码"))
        );
        return openAiChatClient.generate(newPrompt).getGeneration().getText();
    }
}

3.1.3 效果示例

用户输入需求：生成用户管理的 Controller+Service+Mapper，包含查询、新增、修改、删除接口。

生成的代码（Controller 层）：

package com.example.demo.controller;
import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;

/**
 * 用户管理控制器
 * @author AI Code Assistant
 * @date 2024-05-20
 */
@RestController
@RequestMapping("/api/user")
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 查询所有用户
     */
    @GetMapping
    public List<User> listAll() {
        return userService.listAll();
    }

    /**
     * 根据 ID 查询用户
     */
    @GetMapping("/{id}")
    public User getById(@PathVariable Long id) {
        return userService.getById(id);
    }

    /**
     * 新增用户
     */
    @PostMapping
    public boolean save(@RequestBody User user) {
        return userService.save(user);
    }

    /**
     * 修改用户
     */
    @PutMapping("/{id}")
    public boolean update(@PathVariable Long id, @RequestBody User user) {
        user.setId(id);
        return userService.update(user);
    }

    /**
     * 删除用户
     */
    @DeleteMapping("/{id}")
    public boolean delete(@PathVariable Long id) {
        return userService.delete(id);
    }
}

3.2 代码优化：自动修复语法错误与性能问题

3.2.1 代码优化 Prompt 设计

优化这块的重点不是'写得更漂亮'，而是先把最常见的问题解决掉：能编译、逻辑不变、性能有实质改善。

/**
 * 构建代码优化的 Prompt
 */
public Prompt buildOptimizePrompt(String code, String optimizeType) {
    String systemPrompt = "你是一位资深 Java 性能优化工程师，精通 Java 语法、性能调优。\n" +
            "请根据指定类型优化以下代码：\n" +
            "优化类型：%s\n" +
            "优化规则：\n" +
            "1. 修复语法错误，保证代码可编译\n" +
            "2. 性能优化需给出具体的优化点（如循环优化、SQL 优化、集合使用优化）\n" +
            "3. 保留原有业务逻辑，只优化语法和性能\n" +
            "4. 输出优化后的代码 + 优化说明（分开展示）";
    String formattedSystemPrompt = String.format(systemPrompt, optimizeType);
    return new Prompt(List.of(
            new SystemMessage(formattedSystemPrompt),
            new UserMessage("需要优化的代码：\n" + code)
    ));
}

3.2.2 代码优化接口实现

/**
 * 代码优化接口
 */
@PostMapping("/optimize")
public Result<CodeOptimizeResponse> optimizeCode(@RequestBody CodeOptimizeRequest request) {
    try {
        // 1. 构建优化 Prompt
        Prompt prompt = promptService.buildOptimizePrompt(request.getCode(), request.getOptimizeType());
        // 2. 调用 AI 优化代码
        AiResponse response = openAiChatClient.generate(prompt);
        String result = response.getGeneration().getText();
        // 3. 解析优化结果（代码 + 说明）
        CodeOptimizeResponse responseVO = parseOptimizeResult(result);
        return Result.success(responseVO);
    } catch (Exception e) {
        log.error("优化代码失败", e);
        return Result.error("优化代码失败：" + e.getMessage());
    }
}

/**
 * 解析优化结果（简化版，实际可按固定格式解析）
 */
private CodeOptimizeResponse parseOptimizeResult(String result) {
    CodeOptimizeResponse response = new CodeOptimizeResponse();
    // 假设结果以"===优化后代码==="和"===优化说明==="分隔
    String[] parts = result.split("===优化说明===");
    if (parts.length >= 1) {
        response.setOptimizedCode(parts[0].replace("===优化后代码===" , "").trim());
    }
    if (parts.length >= 2) {
        response.setOptimizeDesc(parts[1].trim());
    }
    return response;
}

3.2.3 优化效果示例

原始代码的毛病很典型：把数据库查询放在循环里，数据一多，IO 次数就直接上去了。

// 循环查询数据库，性能差
public List<User> listUsers(List<Long> ids) {
    List<User> users = new ArrayList<>();
    for (Long id : ids) {
        User user = userMapper.getById(id); // 每次循环查库
        users.add(user);
    }
    return users;
}

优化后代码：

// 批量查询数据库，减少 IO 次数
public List<User> listUsers(List<Long> ids) {
    // 优化点：批量查询替代循环查询，减少数据库连接次数
    if (CollectionUtils.isEmpty(ids)) {
        return Collections.emptyList();
    }
    return userMapper.listByIds(ids); // 批量查询
}

优化说明：

1. 性能问题：循环遍历 ID 列表，每次查询数据库，导致多次 IO 操作，性能低下；
2. 优化方案：使用 MyBatis 的批量查询方法 listByIds，一次 SQL 查询获取所有数据；
3. 额外优化：增加空值判断，避免空指针异常。

3.3 知识注入：项目上下文感知的代码补全

3.3.1 上下文感知核心逻辑

补全场景比生成完整代码更挑上下文。当前包名、已导入类、光标前的片段，缺一个都容易跑偏。所以这里的策略是尽量把编辑器里能拿到的信息都收进来，再让模型去补。

/**
 * 代码补全服务：上下文感知的补全建议
 */
@Service
public class CodeCompletionService {
    /**
     * 生成上下文感知的代码补全建议
     */
    public List<String> completeCode(CodeCompletionRequest request) {
        // 1. 构建补全 Prompt
        String systemPrompt = "请根据当前 Java 文件的上下文，生成代码补全建议：\n" +
                "1. 补全建议必须符合当前包结构：%s\n" +
                "2. 优先使用已导入的类：%s\n" +
                "3. 补全建议简洁，每条不超过 50 个字符\n" +
                "4. 只返回补全建议列表，每行一个";
        String formattedSystemPrompt = String.format(systemPrompt,
                request.getCurrentPackage(),
                String.join(",", request.getImportedClasses()));
        String userPrompt = "需要补全的代码片段：\n" + request.getCodeSnippet();
        Prompt prompt = new Prompt(List.of(
                new SystemMessage(formattedSystemPrompt),
                new UserMessage(userPrompt)
        ));
        // 2. 调用 AI 生成补全建议
        AiResponse response = openAiChatClient.generate(prompt);
        String result = response.getGeneration().getText();
        // 3. 解析补全建议列表
        return Arrays.stream(result.split("\n"))
                .map(String::trim)
                .filter(s -> !s.isEmpty())
                .collect(Collectors.toList());
    }
}

3.3.2 IDEA 插件端补全联动

/**
 * 代码补全监听器：监听编辑器输入，实时调用补全接口
 */
public class CodeCompletionListener extends TypedActionHandlerBase {
    @Override
    public void execute(@NotNull Editor editor, char c, @NotNull DataContext dataContext) {
        // 1. 采集当前代码片段（光标前 100 个字符）
        CaretModel caretModel = editor.getCaretModel();
        int offset = caretModel.getOffset();
        Document document = editor.getDocument();
        String codeSnippet = document.getText(new TextRange(Math.max(0, offset - 100), offset));
        // 2. 采集上下文（当前包、已导入的类）
        Project project = CommonDataKeys.PROJECT.getData(dataContext);
        PsiFile psiFile = PsiDocumentManager.getInstance(project).getPsiFile(document);
        CodeCompletionRequest request = new CodeCompletionRequest();
        request.setCodeSnippet(codeSnippet);
        if (psiFile instanceof PsiJavaFile) {
            PsiJavaFile javaFile = (PsiJavaFile) psiFile;
            request.setCurrentPackage(javaFile.getPackageName());
            // 获取已导入的类
            List<String> importedClasses = javaFile.getImportList().getAllImports().stream()
                    .map(ImportStatement::getQualifiedName)
                    .collect(Collectors.toList());
            request.setImportedClasses(importedClasses);
        }
        // 3. 调用后端补全接口（异步，避免阻塞编辑器）
        CompletableFuture.runAsync(() -> {
            List<String> completions = callCompletionApi(request);
            // 4. 在编辑器中展示补全建议（使用 IDEA 的 CompletionContributor）
            showCompletionSuggestions(editor, completions);
        });
    }
}

四、实战部署：插件打包与私有仓库发布

4.1 IDEA 插件打包

Gradle 这部分没什么特别的，关键是版本别乱跳，IDEA SDK 和插件依赖一变，后面兼容问题会很烦。

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '1.17.3'
}
intellij {
    version = '2023.2'
    type = 'IC'
    plugins = ['java']
}
sourceCompatibility = 17
targetCompatibility = 17
// 打包配置
tasks.buildPlugin {
    archiveBaseName = 'ai-code-assistant'
    archiveVersion = '1.0.0'
    destinationDirectory = file("$projectDir/dist")
}

./gradlew buildPlugin

打完包后，会在 dist 目录里生成 ai-code-assistant-1.0.0.zip。

4.2 私有仓库发布

如果是团队内用，放到私有仓库比手工发包省事得多。Nexus 或 JetBrains Plugin Repository 都能用，流程差不多。

1. 搭建私有插件仓库；
2. 上传插件包；
3. 在 IDEA 里添加仓库地址：http://your-nexus-url/repository/idea-plugins/。

4.3 后端服务部署

mvn clean package -DskipTests

nohup java -jar ai-code-assistant-1.0.0.jar --spring.profiles.active=prod > app.log 2>&1 &

线上服务还是走常规套路：打包、部署、Nginx 反代，没什么新鲜的，但足够稳。

五、实战踩坑与优化方案

六、总结与进阶规划

这套东西做下来，最直接的感受是：生成能力本身不是难点，难的是让模型输出的东西真的能贴到项目里用。上下文采集、Prompt 约束、语法校验、插入编辑器这几步，哪一步松一点，最后都要靠人工兜底。

后面如果继续做，我会优先补这几块：私有化模型接入、本地知识库、按表结构批量生成模块代码，还有团队内共享 Prompt 的能力。多 IDE 适配也能做，但那是后面的事了，先把 IDEA 这条链路打稳更实际。