微信小程序API 文件·文件管理器

FileSystemManager

基础库 1.9.9 开始支持，低版本需做兼容处理。

文件管理器

方法：

FileSystemManager.access(Object object)

判断文件/目录是否存在

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.accessSync(string path)

FileSystemManager.access 的同步版本

参数

string path

要判断是否存在的文件/目录路径 (本地路径)

错误

FileSystemManager.appendFile(Object object)

基础库 2.1.0 开始支持，低版本需做兼容处理。

在文件结尾追加内容

参数

Object object

object.encoding 的合法值

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.appendFileSync(string filePath, string|ArrayBuffer data, string encoding)

基础库 2.1.0 开始支持，低版本需做兼容处理。

FileSystemManager.appendFile 的同步版本

参数

string filePath

要追加内容的文件路径 (本地路径)

string|ArrayBuffer data

要追加的文本或二进制数据

string encoding

指定写入文件的字符编码

encoding 的合法值

错误

FileSystemManager.copyFile(Object object)

复制文件

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.copyFileSync(string srcPath, string destPath)

FileSystemManager.copyFile 的同步版本

参数

string srcPath

源文件路径，支持本地路径

string destPath

目标文件路径，支持本地路径

错误

FileSystemManager.getFileInfo(Object object)

获取该小程序下的 本地临时文件 或 本地缓存文件 信息

参数

Object object

object.success 回调函数

参数

Object res

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.getSavedFileList(Object object)

获取该小程序下已保存的本地缓存文件列表

参数

Object object

object.success 回调函数

参数

Object res

res.fileList 的结构

FileSystemManager.mkdir(Object object)

创建目录

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.mkdirSync(string dirPath, boolean recursive)

FileSystemManager.mkdir 的同步版本

参数

string dirPath

创建的目录路径 (本地路径)

boolean recursive

基础库 2.3.0 开始支持，低版本需做兼容处理。

是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。

错误

FileSystemManager.readdir(Object object)

读取目录内文件列表

参数

Object object

object.success 回调函数

参数

Object res

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

Array.<string> FileSystemManager.readdirSync(string dirPath)

FileSystemManager.readdir 的同步版本

参数

string dirPath

要读取的目录路径 (本地路径)

返回值

Array.<string> files

指定目录下的文件名数组。

错误

FileSystemManager.readFile(Object object)

读取本地文件内容

参数

Object object

object.encoding 的合法值

object.success 回调函数

参数

Object res

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

string|ArrayBuffer FileSystemManager.readFileSync(string filePath, string encoding, string position, string length)

FileSystemManager.readFile 的同步版本

参数

string filePath

要读取的文件的路径 (本地路径)

string encoding

指定读取文件的字符编码，如果不传 encoding，则以 ArrayBuffer 格式读取文件的二进制内容

encoding 的合法值

string position

基础库 2.10.0 开始支持，低版本需做兼容处理。

从文件指定位置开始读，如果不指定，则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围：[0, fileLength – 1]。单位：byte

string length

基础库 2.10.0 开始支持，低版本需做兼容处理。

指定文件的长度，如果不指定，则读到文件末尾。有效范围：[1, fileLength]。单位：byte

返回值

string|ArrayBuffer data

文件内容

错误

FileSystemManager.removeSavedFile(Object object)

删除该小程序下已保存的本地缓存文件

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.rename(Object object)

重命名文件。可以把文件从 oldPath 移动到 newPath

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.renameSync(string oldPath, string newPath)

FileSystemManager.rename 的同步版本

参数

string oldPath

源文件路径，支持本地路径

string newPath

新文件路径，支持本地路径

错误

FileSystemManager.rmdir(Object object)

删除目录

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.rmdirSync(string dirPath, boolean recursive)

FileSystemManager.rmdir 的同步版本

参数

string dirPath

要删除的目录路径 (本地路径)

boolean recursive

基础库 2.3.0 开始支持，低版本需做兼容处理。

是否递归删除目录。如果为 true，则删除该目录和该目录下的所有子目录以及文件。

错误

FileSystemManager.saveFile(Object object)

保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用。

参数

Object object

object.success 回调函数

参数

Object res

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

string FileSystemManager.saveFileSync(string tempFilePath, string filePath)

FileSystemManager.saveFile 的同步版本

参数

string tempFilePath

临时存储文件路径 (本地路径)

string filePath

要存储的文件路径 (本地路径)

返回值

string savedFilePath

存储后的文件路径 (本地路径)

错误

FileSystemManager.stat(Object object)

获取文件 Stats 对象

参数

Object object

object.success 回调函数

参数

Object res

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

示例代码

recursive 为 false 时

let fs = wx.getFileSystemManager()
fs.stat({
  path: `${wx.env.USER_DATA_PATH}/testDir`,
  success: res => {
    console.log(res.stats.isDirectory())
  }
})

recursive 为 true 时

fs.stat({
  path: `${wx.env.USER_DATA_PATH}/testDir`,
  recursive: true,
  success: res => {
    Object.keys(res.stats).forEach(path => {
      let stats = res.stats[path]
      console.log(path, stats.isDirectory())
    })
  }
})

Stats|Object FileSystemManager.statSync(string path, boolean recursive)

FileSystemManager.stat 的同步版本

参数

string path

文件/目录路径 (本地路径)

boolean recursive

基础库 2.3.0 开始支持，低版本需做兼容处理。

是否递归获取目录下的每个文件的 Stats 信息

返回值

Stats|Object stats

当 recursive 为 false 时，res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时，res.stats 是一个 Object，key 以 path 为根路径的相对路径，value 是该路径对应的 Stats 对象。

错误

示例代码

recursive 为 false 时

let fs = wx.getFileSystemManager()
fs.stat({
  path: `${wx.env.USER_DATA_PATH}/testDir`,
  success: res => {
    console.log(res.stats.isDirectory())
  }
})

recursive 为 true 时

fs.stat({
  path: `${wx.env.USER_DATA_PATH}/testDir`,
  recursive: true,
  success: res => {
    Object.keys(res.stats).forEach(path => {
      let stats = res.stats[path]
      console.log(path, stats.isDirectory())
    })
  }
})

FileSystemManager.unlink(Object object)

删除文件

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.unlinkSync(string filePath)

FileSystemManager.unlink 的同步版本

参数

string filePath

要删除的文件路径 (本地路径)

错误

FileSystemManager.unzip(Object object)

解压文件

参数

Object object

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.writeFile(Object object)

写文件

参数

Object object

object.encoding 的合法值

object.fail 回调函数

参数

Object res

res.errMsg 的合法值

FileSystemManager.writeFileSync(string filePath, string|ArrayBuffer data, string encoding)

FileSystemManager.writeFile 的同步版本

参数

string filePath

要写入的文件路径 (本地路径)

string|ArrayBuffer data

要写入的文本或二进制数据

string encoding

指定写入文件的字符编码

encoding 的合法值

错误