IDEA 插件开发：自定义代码生成器的实现与发布

1. 核心概念

• 代码生成器：通过模板自动生成重复性代码的工具，例如：
  • 实体类的Getter/Setter
  • 单元测试桩代码
  • 接口实现类骨架
• 技术栈：
  • IntelliJ Platform SDK：插件开发框架
  • PSI（Program Structure Interface）：代码结构操作接口
  • Gradle：项目构建工具

---

2. 实现步骤

(1) 创建插件项目

# 使用官方模板创建项目
gradle init --type intellij-plugin

在build.gradle中配置：

intellij {
    version = '2023.1'  // 指定IDEA版本
    plugins = ['java']  // 依赖的插件
}

(2) 定义代码生成动作

继承AnAction类实现生成逻辑：

public class CodeGeneratorAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {
        Project project = e.getProject();
        Editor editor = e.getData(CommonDataKeys.EDITOR);
        
        // 1. 获取当前代码上下文
        PsiFile file = PsiDocumentManager.getInstance(project).getPsiFile(editor.getDocument());
        PsiElement element = file.findElementAt(editor.getCaretModel().getOffset());
        
        // 2. 解析类信息（示例：生成Getter）
        if (element instanceof PsiClass) {
            PsiClass psiClass = (PsiClass) element;
            generateGetters(psiClass);  // 自定义生成方法
        }
    }
    
    private void generateGetters(PsiClass psiClass) {
        // 3. 通过PSI API修改代码结构
        PsiElementFactory factory = JavaPsiFacade.getElementFactory(psiClass.getProject());
        for (PsiField field : psiClass.getFields()) {
            String getterCode = "public " + field.getType().getPresentableText() 
                              + " get" + capitalize(field.getName()) + "() {\n"
                              + "    return this." + field.getName() + ";\n}";
            psiClass.add(factory.createMethodFromText(getterCode, null));
        }
    }
}

(3) 注册动作到IDE

在plugin.xml中注册：

<actions>
    <action 
        id="CustomCodeGenerator" 
        class="com.example.CodeGeneratorAction"
        text="Generate Getters">
        <add-to-group group-id="CodeMenu" anchor="last"/>
    </action>
</actions>

---

3. 关键API详解

API组件	作用	示例
PsiClass	操作Java类	psiClass.getFields()
PsiElementFactory	创建代码元素	createMethodFromText("public void test(){}")
Editor	控制文本编辑	editor.getCaretModel().getOffset()

---

4. 模板引擎集成

使用Velocity实现动态模板：

1. 添加依赖：

   dependencies {
       implementation 'org.apache.velocity:velocity-engine-core:2.3'
   }
   

2. 模板示例 (getter.vm)：

   public ${field.type} get${StringUtils.capitalize($field.name)}() {
       return this.${field.name};
   }
   

3. 渲染逻辑：

   VelocityContext context = new VelocityContext();
   context.put("field", targetField);
   StringWriter writer = new StringWriter();
   Velocity.mergeTemplate("templates/getter.vm", context, writer);
   

---

5. 调试与测试

• 调试：通过Gradle任务启动沙盒环境

  ./gradlew runIde
  

• 测试：使用LightJavaCodeInsightFixtureTestCase编写单元测试

  public class GeneratorTest extends LightJavaCodeInsightFixtureTestCase {
      public void testGetterGeneration() {
          myFixture.configureByText("Test.java", "class Test { int count; }");
          myFixture.performEditorAction("CustomCodeGenerator"); // 触发动作
          myFixture.checkResult("class Test { int count; \n public int getCount() { return count; } }");
      }
  }
  

---

6. 打包与发布

(1) 构建插件包

./gradlew buildPlugin  # 在build/distributions生成.zip包

(2) 发布到JetBrains仓库

1. 登录插件发布平台
2. 上传ZIP文件并通过审核
3. 版本更新时修改plugin.xml：

   <idea-plugin>
       <version>1.1.0</version>  <!-- 递增版本号 -->
       <change-notes>修复字段空指针问题</change-notes>
   </idea-plugin>
   

---

7. 性能优化建议

1. 延迟加载：在plugin.xml中声明<depends>com.intellij.modules.platform</depends>
2. 批量操作：使用WriteCommandAction合并多次PSI操作：

   WriteCommandAction.runWriteCommandAction(project, () -> {
       generateGetters(psiClass);
       generateSetters(psiClass); 
   });
   

3. 缓存模板：避免重复解析Velocity模板

复杂度分析：代码生成操作的时间复杂度为$O(n)$（$n$为字段数），空间复杂度$O(1)$

---

通过以上步骤，即可实现可发布的代码生成器插件。实际开发中可扩展支持：

• 多语言（Kotlin/Python）
• 数据库实体生成
• REST API脚手架生成