UniApp 操作文件 API 全解析
本文详细讲解 UniApp 提供的操作文件相关 API，包括参数说明、使用场景和简要示例代码，帮助开发者快速掌握文件操作。
1. 获取文件信息
uni.getFileInfo
获取指定文件的信息（如文件大小或 MD5 值）。
-
参数说明
参数 类型 必填 默认值 说明 filePath string 是 无 文件路径 digestAlgorithm string 否 md5 算法类型(md5/sha1) success function 否 无 成功回调函数 fail function 否 无 失败回调函数 complete function 否 无 完成回调函数 -
示例代码
uni.getFileInfo({
filePath: '/path/to/file',
digestAlgorithm: 'md5',
success: (res) => {
console.log('文件大小：', res.size);
console.log('文件md5：', res.digest);
},
fail: (err) => console.error('获取失败', err),
});
2. 保存文件
uni.saveFile
将临时文件保存到本地，生成一个永久有效的文件路径。
-
参数说明
参数 类型 必填 默认值 说明 tempFilePath string 是 无 临时文件路径 success function 否 无 成功回调函数 fail function 否 无 失败回调函数 complete function 否 无 完成回调函数 -
示例代码
uni.saveFile({
tempFilePath: '/path/to/temp/file',
success: (res) => {
console.log('文件保存路径：', res.savedFilePath);
},
fail: (err) => console.error('保存失败', err),
});
3. 打开文档
uni.openDocument
用于打开本地文档文件。支持格式包括 PDF、Word、Excel 等。
-
参数说明
参数 类型 必填 默认值 说明 filePath string 是 无 文件路径 fileType string 否 无 文件类型（如 pdf） success function 否 无 成功回调函数 fail function 否 无 失败回调函数 complete function 否 无 完成回调函数 -
示例代码
uni.openDocument({
filePath: '/path/to/document.pdf',
success: () => console.log('文档打开成功'),
fail: (err) => console.error('打开失败', err),
});
4. 删除文件
uni.removeSavedFile
删除已保存到本地的文件。
-
参数说明
参数 类型 必填 默认值 说明 filePath string 是 无 文件路径 success function 否 无 成功回调函数 fail function 否 无 失败回调函数 complete function 否 无 完成回调函数 -
示例代码
uni.removeSavedFile({
filePath: '/path/to/file',
success: () => console.log('文件删除成功'),
fail: (err) => console.error('删除失败', err),
});
5. 获取已保存文件列表
uni.getSavedFileList
获取所有已保存的本地文件列表及其信息。
- 示例代码
uni.getSavedFileList({
success: (res) => {
console.log('文件列表：', res.fileList);
},
fail: (err) => console.error('获取失败', err),
});
6. 获取文件管理器对象
uni.getFileSystemManager
获取一个文件管理器对象，用于调用更底层的文件操作 API。
- 示例代码
const fs = uni.getFileSystemManager();
fs.readFile({
filePath: '/path/to/file',
encoding: 'utf8',
success: (res) => console.log('文件内容：', res.data),
fail: (err) => console.error('读取失败', err),
});
总结
UniApp 提供的操作文件 API，覆盖了文件读取、保存、删除、打开文档等场景，能够满足多数文件操作需求。本文简明地列出了每个 API 的参数和使用示例，帮助开发者快速理解与使用。更多细节可参考 官方文档。
