原文链接:
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架构描述和使用指南的信息。