跳到主要内容
版本：v6

@capacitor/filesystem

Filesystem API 提供了类似 NodeJS 的 API，用于在设备上处理文件。

安装​

npm install @capacitor/filesystem
npx cap sync

苹果隐私清单要求​

苹果要求应用开发者现在必须说明 API 使用的批准原因以增强用户隐私。到 2024 年 5 月 1 日，提交应用到 App Store Connect 时必须包含这些原因。

当在应用中使用此特定插件时，必须在 /ios/App 中创建 PrivacyInfo.xcprivacy 文件或使用 VS Code 扩展生成它，并指定使用原因。

有关如何执行此操作的详细步骤，请参阅 Capacitor 文档。

对于此插件，必需的字典键是 NSPrivacyAccessedAPICategoryFileTimestamp，推荐的原因是 C617.1。

示例 PrivacyInfo.xcprivacy​

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>NSPrivacyAccessedAPITypes</key>
    <array>
      <!-- 如果 PrivacyInfo 文件已存在，请将此字典条目添加到数组中 -->
      <dict>
        <key>NSPrivacyAccessedAPIType</key>
        <string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
        <key>NSPrivacyAccessedAPITypeReasons</key>
        <array>
          <string>C617.1</string>
        </array>
      </dict>
    </array>
  </dict>
</plist>

iOS​

要使文件出现在文件应用中，还必须在 Info.plist 中将以下键设置为 YES：

  • UIFileSharingEnabled (应用程序支持 iTunes 文件共享)
  • LSSupportsOpeningDocumentsInPlace (支持就地打开文档)

请阅读 配置 iOS 以获取帮助。

Android​

如果使用 Directory.Documents 或 Directory.ExternalStorage，在 Android 10 及更早版本中，此 API 要求将以下权限添加到 AndroidManifest.xml：

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

有关设置 Android 权限的更多信息，请阅读 Android 指南中的设置权限。

请注意，Directory.ExternalStorage 仅在 Android 9 或更早版本上可用，而 Directory.Documents 在 Android 11 及更新版本上仅允许访问应用创建的文件/文件夹。

处理大文件可能需要在 AndroidManifest.xml 的 <application> 标签中添加 android:largeHeap="true"。

理解目录和文件​

iOS 和 Android 在文件之间有额外的分离层，例如备份到云的特殊目录，或用于存储文档的目录。Filesystem API 提供了一种简单的方法，将每个操作限定在设备上的特定特殊目录。

此外，Filesystem API 支持使用完整的 file:// 路径，或在 Android 上读取 content:// 文件。只需省略 directory 参数即可使用完整文件路径。

示例​

import { Filesystem, Directory, Encoding } from '@capacitor/filesystem';

const writeSecretFile = async () => {
  await Filesystem.writeFile({
    path: 'secrets/text.txt',
    data: '这是一个测试',
    directory: Directory.Documents,
    encoding: Encoding.UTF8,
  });
};

const readSecretFile = async () => {
  const contents = await Filesystem.readFile({
    path: 'secrets/text.txt',
    directory: Directory.Documents,
    encoding: Encoding.UTF8,
  });

  console.log('秘密:', contents);
};

const deleteSecretFile = async () => {
  await Filesystem.deleteFile({
    path: 'secrets/text.txt',
    directory: Directory.Documents,
  });
};

const readFilePath = async () => {
  // 这是一个读取完整文件路径的文件的示例。使用它来
  // 从返回文件 URI 的插件（例如相机）读取二进制数据（base64 编码）。
  const contents = await Filesystem.readFile({
    path: 'file:///var/mobile/Containers/Data/Application/22A433FD-D82D-4989-8BE6-9FC49DEA20BB/Documents/text.txt',
  });

  console.log('数据:', contents);
};

API​

readFile(...)​

readFile(options: ReadFileOptions) => Promise<ReadFileResult>

从磁盘读取文件

参数类型
options
ReadFileOptions

返回值： 

Promise<ReadFileResult>

Since: 1.0.0

writeFile(...)​

writeFile(options: WriteFileOptions) => Promise<WriteFileResult>

将文件写入设备上的指定位置

参数类型
options
WriteFileOptions

返回值： 

Promise<WriteFileResult>

Since: 1.0.0

appendFile(...)​

appendFile(options: AppendFileOptions) => Promise<void>

在设备上的指定位置追加文件内容

参数类型
options
AppendFileOptions

Since: 1.0.0

deleteFile(...)​

deleteFile(options: DeleteFileOptions) => Promise<void>

从磁盘删除文件

参数类型
options
DeleteFileOptions

Since: 1.0.0

mkdir(...)​

mkdir(options: MkdirOptions) => Promise<void>

创建目录。

参数类型
options
MkdirOptions

Since: 1.0.0

rmdir(...)​

rmdir(options: RmdirOptions) => Promise<void>

移除目录

参数类型
options
RmdirOptions

Since: 1.0.0

readdir(...)​

readdir(options: ReaddirOptions) => Promise<ReaddirResult>

返回目录中的文件列表（非递归）

参数类型
options
ReaddirOptions

返回值： 

Promise<ReaddirResult>

Since: 1.0.0

getUri(...)​

getUri(options: GetUriOptions) => Promise<GetUriResult>

返回路径和目录的完整文件 URI

参数类型
options
GetUriOptions

返回值： 

Promise<GetUriResult>

Since: 1.0.0

stat(...)​

stat(options: StatOptions) => Promise<StatResult>

返回文件的数据信息

参数类型
options
StatOptions

返回值： 

Promise<StatResult>

Since: 1.0.0

rename(...)​

rename(options: RenameOptions) => Promise<void>

重命名文件或目录

参数类型
options
CopyOptions

Since: 1.0.0

copy(...)​

copy(options: CopyOptions) => Promise<CopyResult>

复制文件或目录

参数类型
options
CopyOptions

返回值： 

Promise<CopyResult>

Since: 1.0.0

checkPermissions()​

checkPermissions() => Promise<PermissionStatus>

检查读/写权限。 仅在 Android 上使用 Directory.Documents 或 Directory.ExternalStorage 时需要。

返回值： 

Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()​

requestPermissions() => Promise<PermissionStatus>

请求读/写权限。 仅在 Android 上使用 Directory.Documents 或 Directory.ExternalStorage 时需要。

返回值： 

Promise<PermissionStatus>

Since: 1.0.0

downloadFile(...)​

downloadFile(options: DownloadFileOptions) => Promise<DownloadFileResult>

向服务器执行 HTTP 请求并将文件下载到指定目标。

参数类型
options
DownloadFileOptions

返回值： 

Promise<DownloadFileResult>

Since: 5.1.0

addListener('progress', ...)​

addListener(eventName: 'progress', listenerFunc: ProgressListener) => Promise<PluginListenerHandle>

添加文件下载进度事件的监听器。

参数类型
eventName'progress'
listenerFunc
ProgressListener

返回值： 

Promise<PluginListenerHandle>

Since: 5.1.0

removeAllListeners()​

removeAllListeners() => Promise<void>

移除此插件的所有监听器。

Since: 5.2.0

接口​

ReadFileResult​

属性类型描述Since
datastring | Blob文件中包含的数据表示形式 注意：Blob 仅在 Web 上可用。在原生平台上，数据以字符串形式返回。1.0.0

ReadFileOptions​

属性类型描述Since
pathstring要读取的文件路径1.0.0
directory
Directory
从中读取文件的 Directory1.0.0
encoding
Encoding
读取文件的编码方式，如果未提供，数据将作为二进制读取并以 base64 编码返回。传递 Encoding.UTF8 以字符串形式读取数据1.0.0

WriteFileResult​

属性类型描述Since
uristring文件写入的 uri1.0.0

WriteFileOptions​

属性类型描述默认值Since
pathstring要写入的文件路径1.0.0
datastring | Blob要写入的数据 注意：Blob 数据仅在 Web 上受支持。1.0.0
directory
Directory
存储文件的 Directory1.0.0
encoding
Encoding
写入文件的编码方式。如果未提供，数据将以 base64 编码写入。传递 Encoding.UTF8 以字符串形式写入数据1.0.0
recursiveboolean是否创建任何缺失的父目录。false1.0.0

AppendFileOptions​

属性类型描述Since
pathstring要追加的文件路径1.0.0
datastring要写入的数据1.0.0
directory
Directory
存储文件的 Directory1.0.0
encoding
Encoding
写入文件的编码方式。如果未提供，数据将以 base64 编码写入。传递 Encoding.UTF8 以字符串形式写入数据1.0.0

DeleteFileOptions​

属性类型描述Since
pathstring要删除的文件路径1.0.0
directory
Directory
从中删除文件的 Directory1.0.0

MkdirOptions​

属性类型描述默认值Since
pathstring新目录的路径1.0.0
directory
Directory
创建新目录的 Directory1.0.0
recursiveboolean是否同时创建任何缺失的父目录。false1.0.0

RmdirOptions​

属性类型描述默认值Since
pathstring要移除的目录路径1.0.0
directory
Directory
从中移除目录的 Directory1.0.0
recursiveboolean是否递归移除目录的内容。false1.0.0

ReaddirResult​

属性类型描述Since
filesFileInfo[]目录内的文件和目录列表1.0.0

FileInfo​

属性类型描述Since
namestring文件或目录的名称。
type'file' | 'directory'文件类型。4.0.0
sizenumber文件大小（字节）。4.0.0
ctimenumber创建时间（毫秒）。在 Android 7 及更早设备上不可用。4.0.0
mtimenumber最后修改时间（毫秒）。4.0.0
uristring文件的 uri。4.0.0

ReaddirOptions​

属性类型描述Since
pathstring要读取的目录路径1.0.0
directory
Directory
从中列出文件的 Directory1.0.0

GetUriResult​

属性类型描述Since
uristring文件的 uri1.0.0

GetUriOptions​

属性类型描述Since
pathstring要获取 URI 的文件路径1.0.0
directory
Directory
文件所在的 Directory1.0.0

StatResult​

属性类型描述Since
type'file' | 'directory'文件类型。1.0.0
sizenumber文件大小（字节）。1.0.0
ctimenumber创建时间（毫秒）。在 Android 7 及更早设备上不可用。1.0.0
mtimenumber最后修改时间（毫秒）。1.0.0
uristring文件的 uri1.0.0

StatOptions​

属性类型描述Since
pathstring要获取数据的文件路径1.0.0
directory
Directory
文件所在的 Directory1.0.0

CopyOptions​

属性类型描述Since
fromstring现有文件或目录1.0.0
tostring目标文件或目录1.0.0
directory
Directory
包含现有文件或目录的 Directory1.0.0
toDirectory
Directory
包含目标文件或目录的 Directory。如果未提供，将使用 'directory' 参数作为目标1.0.0

CopyResult​

属性类型描述Since
uristring文件复制到的 uri4.0.0

PermissionStatus​

属性类型
publicStorage
PermissionState

DownloadFileResult​

属性类型描述Since
pathstring文件下载到的路径。5.1.0
blobBlob下载文件的 blob 数据。这仅在 Web 上可用。5.1.0

DownloadFileOptions​

属性类型描述默认值Since
pathstring下载文件应移动到的路径。5.1.0
directory
Directory
写入文件的目录。如果使用此选项，filePath 可以是相对路径而不是绝对路径。默认为 DATA 目录。5.1.0
progressboolean一个可选的监听器函数，用于接收下载进度事件。如果使用此选项，应在每个接收到的数据块上分派进度事件。在 Android/iOS 上，数据块限制为每 100ms 一次以避免速度减慢。5.1.0
recursiveboolean是否创建任何缺失的父目录。false5.1.2

PluginListenerHandle​

属性类型
remove() => Promise<void>

ProgressStatus​

属性类型描述Since
urlstring正在下载的文件的 url。5.1.0
bytesnumber到目前为止下载的字节数。5.1.0
contentLengthnumber此文件要下载的总字节数。5.1.0

类型别名​

RenameOptions​

CopyOptions

PermissionState​

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

ProgressListener​

接收进度事件的监听器函数。

(progress: ProgressStatus): void

枚举​

Directory​

成员值描述Since
Documents'DOCUMENTS'文档目录。在 iOS 上是应用的文档目录。使用此目录存储用户生成的内容。在 Android 上是公共文档文件夹，因此其他应用可以访问。在 Android 10 上不可访问，除非应用通过在 AndroidManifest.xml 的 application 标签中添加 android:requestLegacyExternalStorage="true" 来启用旧版外部存储。在 Android 11 或更新版本上，应用只能访问应用创建的文件/文件夹。1.0.0
Data'DATA'数据目录。在 iOS 上将使用文档目录。在 Android 上是保存应用文件的目录。应用卸载时文件将被删除。1.0.0
Library'LIBRARY'库目录。在 iOS 上将使用库目录。在 Android 上是保存应用文件的目录。应用卸载时文件将被删除。1.1.0
Cache'CACHE'缓存目录。在内存不足的情况下可以被删除，因此使用此目录写入应用特定的文件，您的应用可以轻松重新创建。1.0.0
External'EXTERNAL'外部目录。在 iOS 上将使用文档目录。在 Android 上是主共享/外部存储设备上的目录，应用可以在其中放置其拥有的持久文件。这些文件是应用内部的，通常对用户不可见。应用卸载时文件将被删除。1.0.0
ExternalStorage'EXTERNAL_STORAGE'外部存储目录。在 iOS 上将使用文档目录。在 Android 上是主共享/外部存储目录。在 Android 10 上不可访问，除非应用通过在 AndroidManifest.xml 的 application 标签中添加 android:requestLegacyExternalStorage="true" 来启用旧版外部存储。在 Android 11 或更新版本上不可访问。1.0.0

Encoding​

成员值描述Since
UTF8'utf8'八位 UCS 转换格式1.0.0
ASCII'ascii'七位 ASCII，又称 ISO646-US，又称 Unicode 字符集的基本拉丁块 此编码仅在 Android 上受支持。1.0.0
UTF16'utf16'十六位 UCS 转换格式，字节顺序由可选的字节顺序标记标识 此编码仅在 Android 上受支持。1.0.0

Contents

编辑此页