IntelliJ IDEA插件开发：如何使用Kotlin Poet修改已有文件内容

一、获取项目中的目标文件 #

IntelliJ插件依赖PSI（Program Structure Interface）来操作代码文件，以下是两种常见的获取方式：

• 从指定目录递归获取Kotlin文件

  val project = ... // 从插件上下文（如AnActionEvent）获取Project实例
  val targetDirPath = "/path/to/your/target/directory"
  val targetDir = LocalFileSystem.getInstance().findFileByPath(targetDirPath) ?: return
  
  val kotlinFiles = mutableListOf<KtFile>()
  VfsUtilCore.iterateChildrenRecursively(targetDir, null) { file ->
      if (file.name.endsWith(".kt")) {
          val psiFile = PSIFileFactory.getInstance(project)
              .createFileFromContent(file.name, KotlinLanguage.INSTANCE, file.contentsToByteArray()) as KtFile
          kotlinFiles.add(psiFile)
      }
      true // 继续递归遍历子目录
  }
  

• 获取用户选中的文件
  在插件的AnAction实现中，可从事件上下文提取用户选中的文件：

  override fun actionPerformed(e: AnActionEvent) {
      val project = e.project ?: return
      val selectedFiles = e.getData(PlatformDataKeys.VIRTUAL_FILE_ARRAY) ?: return
      
      val targetKtFiles = selectedFiles.filter { it.name.endsWith(".kt") }
          .map {
              PSIFileFactory.getInstance(project)
                  .createFileFromContent(it.name, KotlinLanguage.INSTANCE, it.contentsToByteArray()) as KtFile
          }
      // 后续处理targetKtFiles
  }
  

二、使用Kotlin Poet生成函数并插入目标类 #

1. 生成函数代码 #

用Kotlin Poet定义要添加的函数，例如一个简单的日志打印函数：

val logFunction = FunSpec.builder("printLog")
    .addParameter("message", String::class)
    .addStatement("println(\"[CustomLog] \$message\")")
    .build()

2. 插入函数到目标类 #

遍历PSI文件中的类，匹配目标类后插入生成的函数，注意所有修改必须在WriteCommandAction中执行：

targetKtFiles.forEach { ktFile ->
    ktFile.classes.forEach { ktClass ->
        // 筛选目标类，例如通过类名匹配
        if (ktClass.name == "YourTargetClass") {
            WriteCommandAction.runWriteCommandAction(project) {
                // 将Kotlin Poet生成的代码转为PSI元素
                val psiFactory = KtPsiFactory(project)
                val functionPsi = psiFactory.createFunction(logFunction.toString())
                
                // 插入到类的末尾
                ktClass.add(functionPsi)
                
                // 保存文件修改
                DocumentManager.getInstance(project).saveDocument(ktFile.viewProvider.document!!)
            }
        }
    }
}

三、关键注意事项 #

• 所有代码修改操作必须包裹在WriteCommandAction中，确保IDE的事务一致性和线程安全
• 处理PSI元素时要严格做空安全校验，避免空指针异常
• Kotlin Poet生成的代码格式要和目标文件保持一致，可通过CodeStyleManager自动格式化：

  CodeStyleManager.getInstance(project).reformat(functionPsi)
  

内容的提问来源于stack exchange，提问作者Anup Ammanavar