记一次Idea插件开发过程

文档目的

记录一下在idea开发插件过程中的一些思考和总结。

过程

接触Idea插件开发

某天快下班的时候，看同事很专注的在鼓弄着啥。于是把头凑过去看了看，同事说他在写idea插件，想把一些功能集成到Idea中，方便操作。于是我便来了兴趣。网上百度了几篇入门指导文章之后，简单了解了Idea插件的一些基础功能。

思考

我也开始想，我能用Idea插件帮我解决什么问题。于是从日常开发代码工作中找到了我的第一个需求点：使用插件帮我生成Dubbo接口的测试代码。

可行性分析

需求已经有了，那么下一步就是分析如何实现。先总结了下写Dubbo接口的测试代码大致步骤：
1. 在Dubbo接口写完之后，一般会涉及几个东西：定义的接口-x.y.z.api.XxxxService，接口实现类-x.y.z.core.service.XxxxServiceImpl，实现其中的某个方法-someMethod.

package x.y.z.core.service;
@Service
public class XxxxServiceImpl implements XxxxService {

    @Override
    public Response someMethod(MyRequest request) {
        return Response.success(Boolean.TRUE);
    }
}

2. 创建测试类之前会先创建一个公用的AbstractServiceTest：

package x.y.z.core;
@SpringBootTest(classes = {BxTestApplication.class})
@RunWith(SpringJUnit4ClassRunner.class)
public class AbstractServiceTest {
    // add some common method
}

3. 在实现类的同项目中对应的src/test/java/x/y/z/core/service目录下创建XxxxServiceTest的测试类

package x.y.z.core.service;
public class XxxxServiceTest extends AbstractServiceTest {
    @Reference(injvm = true)
    private XxxxService service;

    @Test
    public void testSomeMethod() {
        MyRequest request = new MyRequest();
        // TODO init parameter
        print(service.someMethod(request));
    }
}

从写测试代码过程中总结出需要解决的几个点：

• 找到Idea插件中生成Java文件的方式，最好是和我自己通过idea创建Java文件生成的一样。用来生成步骤2中的公共测试类及XxxxServiceTest。
• 找到Idea插件中操作Java文件各个部分的API，比如如何给Java类增加import，给Java类设置extends，查询及新增成员变量，查询及新增方法等。用来生成XxxxServiceTest类中需要的各个部分。

在看了部分官方文档及其他人写的一些插件开发博文之后，找到了对应的方法：

• 生成Java文件：
  1. 使用FileTemplate生成文件内容

public static String generateClassFile(Project project, String packageName, String className){
  // 获取项目中的文件模板
  FileTemplate[] templates = FileTemplateManager.getInstance(project)
              .getTemplates(FileTemplateManager.DEFAULT_TEMPLATES_CATEGORY);
  if(templates != null){
       // 找到生成名称为Class的模板
       FileTemplate classTemplate = null;
       for (FileTemplate template : templates) {
          if("Class".equals(template.getName())){
              classTemplate = template;
              break;
           }
        }
        final FileTemplate template =  classTemplate;
        if (template != null){
            // 获取生成文件的默认参数
            final Properties properties = FileTemplateManager.getDefaultInstance()
                          .getDefaultProperties();
            // 填充package和class name
            properties.put("PACKAGE_NAME", packageName);
            properties.put("NAME", className);
            try{
                template.setLiveTemplateEnabled(true);
                template.setReformatCode(true);
                String result = template.getText(properties);
                // 此处兼容模板生成格式问题
                return result.replaceAll("/public", "/" + LocalFileUtils.LINE + "public");
              } catch (IOException e) {
                throw new RuntimeException("使用Class模板生成内容失败", e);
              }
          }else {
              throw new RuntimeException("未找到Class模板");
          }
    }else{
        throw new RuntimeException("未找到Class模板");
    }
}

2. 创建Java文件并放入某个目录下：参考链接

String content = "java类的内容";
PsiFile newFile = PsiFileFactory.getInstance(project)
                    .createFileFromText(
                            "XxxxServiceTest.java", 
                            JavaFileType.INSTANCE, 
                            content
                          );
PsiJavaFile newJavaFile = (PsiJavaFile) destDirectory.add(newFile);

• 操作Java类的各个部分：
  参考链接：
  - 官网PSI File介绍
  - 如何查看Java文件的PSI结构

  具体使用要靠自己去熟悉和测试SDK中PsiJavaFile和PsiClass的API。下面列举几个我第一个功能点会用到的功能：

1. 增加import：

# 根据
String importClassName = "x.y.z.api.XxxxService";
# 根据FQN找到对应的PsiClass
PsiClass importClass = LocalPsiUtil.findInAllPlace(project, importClassName);
if("当前psiJavaFile中没有该import"){
    // 生成import对应的PsiEelement
    PsiImportStatement importElement = PsiElementFactory.getInstance(project)
            .createImportStatement(importClass);
    // 加入到psiJavaFile中
    psiJavaFile.getImportList().add(importElement);
}

2. 增加extends：

PsiJavaCodeReferenceElement implementeference = PsiElementFactory
                .getInstance(psiClass.getProject())
                .createReferenceFromText(interfaceName, psiClass);
psiClass.getExtendsList().add(extendReference);

3. 增加成员变量：

String fieldExpression = new StringBuilder()
                .append("@Reference(injvm = true)").append(LocalFileUtils.LINE)
                .append("private XxxxService service;")
                .build();
PsiField psiField = PsiElementFactory.getInstance(testClass.getProject())
                .createFieldFromText(fieldExpression, psiClass);
psiClass.add(psiField);

4. 增加方法：

String methodContent = new StringBuilder()
                .append("@Test").append(LocalFileUtils.LINE)
                .append("public void testSomeMethod(){").append(LocalFileUtils.LINE)
                .append("    测试代码生成逻辑").append(LocalFileUtils.LINE)
                .append("}")
                .build();
PsiMethod psiMethod = PsiElementFactory.getInstance(psiClass.getProject())
                .createMethodFromText(methodContent, psiClass, LanguageLevel.JDK_1_8);
psiClass.add(psiMethod);

5. PsiFile或PsiJavaFile对应的PsiClass:

public static PsiClass findPsiClassByFile(PsiFile psiFile){
    if(!(psiFile instanceof PsiJavaFile)){
        return null;
    }
    PsiJavaFile javaFile = (PsiJavaFile)psiFile;
    if(javaFile.getClasses() == null || javaFile.getClasses().length == 0){
        return null;
    }
    return javaFile.getClasses()[0];
}

Coding

需求明确且也证明可行。那么就可以创建项目和Coding了。其实在可行性分析阶段就可以开始搭建项目来验证可行性了。

• 搭建项目：
  参考链接：环境搭建 使用Gradle搭建Idea插件项目
• 过程中想到的需求点：
  受到mybatis相关插件功能中mapper文件和Interface能够实现快速的切换的启发，我也想实现我的实现类中方法和对应测试方法之间的相互切换。于是找到对应的实现方式：[官方指导文档-Line Marker Provider]
  (https://plugins.jetbrains.com/docs/intellij/line-marker-provider.html)。
  下面就简单截图一下我的实现：
  
  image.png

成果

源码：https://pan.baidu.com/s/1adJjIdkgTrKKQFcqD_Ci7g 密码: c21w
插件打包：https://pan.baidu.com/s/1UUaZkWFuilzadclGbgjTIg 密码: tcso

总结

1. 插件开发过程中可以带着功能点去找实现方式。
2. 可以先把Idea Plugin SDK官网看一遍，了解Idea插件的一些基础架构及实现方式和一些知识点，在阅读的时候给你一些启发，能够帮你很快的理解和解决你开发过程中遇到的一些问题。
3. 后续的学习方式，读别人写的一些插件或官方的一些插件项目源码应该是一个不错的学习方式。
4. 日常Coding中，一些繁琐而且无需太多思考或自定义的一些操作都可以通过插件的形式帮助我们提供开发效率，比如：各种测试代码的生成，mybatis中mapper的生成，项目中数据库配置等等。

参考链接

• Idea Plugin SDK官网
• 插件涉及Java的部分知识点
• 别人整理的一些教程