diff --git "a/zh-cn/readme/figures/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.png" "b/zh-cn/readme/figures/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.png" deleted file mode 100644 index e3763b766aff5cf1c80c31a0ea17c527a9f70a8f..0000000000000000000000000000000000000000 Binary files "a/zh-cn/readme/figures/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.png" and /dev/null differ diff --git "a/zh-cn/readme/figures/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.jpg" "b/zh-cn/readme/figures/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.jpg" new file mode 100644 index 0000000000000000000000000000000000000000..6192e8551f272d4e7e8eb08f8b42367a9c253a9d Binary files /dev/null and "b/zh-cn/readme/figures/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237\346\236\266\346\236\204\345\233\276.jpg" differ diff --git "a/zh-cn/readme/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237.md" "b/zh-cn/readme/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237.md" deleted file mode 100644 index 08da8aa66e7763461b8abf86bb09d284d22c43d6..0000000000000000000000000000000000000000 --- "a/zh-cn/readme/\345\210\206\345\270\203\345\274\217\346\226\207\344\273\266\345\255\220\347\263\273\347\273\237.md" +++ /dev/null @@ -1,236 +0,0 @@ -# 分布式文件子系统 - -- [简介](#section104mcpsimp) - - [系统架构](#section110mcpsimp) - -- [目录结构](#section113mcpsimp) -- [约束](#section117mcpsimp) -- [说明](#section125mcpsimp) - - [接口说明](#section127mcpsimp) - - [使用说明](#section149mcpsimp) - -- [相关仓](#section178mcpsimp) - -## 简介 - -分布式文件子系统当前向应用程序提供用于的 IO 的 JS 接口。其具体包括用于管理文件的基本文件接口，用于管理目录的基本目录接口，用于获取文件信息的统计接口，用于流式读写文件的流式接口，以及接收 URI 而非绝对路径的沙盒接口。 - -### 系统架构 - -当前分布式文件子系统仅面向应用提供本地 JS 文件接口，这些接口分别通过 FileIO 模块以及 File 模块提供。架构上，分布式文件子系统实现了自研的 LibN，其抽象了 NAPI 层接口，向分布式文件子系统提供包括基本类型系统、内存管理、通用编程模型在内的基本能力。本系统对外依赖 JS 开发框架提供将 JS 接口转换为 C++ 代码的能力，依赖用户程序框架提供应用相关目录，依赖 GLIBC Runtimes 提供 IO 能力。 - -**图 1** 分布式文件子系统架构图 -![](figures/分布式文件子系统架构图.png "分布式文件子系统架构图") - -## 目录结构 - -``` -foundation/distributeddatamgr/distributedfile -├── interfaces # 接口层代码 -│ └── kits # 对外接口 -``` - -## 约束 - -本地 IO 接口 - -- 目前仅支持 UTF-8/16 编码； -- 目前 URI 暂不支持外部存储目录； - -## 说明 - -### 接口说明 - -当前分布式文件子系统开放本地文件目录访问接口，按照功能，其可划分为如下几种类型： - -**表 1** 接口类型表 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

接口类型

-

接口用途

-

相关模块

-

接口示例（类名.方法名）

-

基本文件接口

-

需要用户提供绝对路径或文件描述符（fd），提供创建、修改及访问文件，或修改文件权限的能力

-

@ohos.distributedfile.fileio

-

accessSync

-

chownSync

-

chmodSync

-

基本目录接口

-

需要用户提供绝对路径，提供读取目录及判断文件类型的能力

-

@ohos.distributedfile.fileio

-

Dir.openDirSync

-

基本Stat接口

-

需要用户提供绝对路径，提供包括文件大小、访问权限、修改时间在内的基本统计信息

-

@ohos.distributedfile.fileio

-

Stat.statSync

-

流式文件接口

-

需要用户提供绝对路径或文件描述符，提供流式读写文件的能力

-

@ohos.distributedfile.fileio

-

Stream.createStreamSync

-

Stream.fdopenStreamSync

-

沙盒文件接口

-

需要用户提供 URI，提供基本文件接口、基本目录接口及基本统计接口能力的子集能力，或这些能力的组合能力

-

@system.file

-

move

-

copy

-

list

-
- - -### 使用说明 - -当前分布式文件子系统所提供的 IO 接口，按照编程模型，可划分为如下几种类型： - -- 同步编程模型 - - 名称包含 Sync 的接口实现为同步模型。用户在调用这些接口的时候，将同步等待，直至执行完成，执行结果以函数返回值的形式返回。 - - 下例以只读的方式打开一个文件流，接着试图读取其中前 4096 个字节并将之转换为 UTF-8 编码的字符串，最后关闭该文件流。 - - ``` - import fileio from '@ohos.distributedfile.fileio'; - - try { - var ss = fileio.Stream.createStreamSync("tmp", "r") - buf = new ArrayBuffer(4096) - ss.readSync(buf) - console.log(String.fromCharCode.apply(null, new Uint8Array(buf))) - ss.closeSync() - } - catch (e) { - console.log(e); - } - ``` - - -- 异步编程模型：Promise - - @ohos.distributedfile.fileio 模块中，名称不含 Sync 的接口，在不提供最后一个函数型参数 callback 的时候，即实现为 Promise 异步模型。Promise 异步模型是 ohos 标准异步模型之一。用户在调用这些接口的时候，接口实现将异步执行任务，同时返回一个 promise 对象，其代表异步操作的结果。在返回的结果的个数超过一个时，其以对象属性的形式返回。 - - 下例通过 Promise 链依次完成：以只读方式打开文件流、尝试读取文件前 4096 个字节、显示读取内容的长度，最后关闭文件。 - - ``` - import fileio from '@ohos.distributedfile.fileio'; - - try { - let openedStream - fileio.Stream.createStream("test.txt", "r") - .then(function (ss) { - openedStream = ss; - return ss.read(new ArrayBuffer(4096)) - }) - .then(function (res) { - console.log(res.bytesRead); - console.log(String.fromCharCode.apply(null, new Uint8Array(res.buffer))) - return openedStream.close() - }) - .then(function (undefined) { - console.log("Stream is closed") - }) - .catch(function (e) { - console.log(e) - }) - } catch (e) { - console.log(e) - } - ``` - - -- 异步编程模型：Callback - - @ohos.distributedfile.fileio 模块中，名字不含 Sync 的接口，在提供最后一个函数性参数 callback 的时候，即实现为 Callback 异步模型。Callback 异步模型是 ohos 标准异步模型之一。用户在调用这些接口的时候，接口实现将异步执行任务。任务执行结果以参数的形式提供给用户注册的回调函数。这些参数的第一个是 Error 或 undefined 类型，分别表示执行出错与正常。 - - 下例异步创建文件流，并在文件流的回调函数中异步读取文件的前 4096 字节，接着在读取文件的回调函数中异步关闭文件。 - - ``` - import fileio from '@ohos.distributedfile.fileio'; - - try { - fileio.Stream.createStream("./testdir/test_stream.txt", "r", function (err, ss) { - if (!err) { - ss.read(new ArrayBuffer(4096), {}, function (err, buf, readLen) { - if (!err) { - console.log('readLen: ' + readLen) - console.log('data: ' + String.fromCharCode.apply(null, new Uint8Array(buf))) - } else { - console.log('Cannot read from the stream ' + err) - } - ss.close(function (err) { - console.log(`Stream is ${err ? 'not' : ''}closed`) - }); - }) - } else { - console.log('Cannot open the stream ' + err) - } - }) - } catch (e) { - console.log(e) - } - ``` - - -- 异步编程模型：Legacy - - @system.file 模块中的所有接口都实现为 Legacy 异步模型。用户在调用这些接口的时候，需要提供 success、fail 及 complete 三个回调。在正确提供参数的情况下，当异步任务完成后，接口会根据是否成功，分别调用 success 回调或 fail 回调，并最终调用 complete 回调。 - - 下例异步判断 URI 所指向的文件是否存在，并相应提供三个回调用于打印判断结果。 - - ``` - import file from '@system.file' - - file.access({ - uri: 'internal://app/test.txt', - success: function() { - console.log('call access success.'); - }, - fail: function(data, code) { - console.error('call fail callback fail, code: ' + code + ', data: ' + data); - }, - complete: function () { - console.log('call access finally.'); - } - }); - - console.log("file access tested done") - ``` - - -## 相关仓 - -**分布式文件** - -distributeddatamgr\_distributedfile - diff --git "a/zh-cn/readme/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237.md" "b/zh-cn/readme/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237.md" new file mode 100644 index 0000000000000000000000000000000000000000..54361e43cb60a5f154a611efe0703a5b6e350887 --- /dev/null +++ "b/zh-cn/readme/\346\226\207\344\273\266\347\256\241\347\220\206\345\255\220\347\263\273\347\273\237.md" @@ -0,0 +1,51 @@ +# 文件管理子系统 + +## 简介 + +文件管理子系统为OpenHarmony提供一套完整的文件数据管理解决方案，提供安全、易用的文件访问能力和完善的文件存储管理能力，包括： + +1. 为应用提供安全的沙箱隔离技术，保证应用数据安全基础上权限最小化； +2. 统一的公共文件管理能力，统一公共数据访问入库，保证用户数据安全、纯净； +3. 分布式文件系统和云接入文件系统访问框架，应用可以像使用本地文件一样使用分布式和云端文件； +4. 支持公共数据、跨应用、跨设备的系统级文件分享能力； +5. 提供系统的存储管理能力和基础文件系统能力。 + +**图 1** 文件管理子系统架构图 +![](figures/文件管理子系统架构图.jpg "文件管理子系统架构图") + +文件管理子系统对应用提供文件访问框架、文件分享框架、存储管理框架能力。 + +| 模块 | 详细描述 | +| ------------ | ------------------------------------------------------------ | +| 文件访问接口 | 1. 提供完整文件JS 接口，支持基础文件访问能力；
2. 提供本地文件、分布式文件和云端文件扩展接口。 | +| 存储管理 | 1. 提供数据备份恢复框架能力，支持系统和应用数据备份克隆等场景；
2. 提供应用空间清理和统计、配额管控等空间管理能力；
3. 提供挂载管理、外卡管理、设备管理及多用户管理等存储存储管理能力。 | +| 公共文件 | 1. 公共数据沙箱隔离，保证用户数据安全、纯净；
2. 统一公共数据访问入口，仅medialibrary；
3. 提供统一的FMF的文件管理框架；
4. 支持分布式和端云能力。 | +| 应用文件 | 1. 为应用提供安全的沙箱隔离技术，保证应用数据安全基础上权限最小化；
2. 支持应用间文件分享和文件跨设备分享，支持群组分享；
3. 应用可以像使用本地文件一样使用分布式和云端文件。 | +| 分布式能力 | 1. 提供基础分布式跨端访问能力，支持同账号分布式访问和异账号临时访问；
2. 支持端云协同能力，用户和应用无感数据位置；
3. 支持文件跨端迁移能力，支撑应用迁移、分布式剪切板等分布式场景。 | +| 基础文件系统 | 1. 支持ext4、f2fs、exfat、ntfs等本地文件系统；
2. 支持分布式文件系统、nfs等网络文件系统；
3. 文件系统相关工具。 | + + +## 相关仓 + +公共文件管理 + +[filemanagement_user_file_service](https://gitee.com/openharmony/filemanagement_user_file_service) + +应用文件管理 + +[filemanagement_app_file_service](https://gitee.com/openharmony/filemanagement_app_file_service) + +文件接口 + +[filemanagement_file_api](https://gitee.com/openharmony/filemanagement_file_api) + +[distributeddatamgr_file](https://gitee.com/openharmony/distributeddatamgr_file) + +存储管理 + +[filemanagement_storage_service](https://gitee.com/openharmony/filemanagement_storage_service) + +分布式文件 + + [filemanagement_dfs_service](https://gitee.com/openharmony/filemanagement_dfs_service) +