IntelliJ IDE 插件开发 | （六）内部模式的使用

news2024/11/19 6:40:00

系列文章

IntelliJ IDE 插件开发 |（一）快速入门
IntelliJ IDE 插件开发 |（二）UI 界面与数据持久化
IntelliJ IDE 插件开发 |（三）消息通知与事件监听
IntelliJ IDE 插件开发 |（四）来查收你的 IDEA 使用报告吧
IntelliJ IDE 插件开发 |（五）VFS 与编辑器
IntelliJ IDE 插件开发 |（六）内部模式的使用

前言

前几篇文章主要介绍了 IntelliJ IDE 插件开发的基础知识和实战内容，作为后续内容的过渡，本文会讲解前几篇文章中提到过的内部模式的使用。内部模式通过菜单形式提供了一系列实用工具，能够帮助初学 IntelliJ IDE 插件的同学极大提升开发效率，由于内部模式提供的工具过多，本文则会挑选几个比较实用的工具进行介绍。

启用内部模式

首先在帮助菜单中找到Edit Custom Properties...：

然后加入如下配置：

idea.is.internal=true

保存后重启 IDEA，就可以在 Tools 菜单中发现多了一个 Internal Actions：

下面介绍的工具都是基于 Internal Actions 下的，按照实用性，顺序会有所差异。

UI Debugger

在 Internal Actions 下找到 UI Debugger 菜单，点击后会出现以下弹框：

可以发现这里有 Playback 和 Actions 两个标签页，其中 Playback 用于执行给定的脚本，例如以下脚本会自动执行 CTRL + F 显示搜索框，然后先开启大写，最后输入 HELLO：

%[control F]
%type 20:16;72:16;69:16;76:16;76:16;79:16

第一行用于执行 CTRL + F，第二行中的所有的数字都对应键盘编码（不是ASCII码），例如 20代表开启大写，72代表字符 h，所有的输入用 ; 进行分割，: 前表示字符编码，: 后表示控制字符的编码。所有支持的命令和语法规则可以参考源码，由于这个功能在插件开发中用处不大，这里就不展开介绍了。

效果如下：

上面关于 Playback 的使用了解即可，这里主要讲解一下 Actions 的使用，通过前面的文章我们可以知道，在 IntelliJ IDE 中各种操作（不管是点击菜单项还是通过快捷键）都有相对应的 Action，而 Actions 这个菜单就是用于帮助我们查看每个操作所对应的 Action 类名和 id（如果存在），而知道了 Action 的 id，我们就可以调用相应的操作，这样就实现了对 IDEA 自带功能的使用（也可以直接根据 Action 的类名去找相应的文件去看实现方式），下面以一个具体的例子去介绍使用方式：

例如我们想实现一个根据 Kotlin 类定位到对应的 class 文件并打开的功能，我们首先通过 UI Debugger 去查看 IDEA 定位文件并打开对应的 Action：

这里可以看到该操作对应的 ActionId 为 SelectInProjectView，然后我们只需要实现根据 Kotlin 文件名找到同名的 class 文件的逻辑即可，最终实现方式如下：

class FindClassAction: AnAction() {
    
    override fun actionPerformed(e: AnActionEvent) {
        val project = e.project ?: return
        val file = e.getData(CommonDataKeys.VIRTUAL_FILE_ARRAY)?.get(0) ?: return
        val kotlinSuffix = ".kt"
        val classSuffix = ".class"
        
        if (!file.name.endsWith(kotlinSuffix)) {
            Utils.info("请选择 Kotlin 文件")
            return
        }
        // 查找 class 文件路径
        val className = file.name.replace(kotlinSuffix, classSuffix)
        val fileList = findFiles(project.basePath.toString(), className, setOf(".idea"))
        if (fileList.isEmpty()) {
            Utils.info("未找到对应类文件")
            return
        }
        val classFile = fileList[0]
        LocalFileSystem.getInstance().findFileByIoFile(classFile)
            ?.let {
                // 打开文件
                FileEditorManager.getInstance(project).openFile(it, true)
                // 定位文件
                ActionManager.getInstance().getAction("SelectInProjectView").actionPerformed(e)
            }
    }
    
    // 在指定路径递归查询某个文件, 同时排除指定的路径
    private fun findFiles(rootDir: String, targetFileName: String, excludedDirs: Set<String> = emptySet()): List<File> { 
        val result = mutableListOf<File>()
        fun searchFiles(directory: File) {
            val files = directory.listFiles() ?: return
            for (file in files) {
                if (file.isDirectory) {
                    if (file.name !in excludedDirs) {
                        searchFiles(file)
                    }
                } else {
                    if (file.name == targetFileName && file.path.contains("classes")) {
                        result.add(file)
                    }
                }
            }
        }
        searchFiles(File(rootDir))
        return result
    }
}