文件系统

文件系统是小游戏提供的一套以小游戏和用户维度隔离的存储以及一套相应的管理接口。通过 bl.getFileSystemManager() 可以获取到全局唯一的文件系统管理器，所有文件系统的管理操作通过 FileSystemManager 来调用。

const fs = bl.getFileSystemManager()

文件主要分为两大类：

• 代码包文件：代码包文件指的是在项目目录中添加的文件。
• 本地文件：通过调用接口本地产生，或通过网络下载下来，存储到本地的文件。

其中本地文件又分为四种：

1. 本地临时文件：临时产生，随时会被回收的文件。不限制存储大小。
2. 本地缓存文件：小游戏通过接口把本地临时文件缓存后产生的文件，不能自定义目录和文件名。跟本地用户文件共计，最多可存储 200MB。
3. 本地用户文件：小游戏通过接口把本地临时文件缓存后产生的文件，允许自定义目录和文件名。跟本地缓存文件共计，最多可存储 200MB。
4. 本地共享文件：最多可存储 50MB。

代码包文件

由于代码包文件大小限制，代码包文件适用于放置首次加载时需要的文件，对于内容较大或需要动态替换的文件，不推荐添加到代码包中，推荐在小游戏启动之后再调用下载接口下载到本地。

访问代码包文件

代码包文件的访问方式是从项目根目录开始写文件路径，不支持相对路径的写法。

修改代码包文件

代码包内的文件无法在运行后动态修改或删除，修改代码包文件需要重新发布版本。

本地文件

本地文件指的是小游戏被用户添加到手机后，会有一块独立的文件存储区域，以用户维度隔离。即同一台手机，每个用户不能访问到其他登录用户的文件，同一个用户不同 appId 之间的文件也不能互相访问。

本地文件的文件路径均为以下格式：

{{协议名}}://文件路径

本地临时文件

本地临时文件只能通过调用特定接口产生，不能直接写入内容。本地临时文件产生后，仅在当前生命周期内有效，重启之后即不可用。因此，不可把本地临时文件路径存储起来下次使用。如果需要下次在使用，可通过 FileSystemManager.saveFile() 或 FileSystemManager.copyFile() 接口把本地临时文件转换成本地缓存文件或本地用户文件。

示例

bl.downloadFile({
  url: 'XXX',
  success(res) {
    const tempFilePath = res.tempFilePath // tempFilePath 的每一项是一个本地临时文件路径
  }
})

本地缓存文件

本地缓存文件只能通过调用特定接口产生，不能直接写入内容。本地缓存文件产生后，重启之后仍可用。本地缓存文件只能通过 FileSystemManager.saveFile() 接口将本地临时文件保存获得。

示例

fs.saveFile({
  tempFilePath: '', // 传入一个本地临时文件路径
  success(res) {
    console.log(res.savedFilePath) // res.savedFilePath 为一个本地缓存文件路径
  }
})

本地用户文件

我们提供了一个用户文件目录给开发者，开发者对这个目录有完全自由的读写权限。通过 bl.env.USER_DATA_PATH 可以获取到这个目录的路径。

示例

// 在本地用户文件目录下创建一个文件 hello.txt，写入内容 "hello, world"
const fs = bl.getFileSystemManager()
fs.writeFileSync(`${bl.env.USER_DATA_PATH}/hello.txt`, 'hello, world', 'utf8')

本地共享文件

我们另外提供了一个共享文件目录给开发者，开发者对这个目录有完全自由的读写权限。和用户文件的区别是，它不区分用户。在当前设备登录的任何用户，以及未登录用户都能访问该小程序内的共享文件资源。通过 bl.env.SHARE_DATA_PATH 可以获取到这个目录的路径。

示例

// 在本地共享文件目录下创建一个文件 hello.txt，写入内容 "hello, world"
const fs = bl.getFileSystemManager()
fs.writeFileSync(`${bl.env.SHARE_DATA_PATH}/hello.txt`, 'hello, world', 'utf8')

读写权限