虚拟文件系统使用类似磁盘的概念对零散文件进行集中管理，优化资源加载时产生的内存分配，甚至可以对资源进行局部片段加载，这些都将极大提升资源加载时的性能。
常规用法
获取文件系统组件
|
1 |
FileSystemComponent fileSystemComponent = GameEntry.GetComponent<FileSystemComponent>(); |
检查是否存在文件系统
|
1 2 3 4 |
string fullPath = Path.Combine(Application.persistentDataPath, "FileSystem.dat"); // 检查是否存在文件系统，参数要传递的是文件系统的完整路径 bool hasFileSystem = fileSystemComponent.HasFileSystem(fullPath); |
获取文件系统
|
1 2 3 4 |
string fullPath = Path.Combine(Application.persistentDataPath, "FileSystem.dat"); // 获取文件系统，参数要传递的是文件系统的完整路径 IFileSystem fileSystem = fileSystemComponent.GetFileSystem(fullPath); |
创建文件系统
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// 要创建的文件系统的完整路径 string fullPath = Path.Combine(Application.persistentDataPath, "FileSystem.dat"); // 要创建的文件系统最大能容纳文件数量 int maxFileCount = 16; // 要创建的文件系统最大能容纳的块数据数量 int maxBlockCount = 256; // 创建文件系统（使用读写模式进行访问） IFileSystem fileSystem = fileSystemComponent.CreateFileSystem(fullPath, FileSystemAccess.ReadWrite, maxFileCount, maxBlockCount); // 创建文件系统（使用只写模式进行访问） IFileSystem fileSystem = fileSystemComponent.CreateFileSystem(fullPath, FileSystemAccess.Write, maxFileCount, maxBlockCount); |
文件系统块数据（Block）是 Game Framework 文件系统中引入的一个数据结构，用于索引文件内容数据区在文件系统中的偏移、长度等信息。即使文件从文件系统中被删除，文件系统块数据依然会保留，并将原先的文件内容数据区标记为文件系统碎片。
文件系统当前已使用的块数据数量 = 文件系统当前文件数量 + 文件系统当前碎片数量
显然，一个文件系统最大能容纳的块数据数量不应少于最大能容纳的文件数量。
当文件系统增加新文件时，会优先分配合适的文件系统碎片的空间用于存储新文件。
加载文件系统
|
1 2 3 4 5 6 7 8 |
// 要加载的文件系统的完整路径 string fullPath = Path.Combine(Application.persistentDataPath, "FileSystem.dat"); // 加载文件系统（使用读写模式进行访问） IFileSystem fileSystem = fileSystemComponent.LoadFileSystem(fullPath, FileSystemAccess.ReadWrite); // 加载文件系统（使用只读模式进行访问） IFileSystem fileSystem = fileSystemComponent.LoadFileSystem(fullPath, FileSystemAccess.Read); |
销毁文件系统
|
1 2 3 |
// 销毁文件系统，传入已创建或者已加载的文件系统 // 第二个参数 deletePhysicalFile 指示是否删除文件系统对应的物理文件，传 true 时要小心 fileSystemComponent.DestroyFileSystem(fileSystem, false); |
获取文件系统数量
|
1 2 |
// 获取文件系统数量 int fileSystemCount = fileSystemComponent.Count; |
获取所有文件系统集合
|
1 2 3 4 5 6 |
// 使用返回数组的方式，获取所有文件系统集合 IFileSystem[] fileSystems = fileSystemComponent.GetAllFileSystems(); // 使用填充列表的方式，获取所有文件系统集合 List<IFileSystem> fileSystems = new List<IFileSystem>(); fileSystemComponent.GetAllFileSystems(fileSystems); |
文件系统相关操作
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
// 获取文件系统完整路径 string fullPath = fileSystem.FullPath; // 获取文件系统访问方式 FileSystemAccess access = fileSystem.Access; // 获取文件数量 int fileCount = fileSystem.FileCount; // 获取最大文件数量 int maxFileCount = fileSystem.MaxFileCount; // 获取文件信息，包括文件名称、文件偏移、文件长度信息 FileInfo fileInfo = fileSystem.GetFileInfo("FileName.dat"); // 使用返回数组的方式，获取所有文件信息 FileInfo[] fileInfos = fileSystem.GetAllFileInfos(); // 使用填充列表的方式，获取所有文件信息 List<FileInfo> fileInfos = new List<FileInfo>(); fileSystem.GetAllFileInfos(fileInfos); // 检查是否存在指定文件 bool hasFile = fileSystem.HasFile("FileName.dat"); // 使用返回数组的方式，读取指定文件 byte[] bytes = fileSystem.ReadFile("FileName.dat"); // 使用填充数组的方式，读取指定文件 byte[] buffer = new byte[X]; // 读取文件使用的 buffer，用此方式能够复用 buffer 来消除 GCAlloc int startIndex = 0; int length = buffer.Length - startIndex; int bytesRead = fileSystem.ReadFile("FileName.dat", buffer); int bytesRead = fileSystem.ReadFile("FileName.dat", buffer, startIndex); int bytesRead = fileSystem.ReadFile("FileName.dat", buffer, startIndex, length); // 使用填充流的方式，读取指定文件 Stream stream = new X; // 读取文件片段使用的 stream，用此方式能够复用 buffer 来消除 GCAlloc int bytesRead = fileSystem.ReadFile("FileName.dat", stream); // 使用返回数组的方式，读取指定文件片段 byte[] bytes = fileSystem.ReadFileSegment("FileName.dat", length); byte[] bytes = fileSystem.ReadFileSegment("FileName.dat", offset, length); // 使用填充数组的方式，读取指定文件片段 int offset = M; // 要读取片段的偏移 int length = N; // 要读取片段的长度 byte[] buffer = new byte[X]; // 读取文件片段使用的 buffer，用此方式能够复用 buffer 来消除 GCAlloc int bytesRead = fileSystem.ReadFileSegment("FileName.dat", buffer, length); int bytesRead = fileSystem.ReadFileSegment("FileName.dat", buffer, startIndex, length); int bytesRead = fileSystem.ReadFileSegment("FileName.dat", offset, buffer, length); int bytesRead = fileSystem.ReadFileSegment("FileName.dat", offset, buffer, startIndex, length); // 使用填充流的方式，读取指定文件片段 Stream stream = new X; // 读取文件片段使用的 stream，用此方式能够复用 buffer 来消除 GCAlloc int bytesRead = fileSystem.ReadFileSegment("FileName.dat", stream, length); int bytesRead = fileSystem.ReadFileSegment("FileName.dat", offset, stream, length); // 将字节数组写入指定文件 bool result = fileSystem.WriteFile("FileName.dat", buffer); bool result = fileSystem.WriteFile("FileName.dat", buffer, startIndex); bool result = fileSystem.WriteFile("FileName.dat", buffer, startIndex, length); // 将流写入指定文件 bool result = fileSystem.WriteFile("FileName.dat", stream); // 将物理文件写入指定文件 bool result = fileSystem.WriteFile("FileName.dat", @"E:\PhysicalFileName.dat"); // 指定文件另存为物理文件 bool result = fileSystem.SaveAsFile("FileName.dat", @"E:\PhysicalFileName.dat"); // 重命名指定文件 bool result = fileSystem.RenameFile("OldFileName.dat", "NewFileName.dat"); // 删除指定文件 bool result = fileSystem.DeleteFile("FileName.dat"); |
参考手册
最佳实践
创建文件系统时，合理设置 MaxFileCount 和 MaxBlockCount
创建文件系统时，需要设置 MaxFileCount（能容纳的最大文件数量）和 MaxBlockCount（能容纳的最大块数据数量），这两个参数决定了文件系统初始化化时头部块的大小。
一般来说，用于存储不变资源的只读文件系统，假设需要写入 N 个文件，那么 MaxFileCount 和 MaxBlockCount 都设置为 N 即可。
用于存储可变资源的文件系统，根据预估文件数量，设置合适的 MaxFileCount 即可，MaxBlockCount 可根据此文件系统中文件更新的频率，设置为 MaxFileCount 的 2 ~ 32 倍是比较合适的，文件系统中的文件被更新频率越高，倍数可以相应设置的越高。当文件系统碎片占用的块数据过多导致所有块数据被填满时，等同于触发文件系统容量已满，无法再写入新文件。
备注：在后续版本的文件系统中，Game Framework 有计划引入 MaxFileCount 和 MaxBlockCount 的自动扩充机制和文件系统碎片整理机制。
单个文件系统的实际大小不要超过 4GB
Game Framework 实际支持单个大小超过 4GB 的文件系统，但由于受以下因素的制约，并不建议使用超过 4GB 的文件系统，而在文件系统大小接近 4GB 前，应拆分出新的文件系统。
- 32 位的最大寻址空间是 4GB，因此当文件大小超过 4GB 时，部分老旧手机及操作系统可能不支持
- Unity 2020.1 版本之前，不支持从偏移超过 4GB 的位置处加载 AssetBundle，参考：https://forum.unity.com/threads/bug-4gb-limit-to-textures-in-standalone-build.441116/page-5#post-5300130
读写文件时考虑使用带有 buffer 缓存的重载方法
读取文件和文件片段时，可以预先准备好一个 byte[] buffer 作为缓存，进而复用此 buffer 来消除 GCAlloc。
读取文件时考虑使用读取文件片段方法
对于数据表、本地化字典表这类文本或二进制数据，在实际应用的多数情形下，将全部内容加载到内存中是非常浪费的，对于这类数据不妨在使用某条数据时再去读取这条数据，即所谓的懒加载或者延迟加载。通过合理构造数据结构并利用文件系统能够读取文件片段的特性，即可做到这一点。
例如，先读取字典表的全部 key 值，并记录每个 value 值对应的偏移。在需要获取某个 key 的 value 值时，根据已经记录的偏移值利用读取文件片段的方法实时加载 value 值并缓存。
扩充文件系统的使用场景
Game Framework 提供的文件系统模块是开放的，适用于对任何资源进行组织和管理，而不仅限于 Game Framework 内部使用，故可以考虑将文件系统模块应用在游戏的很多情形下。
例如，在制作玩家聊天自定义表情（玩家可以自行上传表情图片并通过聊天频道发送给其他玩家）的时候，可以考虑将玩家上传和下载的自定义表情图片存储于一个由游戏逻辑创建并管理的 CustomEmotions 文件系统中，而不是将这些图片散放于磁盘上，这样将很好的提升磁盘 IO 性能并能一定程度上提升安全性。
常见问题
文件系统能在哪些平台和目录下使用
文件系统在 Windows、Mac、iOS、Android 平台下均可使用，也同时兼容在各平台的 StreamingAssets 和 PersistentDataPath 目录下使用。但需要注意的是，当文件系统存储于 StreamingAssets 目录下时，访问方式需要始终为 Read，因为此目录下的资源始终是只读的。
用于更新的资源如何使用文件系统
资源管理已经集成文件系统，如果想让资源存放于文件系统，只需要在构建配置 ResourceCollection.xml 中，对应的资源 Resource 标签下指定 FileSystem 属性即可。构建资源时，会自动将此 Resource 放入指定的文件系统，运行时加载资源时，也会自动去对应的文件系统进行加载。
