选择应用类型
第三方个人应用开发
开发前必读
开发应用
应用管理
服务端API
客户端API
小程序
钉钉小程序介绍
小程序开发工具
小程序运行/更新机制
框架
基础组件
小程序JSAPI
JSAPI总览
基础
免登授权码
更新管理小程序
网络
多媒体
界面
小程序跳转
节点查询
位置
缓存
设备
地图
应用级事件
文件管理器
概述
文件管理器JSAPI
开放接口
钉钉统一授权套件
常见问题
历史文档

概述

更新于 2023-01-18本文介绍了什么是文件管理器,文件管理器可用功能概览以及文件管理器相关概念。

什么是文件管理器

钉钉小程序提供了一套小程序代码包文件和用户本地文件的文件存储管理接口,即FileSystemManager文件管理器,它可以通过dd.getFileSystemManager获取,再通过调用FileSystemManager管理所有文件系统。

文件管理器可用功能概览

通过全局唯一的文件系统管理器(FileSystemManager),可以对所有文件系统进行管理操作。

名称

功能说明

创建本地用户目录

调用FileSystemManager.mkdir,创建本地用户目录。

判断文件或目录是否存在

调用FileSystemManager.access,判断文件或者目录是否存在。

保存文件

调用FileSystemManager.saveFile,将本地临时文件保存为本地缓存文件或本地用户文件。

获取文件信息

调用FileSystemManager.getFileInfo,获取本地临时文件、本地缓存文件和本地用户文件的信息。

获取本地用户文件和目录列表

调用FileSystemManager.readdir,获取本地用户文件列表。

获取文件或目录的status对象

调用FileSystemManager.stat,获取文件或目录的status对象。

获取本地缓存文件列表

调用FileSystemManager.getSavedFileList,获取本地缓存文件列表。

读取本地用户文件内容

调用FileSystemManager.readFile,读取本地用户文件的内容。

删除本地用户文件目录

调用FileSystemManager.rmdir,删除本地用户文件目录。

删除本地用户文件

调用FileSystemManager.unlink,删除本地用户文件。

删除本地缓存文件

调用FileSystemManager.removeSavedFile,删除本地缓存文件。

复制文件保存到本地用户目录内

调用FileSystemManager.copyFile,复制文件保存到本地用户目录。

重命名并移动本地用户文件或目录

调用FileSystemManager.rename,重命名本地用户文件或目录的名称并且可以移动到新目录下。

向本地用户目录写入文件

调用FileSystemManager.writeFile,向本地用户目录内写入文件。

向本地用户文件末尾添加内容

调用FileSystemManager.appendFile,向本地用户文件末尾添加内容。

解压本地用户文件

调用FileSystemManager.unzip,解压本地用户文件。

名词解释

本地文件

本地文件是指小程序被用户添加到手机后,以用户维度隔离,有一块独立的文件存储区域。即同一台手机,仅支持每个手机用户访问自己登录账号下的文件,不支持访问其它登录用户的文件,同一个用户不同小程序之间的文件也不能互相访问。 本地文件的文件路径格式为{{协议名}}://文件路径,其中协议名通常为https,但开发者无需关注此点,也不需在代码中体现完整文件路径。

说明

为了安全考虑,本地文件是钉钉分配给用户的沙盒文件,和用户文件系统隔离,小程序开发者可以通过文件管理器的接口来访问,但用户无法在手机文件系统中直接访问。

本地文件可分为本地临时文件、本地缓存文件和本地用户文件。

本地临时文件

  • 本地临时文件只能通过特定接口产生,不能直接写入内容。本地临时文件通过文件虚拟协议https://resource操作。

  • 本地临时文件产生后,仅在当前生命周期内保证有效,重启之后不一定可用。并且一旦小程序被完全关闭就被清理,即下次冷启动小程序时不可继续使用。

  • 如果需要保证在下次启动是无需下载,可通过保存文件接口将本地临时文件转换为本地缓存文件或本地用户文件。

  • 在下载临时文件时,可先通过判断文件或目录是否存在接口检查文件是否存在,减少重复文件下载,提升用户体验。

  • 支持产生本地临时文件的API有:

本地缓存文件

  • 本地缓存文件只能通过调用特定接口产生,不能直接写入内容,本地缓存文件通过文件虚拟协议https://resource操作。

  • 本地缓存文件产生后,重启小程序之后仍可用。

  • 本地缓存文件只能通过保存文件(不指定filePath)接口将本地临时文件保存获取。

  • 单个本地缓存文件最大限制是10MB。

  • 本地缓存文件和本地用户文件共计最多可存储50MB文件,若超出该大小,可通过删除本地缓存文件接口删除本地缓存文件。

  • 支持产生本地缓存文件的API有:

    • 保存文件(不传filePath),将本地临时文件保存为本地缓存文件。

本地用户文件

  • 本地用户文件通过文件虚拟协议https://usr操作。

  • 本地用户文件是指钉钉提供了一个用户文件目录给开发者,开发者对这个目录有完全自由的读写权限,通过dd.env.USER_DATA_PATH可以获取到这个目录的路径。

  • 单个本地用户文件最大限制是10MB。

  • 本地用户文件与本地缓存文件共计最多可存储50MB文件,若超过该大小,可通过删除本地缓存文件接口删除本地缓存文件或删除本地用户文件接口删除本地用户文件。

  • 支持产生本地用户文件的API有:

读写权限

接口、组件

读权限

写权限

本地临时文件

本地缓存文件

本地用户文件

清理策略

小程序退出后,系统会检查该小程序的临时文件占用。如占用超过限制,临时文件会被优先删除,因此本地临时文件只能保证在小程序当前生命周期内可用,一旦小程序被关闭就可能被清理,下次冷启动不保证可用。 本地缓存文件和本地用户文件的清理时机,只有在代码包被清理的时候会被清理。如果本地缓存文件和本地用户文件占用达到限制,此时无法写入新文件,需要开发者手动清理。

点击纠错