春联生成模型IDEA插件开发：在IDE内直接生成代码注释春联

春联生成模型IDEA插件开发在IDE内直接生成代码注释春联每次写代码注释是不是都觉得有点枯燥尤其是到了年底看着满屏的技术文档总感觉少了点年味儿。要是能在IDE里给辛苦了一年的代码也贴上几句应景的祝福那该多有意思。今天我们就来聊聊怎么给IntelliJ IDEA做个好玩又实用的小插件。它能读懂你正在写的Java类或方法然后调用AI模型生成一副与之相关的趣味春联或者祝福语直接插入到你的代码注释里。想象一下一个处理用户订单的OrderService类注释里突然多了一句“数据流转如春水业务稳定似泰山”是不是瞬间觉得代码也有了温度这不仅仅是给开发工作加点乐趣更是AI能力与开发者日常工具链深度结合的一个有趣尝试。下面我就带你一步步把这个想法变成现实。1. 插件能做什么先看看效果在动手之前我们得先想清楚这个插件到底要解决什么问题以及最终长什么样。核心目标很简单在IDEA里一键为代码生成有文化、有趣味的AI春联注释。具体来说它应该具备这几个能力智能识别上下文能自动获取当前光标所在的类名、方法名或选中的代码块。调用AI模型将这些代码信息作为提示词的一部分发送给春联生成模型API。灵活插入注释将模型返回的春联按照我们设定的格式比如JavaDoc风格插入到代码的合适位置。操作足够简单最好一个快捷键或者一次鼠标点击就能完成。我简单画了一个插件的使用流程图你可以先感受一下整个交互过程graph TD A[开发者在IDEA中编写Java代码] -- B{光标定位或选择代码}; B -- C[插件获取类名/方法名等上下文]; C -- D[插件构造提示词并调用AI API]; D -- E[AI模型生成相关春联]; E -- F[插件格式化春联为Java注释]; F -- G[将注释插入到代码对应位置]; G -- H[开发者获得带有趣味春联注释的代码];整个过程非常顺畅几乎不打断你的编码流。接下来我们就从零开始搭建这个插件的开发环境。2. 搭建你的IDEA插件开发环境开发IDEA插件听起来有点门槛但其实IntelliJ官方提供了非常友好的支持。我们不需要从空白项目开始折腾。第一步创建插件项目打开你的IntelliJ IDEA建议使用较新版本比如2022.3及以上。点击File-New-Project...。在左侧菜单中选择IntelliJ Platform Plugin。右侧的Project SDK需要你提前准备好。点击New...-Download JDK...选择一个JDK 17或11的版本下载并配置好。给项目起个名字比如CoupletCommentPlugin选好项目位置点击Create。这样一个最基础的插件项目骨架就创建好了。项目里会自动生成一个src/main/resources/META-INF/plugin.xml文件这是插件的“身份证”所有配置信息都在这里。第二步认识核心配置文件打开plugin.xml你会看到一些预设的标签。我们需要重点关注和修改其中几个idea-plugin !-- 插件的唯一ID通常用倒置域名格式 -- idcom.yourname.couplet.comment/id !-- 插件在市场上显示的名字 -- nameAI Couplet Comment/name !-- 版本号 -- version1.0/version !-- 供应商信息 -- vendor emailyour-emailexample.com urlhttps://your-website.comYour Name/vendor !-- 描述会显示在插件详情页 -- description![CDATA[ 一个有趣的IDEA插件利用AI为你的Java代码生成春节对联风格的注释。br em让编程充满年味/em ]]/description !-- 依赖项声明插件依赖的IDEA模块或其他插件 -- dependscom.intellij.modules.platform/depends dependscom.intellij.modules.java/depends !-- 因为我们主要处理Java代码 -- !-- 扩展点定义我们的Action动作会在这里声明 -- extensions defaultExtensionNscom.intellij !-- 后续添加UI或服务扩展点 -- /extensions actions !-- 我们的核心功能“动作”将在这里配置 -- /actions /idea-plugin这个文件就像插件的大脑告诉IDEA“我是谁”、“我能干什么”。接下来我们就要开始编写“我能干什么”的具体逻辑了。3. 编写插件核心逻辑感知代码与调用AI插件的核心功能可以拆解成两个部分一是与IDEA编辑器交互获取代码信息二是与外部AI服务通信获取春联内容。我们先来处理第一个部分。第一步创建Action动作在IDEA插件中用户的一个操作比如点击菜单、按下快捷键对应一个AnAction类。我们来创建一个。在src/main/java下创建包例如com.yourname.action。新建一个Java类命名为GenerateCoupletAction并继承AnAction。package com.yourname.action; 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.psi.PsiClass; import com.intellij.psi.PsiElement; import com.intellij.psi.PsiMethod; import com.intellij.psi.util.PsiTreeUtil; import org.jetbrains.annotations.NotNull; public class GenerateCoupletAction extends AnAction { Override public void actionPerformed(NotNull AnActionEvent e) { // 1. 获取当前项目和编辑器 Project project e.getProject(); Editor editor e.getData(CommonDataKeys.EDITOR); if (project null || editor null) { // 如果不在编辑上下文中不执行操作 return; } // 2. 获取当前光标处的PsiElementPSI是IDEA的代码语法树模型 PsiElement element e.getData(CommonDataKeys.PSI_ELEMENT); // 3. 尝试向上查找最近的类或方法 PsiClass targetClass null; PsiMethod targetMethod null; if (element ! null) { // 如果光标直接在一个类或方法上 if (element instanceof PsiClass) { targetClass (PsiClass) element; } else if (element instanceof PsiMethod) { targetMethod (PsiMethod) element; targetClass targetMethod.getContainingClass(); } else { // 如果光标在别处查找光标所在位置的父级类或方法 targetClass PsiTreeUtil.getParentOfType(element, PsiClass.class); targetMethod PsiTreeUtil.getParentOfType(element, PsiMethod.class); } } // 4. 准备上下文信息 String context 通用代码; if (targetClass ! null) { context 类: targetClass.getName(); if (targetMethod ! null) { context , 方法: targetMethod.getName(); } } else if (targetMethod ! null) { context 方法: targetMethod.getName(); } // 5. 调用AI服务生成春联下一步实现 String couplet callAICoupletAPI(context); // 6. 将生成的春联插入为注释再下一步实现 if (couplet ! null !couplet.isEmpty()) { insertComment(editor, targetClass, targetMethod, couplet); } } // 这个方法我们稍后实现 private String callAICoupletAPI(String context) { // 预留调用AI API return 上联数据流转如春水\n下联业务稳定似泰山\n横批代码永固; } // 这个方法我们也稍后实现 private void insertComment(Editor editor, PsiClass targetClass, PsiMethod targetMethod, String couplet) { // 预留插入注释逻辑 } }这段代码做了几件事获取当前编辑的代码元素判断是类还是方法然后组合成一段上下文描述比如“类: OrderService, 方法: createOrder”。有了这个上下文我们就能请求AI生成相关的春联了。第二步将Action注册到插件光有类还不够我们需要在plugin.xml中注册这个动作并给它分配一个菜单项或快捷键。在plugin.xml的actions标签内添加actions action idGenerateCoupletAction classcom.yourname.action.GenerateCoupletAction text生成AI春联注释 description为当前代码生成AI春联风格注释 !-- 添加到编辑器右键菜单 -- add-to-group group-idEditorPopupMenu anchorlast/ !-- 可以添加快捷键比如 AltC -- !-- keyboard-shortcut keymap$default first-keystrokealt C/ -- /action /actions现在运行插件点击Gradle任务的runIde你会在代码编辑器的右键菜单里看到“生成AI春联注释”的选项了。当然点击它现在只会生成固定的春联因为我们还没连接真正的AI。4. 集成春联生成模型API现在来到最有意思的部分让插件“开口说话”。我们需要选择一个能生成文本的AI模型API。这里以调用一个假设的、支持中文对联生成的开放API为例。在实际开发中你可以替换成任何你喜欢的模型服务比如各大厂商提供的语言模型API。第一步构建API请求我们继续完善GenerateCoupletAction类中的callAICoupletAPI方法。这里需要注意网络请求不能在UI线程中进行否则会卡住IDEA界面我们必须使用异步调用。import com.intellij.openapi.application.ApplicationManager; import com.intellij.openapi.progress.ProgressIndicator; import com.intellij.openapi.progress.ProgressManager; import com.intellij.openapi.progress.Task; import okhttp3.*; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import java.io.IOException; import java.util.concurrent.CompletableFuture; import java.util.concurrent.TimeUnit; public class GenerateCoupletAction extends AnAction { // ... 之前的代码 ... private String callAICoupletAPI(String context) { // 这里使用一个CompletableFuture来模拟异步获取结果实际在actionPerformed中需要处理异步 // 为了简化示例我们先展示同步逻辑实际强烈建议用异步任务如ProgressManager OkHttpClient client new OkHttpClient.Builder() .connectTimeout(10, TimeUnit.SECONDS) .writeTimeout(10, TimeUnit.SECONDS) .readTimeout(30, TimeUnit.SECONDS) .build(); // 构建提示词让AI根据代码上下文创作春联 String prompt String.format(请根据以下编程相关的上下文创作一副有趣、贴切的春节对联。上下文%s。对联要求上下联对仗工整横批点睛风格可以幽默或励志与编程、数据、系统等相关。, context); // 构建请求体这里格式需要根据你实际使用的API调整 String json String.format({\model\: \text-davinci-003\, \prompt\: \%s\, \max_tokens\: 100}, prompt); RequestBody body RequestBody.create(json, MediaType.parse(application/json; charsetutf-8)); // 假设的API端点请替换为真实的URL和认证信息 Request request new Request.Builder() .url(https://api.example.com/v1/completions) .post(body) .addHeader(Authorization, Bearer YOUR_API_KEY_HERE) // 你的API Key .addHeader(Content-Type, application/json) .build(); try { Response response client.newCall(request).execute(); if (response.isSuccessful() response.body() ! null) { String responseBody response.body().string(); // 这里需要解析返回的JSON提取出生成的文本 // 假设返回格式为 {choices:[{text:上联...\n下联...\n横批...}]} // 使用简单的字符串处理或JSON库如Gson来解析 return parseCoupletFromResponse(responseBody); } } catch (IOException e) { e.printStackTrace(); } return null; // 或返回一个默认的春联 } private String parseCoupletFromResponse(String json) { // 简化的解析逻辑实际请使用JSON解析库 if (json.contains(\text\:\)) { int start json.indexOf(\text\:\) 8; int end json.indexOf(\, start); if (end start) { return json.substring(start, end).replace(\\n, \n); } } return 上联代码无bug\n下联系统永平安\n横批开发者福音; } // ... 后续的 insertComment 方法 ... }重要提示上面的代码为了清晰展示了逻辑但在实际插件中你应该将API Key等敏感信息存储在插件的配置中而不是硬编码在代码里。同时网络请求务必放在后台线程执行可以使用ProgressManager.getInstance().run(new Task.Backgroundable(...))来包装避免阻塞UI。5. 将生成的春联插入为代码注释拿到AI生成的春联后最后一步就是把它漂亮地放到代码里。我们需要根据光标位置决定是把春联放在类注释还是方法注释上并格式化成标准的JavaDoc。我们来完善insertComment方法import com.intellij.openapi.command.WriteCommandAction; import com.intellij.openapi.editor.Document; import com.intellij.psi.PsiFile; import com.intellij.psi.codeStyle.CodeStyleManager; private void insertComment(Editor editor, PsiClass targetClass, PsiMethod targetMethod, String couplet) { // 在WriteCommandAction中执行这是一个可以撤销的文档修改操作 WriteCommandAction.runWriteCommandAction(editor.getProject(), () - { Document document editor.getDocument(); PsiFile psiFile targetClass ! null ? targetClass.getContainingFile() : (targetMethod ! null ? targetMethod.getContainingFile() : null); if (psiFile null) return; int insertOffset; String commentText; // 格式化春联为JavaDoc注释 String formattedCouplet /**\n * couplet.replace(\n, \n * ) \n */; if (targetMethod ! null) { // 插入到方法前 insertOffset targetMethod.getTextRange().getStartOffset(); commentText formattedCouplet \n; } else if (targetClass ! null) { // 插入到类定义前 insertOffset targetClass.getTextRange().getStartOffset(); commentText formattedCouplet \n; } else { // 如果没有特定目标插入到当前光标行 insertOffset editor.getCaretModel().getOffset(); commentText // couplet.replace(\n, \n// ) \n; } // 在文档中插入注释文本 document.insertString(insertOffset, commentText); // 重新格式化插入后的代码保持美观 CodeStyleManager.getInstance(editor.getProject()).reformatText( psiFile, insertOffset, insertOffset commentText.length() ); }); }这段代码做了几件事判断插入目标方法优先于类。将多行春联格式化为多行JavaDoc注释 (/** ... */) 或单行注释 (//)。在目标代码的起始位置插入注释。调用IDEA的代码格式化工具让新插入的注释与周围代码风格保持一致。至此一个具备完整功能的插件核心就完成了。从识别代码到调用AI再到插入注释形成了一个闭环。6. 更进一步让插件更好用基础功能跑通后我们可以考虑一些增强体验的细节添加配置界面让用户能自行配置API端点、API Key、生成风格幽默/文艺/励志等。这可以通过实现Configurable接口来完成。优化提示词工程根据不同的代码元素类型如Controller、Service、Dao、工具类设计更精准的提示词模板让生成的春联更贴切。错误处理与用户反馈网络请求可能失败API可能返回非预期内容。添加Toast通知或状态栏提示告诉用户操作成功或失败的原因。缓存机制对于相同的代码上下文可以缓存AI返回的结果避免频繁调用API节省成本和等待时间。7. 总结跟着上面的步骤走一遍你应该已经拥有了一个能在自己IDEA里运行起来的“春联注释生成器”。这个项目虽然小但它串联起了几个非常实用的知识点IDEA插件开发的基本流程、PSI API对代码结构的读取、与外部HTTP服务的集成、以及如何在编辑器中动态修改文档。开发这类工具型插件最大的成就感莫过于看到它真的能融入自己的工作流解决一个具体而微的痛点。给代码加春联注释也许不会提升性能但它用一种轻松的方式展示了AI如何润物细无声地增强我们的开发体验。你可以基于这个雏形发挥更多创意。比如生成更有趣的变量名建议、为复杂算法写一首打油诗注释、或者根据代码变更自动生成更有温度的提交信息。IDE不再只是一个冰冷的编辑器它可以成为更有趣的编程伙伴。获取更多AI镜像想探索更多AI镜像和应用场景访问 CSDN星图镜像广场提供丰富的预置镜像覆盖大模型推理、图像生成、视频生成、模型微调等多个领域支持一键部署。