导航|地址|刷新
文件 | “人民网+”小程序 | 开放平台










“人民网+”小程序|文档中心






指引

开发

数据

设计

运营











# 文件

# saveFile

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38


saveFile(Object object)

保存文件到本地。


注意

saveFile 会把临时文件移动，因此调用成功后传入的 tempFilePath 将不可用。


参数

Object object

属性	类型	默认值	必填	说明
tempFilePath	string		是	需要保存的文件的临时路径
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
savedFilePath	number	存储后的文件路径

示例代码

ft.chooseImage({success(res){const tempFilePaths = res.tempFilePaths ft.saveFile({tempFilePath: tempFilePaths[0],success(res){const savedFilePath = res.savedFilePath }})}})


注意

本地文件存储的大小限制为10M


# removeSavedFile

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38


removeSavedFile(Object object)

删除本地缓存文件。

参数

Object object

属性	类型	默认值	必填	说明
tempFilePath	string		是	需要删除的文件的路径
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

ft.getSavedFileList({success(res){if(res.fileList.length >0){ ft.removeSavedFile({filePath: res.fileList[0].filePath,complete(res){ console.log(res)}})}}})

# openDocument

基础库1.3.9开始支持，iOS版本2.1.23，Android 2.37.7


openDocument(Object object)

新开页面打开文档。

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	文件路径，可通过 downloadFile 获得
fileType	string		否	文件类型，指定文件类型打开文件
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fileType 的合法值

值	说明
doc	doc 格式
docx	docx 格式
xls	xls 格式
xlsx	xlsx 格式
ppt	ppt 格式
pptx	pptx 格式
pdf	pdf 格式

示例代码

ft.downloadFile({// 示例 url，并非真实存在url:'http://example.com/somefile.pdf',success(res){const filePath = res.tempFilePath ft.openDocument({ filePath,success(res){ console.log('打开文档成功')}})}})

# getSavedFileList

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38


getSavedFileList(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
fileList	Array.<Object>	文件数组，每一项是一个 FileItem

res.fileList 的结构

属性	类型	说明
filePath	string	本地路径
size	number	本地文件大小，以字节为单位
createTime	number	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数

示例代码

ft.getSavedFileList({success(res){ console.log(res.fileList)}})

# getSavedFileInfo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38


getSavedFileInfo(Object object)

获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，请使用 getFileInfo() 接口。

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	文件路径
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
size	number	本地文件大小，单位 B
createTime	number	文件保存时的时间戳，从1970/01/01 08:00:00 到当前时间的秒数

示例代码

ft.getSavedFileList({success(res){ console.log(res.fileList)}})

# getFileInfo

基础库1.3.9开始支持，iOS版本2.1.23，Android版本2.1.38


getFileInfo(Object object)

获取文件信息。

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	本地文件路径
digestAlgorithm	string	'md5'	否	计算文件摘要的算法
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.digestAlgorithm 的合法值

值	说明
md5	md5 算法
sha1	sha1 算法

object.success 回调函数

参数

Object res

属性	类型	说明
size	number	本地文件大小，以字节为单位
digest	string	按照传入的 digestAlgorithm 计算得出的的文件摘要

示例代码

ft.getFileInfo({success(res){ console.log(res.size) console.log(res.digest)}})

# saveFileToDisk

保存文件系统的文件到用户磁盘，仅在 PC 端支持

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	待保存文件路径
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

ft.saveFileToDisk({filePath:`${ft.env.USER_DATA_PATH}/hello.txt`,success(res){ console.log(res)},fail(res){ console.error(res)}})

# getFileSystemManager

基础库 2.10.6 开始支持


getFileSystemManager()

获取全局唯一的文件管理器

返回值

FileSystemManager

文件管理器

# FileSystemManager.access

FileSystemManager.access(Object object)

判断文件/目录是否存在

参数

Object object

属性	类型	默认值	必填	说明
path	string		是	要判断是否存在的文件/目录路径 (本地路径)
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager()// 判断文件/目录是否存在 fs.access({path:`${ft.env.USER_DATA_PATH}/test.txt`,success(res){// 文件存在 console.log(res)},fail(res){// 文件不存在或其他错误 console.error(res)}})

# FileSystemManager.accessSync

FileSystemManager.accessSync(string path)

FileSystemManager.access的同步版本

参数

string path

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

示例代码

const fs = ft.getFileSystemManager()// 同步接口try{ fs.accessSync(`${ft.env.USER_DATA_PATH}/test.txt`)}catch(e){ console.error(e)}

# FileSystemManager.appendFile

FileSystemManager.appendFile(Object object)

在文件结尾追加内容

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	要追加内容的文件路径 (本地路径)
data	string/ArrayBuffer		是	要追加的文本或二进制数据
encoding	string	utf-8	否	指定写入文件的字符编码
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.encoding 的合法值

值	说明
base64
binary
utf-8
utf8

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.appendFile({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,data:'this is text',encoding:'utf-8',success(res){ console.log(res)},fail(res){ console.error(res)}})

# FileSystemManager.appendFileSync

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

FileSystemManager.appendFile的同步版本

参数

string filePath

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

string|ArrayBuffer data

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

string encoding

指定写入文件的字符编码

示例代码

// 同步接口const fs = ft.getFileSystemManager()try{ fs.appendFileSync(`${ft.env.USER_DATA_PATH}/test.txt`,'this is text','utf8')}catch(e){ console.error(e)}

# FileSystemManager.close

FileSystemManager.close(Object object)

关闭文件

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager()// 打开文件 fs.open({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+',success(res){// 关闭文件 fs.close({fd: res.fd })}})

# FileSystemManager.closeSync

FileSystemManager.closeSync(Object object)

同步关闭文件

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得

示例代码

const fs = ft.getFileSystemManager()const fd = fs.openSync({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+'})// 关闭文件 fs.closeSync({fd: fd })

# FileSystemManager.copyFile

FileSystemManager.copyFile(Object object)

复制文件

参数

Object object

属性	类型	默认值	必填	说明
srcPath	string		是	源文件路径，支持本地路径
destPath	string		是	目标文件路径，支持本地路径
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.copyFile({srcPath:`${ft.env.USER_DATA_PATH}/test-txt`,destPath:`${ft.env.USER_DATA_PATH}/new-test.txt`success(res){ console.log(res)},fail(res){ console.error(res)}})

# FileSystemManager.copyFileSync

FileSystemManager.copyFileSync(string srcPath, string destPath)

FileSystemManager.copyFile的同步版本

参数

string srcPath

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

string destPath

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

示例代码

const fs = ft.getFileSystemManager()// 同步接口try{ fs.copyFileSync(`${ft.env.USER_DATA_PATH}/test.txt`,`${ft.env.USER_DATA_PATH}/new-test.txt`)}catch(e){ console.error(e)}

# FileSystemManager.fstat

FileSystemManager.fstat(Object object)

获取文件的状态信息

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
stats	object	包含了文件的状态信息

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager()// 打开文件 fs.open({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+',success(res){// 获取文件的状态信息 fs.fstat({fd: res.fd,success(res){ console.log(res.stats)}})}})

# FileSystemManager.fstatSync

FileSystemManager.fstatSync(Object object)

同步获取文件的状态信息

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得

返回值

Object object

包含了文件的状态信息的对象

示例代码

const fs = ft.getFileSystemManager()const fd = fs.openSync({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+'})const stats = fs.fstatSync({fd: fd}) console.log(stats)

# FileSystemManager.ftruncate

FileSystemManager.ftruncate(Object object)

对文件内容进行截断操作

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
length	number		是	截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager()// 打开文件 fs.open({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+',success(res){// 对文件内容进行截断操作 fs.ftruncate({fd: res.fd,length:10,// 从第 10 个字节开始截断文件success(res){ console.log(res)}})}})

# FileSystemManager.ftruncateSync

FileSystemManager.ftruncateSync(Object object)

同步对文件内容进行截断操作

参数

Object object

属性	类型	默认值	必填	说明
fd	string		是	需要被关闭的文件描述符。fd 通过 FileSystemManager.open 或 FileSystemManager.openSync 接口获得
length	number		是	截断位置，默认0。如果 length 小于文件长度（单位：字节），则只有前面 length 个字节会保留在文件中，其余内容会被删除；如果 length 大于文件长度，则会对其进行扩展，并且扩展部分将填充空字节（'\0'）

返回值

undefined

示例代码

const fs = ft.getFileSystemManager()const fd = fs.openSync({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+'}) fs.ftruncateSync({fd: fd,length:10// 从第 10 个字节开始截断文件})

# FileSystemManager.getFileInfo

FileSystemManager.getFileInfo(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	要追加内容的文件路径 (本地路径)
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
size	number	文件大小，以字节为单位

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.getFileInfo({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,success(res){ console.log(res)},fail(res){ console.error(res)}})

# FileSystemManager.getSavedFileList

FileSystemManager.getSavedFileList(Object object)

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

参数

Object object

属性	类型	默认值	必填	说明
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性	类型	说明
fileList	Array.<Object>	文件数组，object 包含 filePath、size、createTime

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.getSavedFileList({success(res){ console.log(res)},fail(res){ console.error(res)}})

# FileSystemManager.mkdir

FileSystemManager.mkdir(Object object)

创建目录

参数

Object object

属性	类型	默认值	必填	说明
dirPath	string		是	创建的目录路径 (本地路径)
recursive	boolean	false	否	是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在，则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true，将创建 a 目录，再在 a 目录下创建 b 目录，以此类推直至创建 a/b/c 目录下的 d 目录。
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.mkdir({dirPath:`${ft.env.USER_DATA_PATH}/a/b/c`,recursive:falsesuccess(res){ console.log(res)},fail(res){ console.error(res)}})

# FileSystemManager.mkdirSync

FileSystemManager.mkdirSync(string dirPath, boolean recursive)

FileSystemManager.mkdirSync的同步版本

参数

string dirPath

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

boolean recursive

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

示例代码

const fs = ft.getFileSystemManager()// 同步接口try{ fs.mkdirSync(`${ft.env.USER_DATA_PATH}/a/b`,false)}catch(e){ console.error(e)}

# FileSystemManager.open

FileSystemManager.open(Object object)

打开文件，返回文件描述符

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	文件路径 (本地路径)
flag	string	r	否	文件系统标志，默认值: 'r'
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

object.flag 的合法值

值	说明
a	打开文件用于追加。 如果文件不存在，则创建该文件
ax	类似于 'a'，但如果路径存在，则失败
a+	打开文件用于读取和追加。 如果文件不存在，则创建该文件
ax+	类似于 'a+'，但如果路径存在，则失败
as	打开文件用于追加（在同步模式中）。 如果文件不存在，则创建该文件
as+	打开文件用于读取和追加（在同步模式中）。 如果文件不存在，则创建该文件
r	打开文件用于读取。 如果文件不存在，则会发生异常
r+	打开文件用于读取和写入。 如果文件不存在，则会发生异常
w	打开文件用于写入。 如果文件不存在则创建文件，如果文件存在则截断文件
wx	类似于 'w'，但如果路径存在，则失败
w+	打开文件用于读取和写入。 如果文件不存在则创建文件，如果文件存在则截断文件
wx+	类似于 'w+'，但如果路径存在，则失败

object.success 回调函数

参数

Object res

属性	类型	说明
fd	string	文件描述符

object.fail 回调函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

示例代码

const fs = ft.getFileSystemManager() fs.open({filePath:`${ft.env.USER_DATA_PATH}/test.txt`,flag:'a+',success(res){ console.log(res.fd)}})

# FileSystemManager.openSync

FileSystemManager.openSync(Object object)

同步打开文件，返回文件描述符

参数

Object object

属性	类型	默认值	必填	说明
filePath	string		是	文件路径 (本地路径)
flag	string	r	否	文件系统标志，默认值: 'r'

object.flag 的合法值

值	说明
a	打开文件用于追加。 如果文件不存在，则创建该文件
ax	类似于 'a'，但如果路径存在，则失败
a+	打开文件用于读取和追加。 如果文件不存在，则创建该文件
ax+	类似于 'a+'，但如果路径存在，则失败
as	打开文件用于追加（在同步模式中）。 如果文件不存在，则创建该文件
as+	打开文件用于读取和追加（在同步模式中）。 如果文件不存在，则创建该文件
r	打开文件用于读取。 如果文件不存在，则会发生异常
r+	打开文件用于读取和写入。 如果文件不存在，则会发生异常
w	打开文件用于写入。 如果文件不存在则创建文件，如果文件存在则截断文件
wx	类似于 'w'，但如果路径存在，则失败
w+	打开文件用于读取和写入。 如果文件不存在则创建文件，如果文件存在则截断文件
wx+	类似于 'w+'，但如果路径存在，则失败

返回值

string

文件描述符


…(内容过长已截断)

------
导航页 打开网址