当前位置：首页 > news >正文

工具篇之开发IDEA插件的实战分享

news 2025/7/26 20:32:12

一、背景

随着业务复杂度提升，越来越多的开发场景需要定制化开发工具来辅助提升效率。尤其在微服务架构下，我们面临如下问题：

每次开发新模块都要手动生成 controller、service、mapper 等模板代码
团队内部的开发规范执行不一致，审核成本高
配置文件（如 application.yml）容易遗漏关键字段

为了提升开发一致性和效率，我们决定开发一个IntelliJ IDEA 插件，用于在 IDE 中自动生成符合公司规范的 Spring Boot 模板代码和配置，真正让工具服务工程师。

二、设计思想

我们在开发插件前，明确了以下设计原则：

1. 插件即自动化能力的延伸

通过右键菜单、快捷键等形式将自动化工具嵌入 IDE，让插件成为“代码生成+规范校验+知识沉淀”的载体。

2. 类 Spring Boot 架构设计理念

插件开发虽不涉及服务部署，但我们坚持 Spring Boot 的“模块化、注解驱动、配置分离”思想，以增强可维护性和扩展性。

3. 用 Maven 管理插件结构

我们采用 Maven 组织插件项目结构，使用标准 Java 目录结构，便于 IDE 和团队成员统一开发规范。

三、实现过程和 Java 代码

1. 项目结构（基于 Maven）

idea-springboot-plugin/
├── pom.xml
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/idea/plugin/
│   │   │       ├── action/              // 用户操作入口
│   │   │       ├── service/             // 模板处理逻辑
│   │   │       ├── template/            // 代码模板
│   │   │       └── PluginStartup.java   // 插件初始化
│   │   └── resources/
│   │       ├── META-INF/
│   │       │   └── plugin.xml           // 插件声明
│   │       └── templates/               // Velocity 或自定义模板

2. Maven 插件配置（`pom.xml`）

<project><modelVersion>4.0.0</modelVersion><groupId>com.example.idea</groupId><artifactId>springboot-plugin</artifactId><version>1.0.0</version><properties><java.version>17</java.version><intellij.version>2022.3</intellij.version></properties><dependencies><!-- IntelliJ SDK --><dependency><groupId>com.jetbrains.intellij.idea</groupId><artifactId>ideaIC</artifactId><version>${intellij.version}</version><type>zip</type></dependency></dependencies><build><plugins><plugin><groupId>org.jetbrains.intellij</groupId><artifactId>intellij-maven-plugin</artifactId><version>1.13.3</version><configuration><version>${intellij.version}</version><type>IC</type></configuration></plugin></plugins></build>
</project>

3. 插件核心功能：一键生成 Spring Boot 模板代码

(1) 插件 Action（右键菜单入口）

public class GenerateSpringBootAction extends AnAction {@Overridepublic void actionPerformed(@NotNull AnActionEvent e) {Project project = e.getProject();Editor editor = e.getData(CommonDataKeys.EDITOR);if (project == null || editor == null) return;String className = Messages.showInputDialog(project, "请输入类名：", "Spring Boot 生成器", Messages.getQuestionIcon());if (className == null || className.isEmpty()) return;// 调用模板生成逻辑SpringBootTemplateService service = new SpringBootTemplateService();String content = service.generateControllerTemplate(className);WriteCommandAction.runWriteCommandAction(project, () -> {Document doc = editor.getDocument();int offset = editor.getCaretModel().getOffset();doc.insertString(offset, content);});}
}

(2) 模板生成逻辑（Spring Boot 风格 Service）

public class SpringBootTemplateService {public String generateControllerTemplate(String className) {return """@RestController@RequestMapping("/api/%s")public class %sController {@GetMapping("/demo")public String demo() {return "Hello from %s!";}}""".formatted(className.toLowerCase(), className, className);}
}

(3) 注册插件入口（`plugin.xml`）

<actions><action id="GenerateSpringBootAction"class="com.example.idea.plugin.action.GenerateSpringBootAction"text="生成 Spring Boot Controller"description="自动生成带有注解的 Spring Boot 控制器"><add-to-group group-id="EditorPopupMenu" anchor="last"/></action>
</actions>

运行 mvn install → mvn intellij:runIde，即可在弹出的 IDE 沙箱中测试插件效果。

四、应用场景

场景	插件作用
新建微服务模块	快速生成 controller、service、mapper 模板，减少重复代码
配置文件生成	根据类名自动生成 `application-xxx.yml` 配置片段
接口定义规范化	自动添加 `@RestController`、`@RequestMapping` 等注解
团队开发规范	插件统一模板和输出结构，减少代码风格差异
技术推广	用插件沉淀领域经验，降低上手门槛，形成标准