文件系统

Mr.Hope ... 小程序 大约 4 分钟

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

const fs = wx.getFileSystemManager();
1

文件主要分为两大类:

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

其中本地文件又分为三种:

  • 本地临时文件: 临时产生,随时会被回收的文件。不限制存储大小。

  • 本地缓存文件: 小程序通过接口把本地临时文件缓存后产生的文件,不能自定义目录和文件名。跟本地用户文件共计,普通小程序最多可存储 10MB,游戏类目的小程序最多可存储 50MB。

  • 本地用户文件: 小程序通过接口把本地临时文件缓存后产生的文件,允许自定义目录和文件名。跟本地缓存文件共计,普通小程序最多可存储 10MB,游戏类目的小程序最多可存储 50MB。

# 代码包文件

由于代码包文件大小限制,代码包文件适用于放置首次加载时需要的文件。

# 访问代码包文件

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

注意

这个和 Node 是不一样的,请特别注意一下。

如: /a/b/ca/b/c 都是合法的,./a/b/c ../a/b/c 则不合法。

path

# 修改代码包文件

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

# 本地文件

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

本地文件沙盒.png

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

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

其中,协议名在 iOS/Android 客户端为 "wxfile",在开发者工具上为 "http",开发者无需关注这个差异,也不应在代码中去硬编码完整文件路径。

# 本地临时文件

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

wx.chooseImage({
  success: (res) => {
    const { tempFilePaths } = res; // tempFilePaths 的每一项是一个本地临时文件路径
  },
});
1
2
3
4
5

# 本地缓存文件 无需使用

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

fs.saveFile({
  tempFilePath: "", // 传入一个本地临时文件路径
  success: (res) => {
    console.log(res.savedFilePath); // res.savedFilePath 为一个本地缓存文件路径
  },
});
1
2
3
4
5
6

提示

本地缓存文件是最初的设计,1.7.0 版本开始,提供了功能更完整的本地用户文件,可以完全覆盖本地缓存文件的功能,如果不需要兼容低于 1.7.0 版本,可以不使用本地缓存文件。

# 本地用户文件 重要

从 1.7.0 版本开始新增

小程序提供了一个用户文件目录,有完全自由的读写权限。通过 wx.env.USER_DATA_PATH 可以获取到这个目录的路径。

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

# 读写权限

接口、组件
代码包文件
本地临时文件
本地缓存文件
本地用户文件

# 清理策略

  • 本地临时文件只保证在小程序当前生命周期内,一旦小程序被关闭就可能被清理,即下次冷启动不保证可用。
  • 本地缓存文件和本地用户文件的清理时机跟代码包一样,只有在代码包被清理的时会被清理。

提示

所以说本地用户文件是十分保险的,本地用户文件一定和小程序文件一起消失。

注: 如果用户太长时间不使用小程序或者手机空间不足,小程序代码包也是可能被杀掉的。这样用户本地的所有数据就会一起丢失。用户再次打开小程序会重新下载小程序代码包并进入初始化流程。