虚拟文件

原文链接:
http://www.jetbrains.org/intellij/sdk/docs/basics/architectural_overview/virtual_file.html

虚拟文件com.intellij.openapi.vfs.VirtualFile是*IntelliJ平台 用来表示文件系统中的文件。通常情况下,一个虚拟文件就是本地文件系统中的一个文件,但是IntelliJ平台 *支持多个可插拔的文件系统,所以虚拟文件也可以表示JAR文件中的类,版本控制系统中的文件的旧版本等等。

VFS(虚拟文件系统)仅处理二进制级别的内容。 你可以以字节流形式获取或设置VirtualFile的内容,但编码和行分隔符等概念在更高级别的系统里处理。

我怎样得到一个虚拟文件?

  • 操作:e.getData(PlatformDataKeys.VIRTUAL_FILE);如果你对多选感兴趣,你也可以使用e.getData(PlatformDataKeys.VIRTUAL_FILE_ARRAY)
  • 本地文件系统路径:LocalFileSystem.getInstance().findFileByIoFile()
  • PSI文件:psiFile.getVirtualFile() (如果PSI文件仅存在内存中可能返回null)
  • 文档:FileDocumentManager.getInstance().getFile()

我可以用它做什么?

典型的文件操作都是可用的,例如遍历文件系统、获取文件内容、重命名、移动或删除。递归迭代应该使用VfsUtilCore.iterateChildrenRecursively来执行,防止由递归符号链接引起的无限循环。

它从何而来?

VFS是通过从项目根目录开始从上到下扫描文件系统逐步构建的。文件系统中的新文件可以被VFS刷新时检测到。刷新操作可以使用(VirtualFileManager.getInstance().refresh()VirtualFile.refresh())以编程方式启动。当文件系统监视器接收文件系统更改通知 (Windows和Mac系统可用)时,VFS刷新操作也会被触发。

作为插件开发者,如果需要访问刚刚通过IntelliJ平台API的外部工具创建的文件,则可能需要调用VFS刷新。

虚拟文件可以持久化多长时间?

磁盘上的特定文件在IDEA进程的整个生命周期内由等价的VirtualFile实例表示。同一个文件可能由多个实例相对应,它们可以被垃圾回收系统回收。这种文件是一个UserDataHolder,用户数据会在这些等价的实例中共享。如果文件被删除,它相对应的虚拟文件实例将会无效(isValid()方法返回false,操作造成异常)。

我怎样创建一个虚拟文件?

通常你不必这么做。可以通过PSI API或常规java.io.File API创建文件。

如果你需要通过VFS创建文件,你可以使用VirtualFile.createChildData()方法创建VirtualFile实例,VirtualFile.setBinaryContent()方法向文件写入数据。

VFS改变时我怎样得到通知?

VirtualFileManager.addVirtualFileListener()方法允许你接受所有VFS更改时的通知。

我怎样扩展VFS?

要实现其它文件系统 (例如, FTP文件系统),需要实现VirtualFileSystem类(大多数情况下你还需要实现 VirtualFile类)并将你的实现注册为应用级组件

要hook本地文件系统中执行的操作(例如,你正在开发一个集成自定义重命名/移动处理的版本控制系统),需要实现LocalFileOperationsHandler接口并通过LocalFileSystem.registerAuxiliaryFileOperationsHandler方法注册它。

使用VFS有什么规则?

查看IntelliJ平台虚拟文件系统获取更多VFS架构描述和使用指南的信息。

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

推荐阅读更多精彩内容