IntelliJ Platform 插件开发文档翻译 - 虚拟文件 Virtual Files

原文: Virtual Files

虚拟文件 com.intellij.openapi.vfs.VirtualFileIntelliJ Platform’s 虚拟文件系统的文件. 大多数情况,我们说一个文件是指本地文件系统的文件. 在IntelliJ Platform中,由于平台灵活地支持多类文件系统,所以虚拟文件同时也可以指代JAR包里的类文件、版本控制系统中历史版本的文件等等。

VFS级别的文件只支持二进制内容。你可以通过流(stream)的方式读写VirtualFile的二进制数据,编码、行分隔符这类概念只被更高的系统级别支持。

如何获取一个虚拟文件

  • 从action获得: e.getData(PlatformDataKeys.VIRTUAL_FILE).
    如果你选择了多个文件,使用: e.getData(PlatformDataKeys.VIRTUAL_FILE_ARRAY).
  • 使用本地文件系统上的路径: LocalFileSystem.getInstance().findFileByIoFile()
  • 从PSI文件 : psiFile.getVirtualFile() (如果PSI文件只存在于内存中,返回null)
  • 从Document中: FileDocumentManager.getInstance().getFile()

我可以用它做什么?

支持所有的传统文件操作,比如 遍历整个文件系统、获取文件内容、重命名、移动、删除。遍历操作应该使用VfsUtilCore.iterateChildrenRecursively来避免符号链接造成的无限循环。

虚拟文件系统如何建立?

VFS由系统在项目根目录自上而下地扫描并建立。新文件由VFS的refreshes操作检测。这一操作由VirtualFileManager.getInstance().refresh()VirtualFile.refresh()方法触发。也会在文件系统watchers接收到文件系统变化的通知时触发(Windows和Mac操作系统上存在)。

作为一个插件开发者,当你需要访问由外部工具通过IntelliJ Platform 的API新创建的文件时,你需要先执行VFS的refresh操作。

一个虚拟文件的生命周期?

硬盘上的一个文件对应的VirtualFile实例有着喝IDEA进程相同的生命周期。同一个文件可能有多个实例,这些实例都可被回收。这个文件本体是用户数据的载体,用户数据同个这个文件在多个实例间共享数据。如果文件本体删除,它对应的多个VirtualFile都会失效(isValid()方法反悔false,对它的操作会抛出异常)。

如何创建一个虚拟文件?

通常你不需要这么做。按照规则,文件通常使用PSI API或常规的java.io.File API创建。

如果你想通过VFS创建文件,你可以使用VirtualFile.createChildData()方法创建一个VirtualFile实例,然后使用VirtualFile.setBinaryContent()方法往文件里写数据。

如何获取VFS改变的通知?

VirtualFileManager.addVirtualFileListener() 方法可以接收到VFS的所有改变行为。

如何扩展VFS?

实现一个第三方的文件系统(比如FTP文件系统),需要实现 VirtualFileSystem 接口(大多数时候也要提供 VirtualFile的实现),并且把你的实现注册成一个application component.。

若要把这些这些文件操作应用到本地文件系统上(比如,你再开发一个版本控制系统,需要自定义重命名/移动操作),你应该实现LocalFileOperationsHandler接口,并通过LocalFileSystem.registerAuxiliaryFileOperationsHandler方法注册它。

VFS的工作细则?

IntelliJ Platform Virtual File System 查看VFS架构和使用指引的更多细节。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容