README.md · hos-learning/filemanagement_file_api

# File Api<a name="EN-US_TOPIC_0000001101541814"></a>

-   [Introduction](#section104mcpsimp)
    -   [Architecture](#section110mcpsimp)

-   [Directory](#section113mcpsimp)
-   [Constraints](#section117mcpsimp)
-   [Usage](#section125mcpsimp)
    -   [Available APIs](#section127mcpsimp)
    -   [Usage Guidelines](#section149mcpsimp)

-   [Repositories Involved](#section178mcpsimp)

## Introduction<a name="section104mcpsimp"></a>

Currently, the File Api provides apps with JavaScript APIs for I/O capabilities, including APIs for managing files and directories, obtaining file information, reading and writing data streams of files, and receiving URIs rather than absolute paths.

### Architecture<a name="section110mcpsimp"></a>

Currently, the File Api provides only local JavaScript file APIs for apps through the FileIO and File modules. The File Api uses LibN to abstract APIs at the NAPI layer, providing basic capabilities such as the basic type system, memory management, and general programming models for the subsystem. This subsystem depends on the engine layer of the JS application development framework to provide the capability of converting JavaScript APIs into C++ code, depends on the application framework to provide app-related directories, and depends on the GLIBC runtimes to provide I/O capabilities.

**Figure 1** File Api architecture<a name="fig174088216114"></a> 
![](figures/file-api-architecture.png "file-api-architecture.png")

## Directory<a name="section113mcpsimp"></a>

```
foundation/filemanagement/file_api
├── figures                     # Figures
├── interfaces                  # APIs
├    └── kits                   # APIs exposed externally
├── utils                       # Common Components
├    └── filemgmt_libhilog      # Log Components
├    └── filemgmt_libn          # Platform related components
```

## Constraints<a name="section117mcpsimp"></a>

Constraints on local I/O APIs:

-   Only UTF-8/16 encoding is supported.
-   The URIs cannot include external storage directories.

## Usage<a name="section125mcpsimp"></a>

### Available APIs<a name="section127mcpsimp"></a>

Currently, the File Api provides APIs for accessing local files and directories. The following table describes the API types classified by function.

**Table  1**  API types

<a name="table99228171027"></a>
<table><thead align="left"><tr id="row2092221715211"><th class="cellrowborder" valign="top" width="15.02%" id="mcps1.2.5.1.1"><a name="p79225171524"></a><a name="p79225171524"></a>API Type
</th>
<th class="cellrowborder" valign="top" width="32.25%" id="mcps1.2.5.1.2"><a name="p992271711216"></a><a name="p992271711216"></a>Function
</th>
<th class="cellrowborder" valign="top" width="25.840000000000003%" id="mcps1.2.5.1.3"><a name="p29225175213"></a><a name="p29225175213"></a>Related Module
</th>
<th class="cellrowborder" valign="top" width="26.889999999999997%" id="mcps1.2.5.1.4"><a name="p129221017720"></a><a name="p129221017720"></a>Example API (<a name="i15670628145315"></a><a name="i15670628145315"></a>Class Name.<a name="i6859230125316"></a><a name="i6859230125316"></a>Method Name)
</th>
</tr>
</thead>
<tbody><tr id="row149231717327"><td class="cellrowborder" valign="top" width="15.02%" headers="mcps1.2.5.1.1 "><a name="p3923417629"></a><a name="p3923417629"></a>Basic file API
</td>
<td class="cellrowborder" valign="top" width="32.25%" headers="mcps1.2.5.1.2 "><a name="p89236171124"></a><a name="p89236171124"></a>Creates, modifies, and accesses files, and changes file permissions based on the specified absolute paths or file descriptors.
</td>
<td class="cellrowborder" valign="top" width="25.840000000000003%" headers="mcps1.2.5.1.3 "><a name="p22011844349"></a><a name="p22011844349"></a>@ohos.fileio
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.2.5.1.4 "><a name="p1784383174320"></a><a name="p1784383174320"></a>accessSync
<a name="p184313310437"></a><a name="p184313310437"></a>chownSync
<a name="p1684318315436"></a><a name="p1684318315436"></a>chmodSync
</td>
</tr>
<tr id="row1692320171825"><td class="cellrowborder" valign="top" width="15.02%" headers="mcps1.2.5.1.1 "><a name="p392391710219"></a><a name="p392391710219"></a>Basic directory API
</td>
<td class="cellrowborder" valign="top" width="32.25%" headers="mcps1.2.5.1.2 "><a name="p109232176211"></a><a name="p109232176211"></a>Reads directories and determines file types based on the specified absolute paths.
</td>
<td class="cellrowborder" valign="top" width="25.840000000000003%" headers="mcps1.2.5.1.3 "><a name="p271274219410"></a><a name="p271274219410"></a>@ohos.fileio
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.2.5.1.4 "><a name="p29233177216"></a><a name="p29233177216"></a>Dir.openDirSync
</td>
</tr>
<tr id="row14923171716217"><td class="cellrowborder" valign="top" width="15.02%" headers="mcps1.2.5.1.1 "><a name="p159234176215"></a><a name="p159234176215"></a>Basic statistical API
</td>
<td class="cellrowborder" valign="top" width="32.25%" headers="mcps1.2.5.1.2 "><a name="p1992314179215"></a><a name="p1992314179215"></a>Collects basic statistics including the file size, access permission, and modification time based on the specified absolute paths.
</td>
<td class="cellrowborder" valign="top" width="25.840000000000003%" headers="mcps1.2.5.1.3 "><a name="p325774111413"></a><a name="p325774111413"></a>@ohos.fileio
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.2.5.1.4 "><a name="p59231317420"></a><a name="p59231317420"></a>Stat.statSync
</td>
</tr>
<tr id="row692319171228"><td class="cellrowborder" valign="top" width="15.02%" headers="mcps1.2.5.1.1 "><a name="p1592318171526"></a><a name="p1592318171526"></a>Streaming file API
</td>
<td class="cellrowborder" valign="top" width="32.25%" headers="mcps1.2.5.1.2 "><a name="p992311171421"></a><a name="p992311171421"></a>Reads and writes data streams of files based on the specified absolute paths or file descriptors.
</td>
<td class="cellrowborder" valign="top" width="25.840000000000003%" headers="mcps1.2.5.1.3 "><a name="p1692321716217"></a><a name="p1692321716217"></a>@ohos.fileio
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.2.5.1.4 "><a name="p10923141711215"></a><a name="p10923141711215"></a>Stream.createStreamSync
<a name="p88031126184311"></a><a name="p88031126184311"></a>Stream.fdopenStreamSync
</td>
</tr>
<tr id="row82479241516"><td class="cellrowborder" valign="top" width="15.02%" headers="mcps1.2.5.1.1 "><a name="p12923111711216"></a><a name="p12923111711216"></a>Sandbox file API
</td>
<td class="cellrowborder" valign="top" width="32.25%" headers="mcps1.2.5.1.2 "><a name="p49237171020"></a><a name="p49237171020"></a>Provides a subset or a combination of the capabilities provided by the basic file, directory, and statistical APIs based on the specified URIs.
</td>
<td class="cellrowborder" valign="top" width="25.840000000000003%" headers="mcps1.2.5.1.3 "><a name="p724852418510"></a><a name="p724852418510"></a>@system.file
</td>
<td class="cellrowborder" valign="top" width="26.889999999999997%" headers="mcps1.2.5.1.4 "><a name="p0390135216324"></a><a name="p0390135216324"></a>move
<a name="p202016525456"></a><a name="p202016525456"></a>copy
<a name="p8142558194520"></a><a name="p8142558194520"></a>list
</td>
</tr>
</tbody>
</table>

The URIs used in sandbox file APIs are classified into three types, as described in the following table.

**Table  2**  URI types

<a name="table947391523311"></a>
<table><thead align="left"><tr id="row84733151332"><th class="cellrowborder" valign="top" width="13.969999999999999%" id="mcps1.2.5.1.1"><a name="p32271219113313"></a><a name="p32271219113313"></a>Directory Type
</th>
<th class="cellrowborder" valign="top" width="16.41%" id="mcps1.2.5.1.2"><a name="p3227191993310"></a><a name="p3227191993310"></a>Prefix
</th>
<th class="cellrowborder" valign="top" width="22%" id="mcps1.2.5.1.3"><a name="p192277196333"></a><a name="p192277196333"></a>Access Visibility
</th>
<th class="cellrowborder" valign="top" width="47.620000000000005%" id="mcps1.2.5.1.4"><a name="p18227719103313"></a><a name="p18227719103313"></a>Description
</th>
</tr>
</thead>
<tbody><tr id="row1474161514330"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.2.5.1.1 "><a name="p9896152614335"></a><a name="p9896152614335"></a>Temporary directory
</td>
<td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.2.5.1.2 "><a name="p389632610335"></a><a name="p389632610335"></a>internal://cache/
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.2.5.1.3 "><a name="p989610267332"></a><a name="p989610267332"></a>Current app only
</td>
<td class="cellrowborder" valign="top" width="47.620000000000005%" headers="mcps1.2.5.1.4 "><a name="p16896726173311"></a><a name="p16896726173311"></a>Readable and writable, and can be cleared at any time. This directory is usually used for temporary downloads or caches.
</td>
</tr>
<tr id="row194741315193312"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.2.5.1.1 "><a name="p12896142620339"></a><a name="p12896142620339"></a>Private directory of an app
</td>
<td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.2.5.1.2 "><a name="p118969269332"></a><a name="p118969269332"></a>internal://app/
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.2.5.1.3 "><a name="p189612263333"></a><a name="p189612263333"></a>Current app only
</td>
<td class="cellrowborder" valign="top" width="47.620000000000005%" headers="mcps1.2.5.1.4 "><a name="p1089682623314"></a><a name="p1089682623314"></a>Deleted when the app is uninstalled.
</td>
</tr>
<tr id="row204743152331"><td class="cellrowborder" valign="top" width="13.969999999999999%" headers="mcps1.2.5.1.1 "><a name="p3896152673319"></a><a name="p3896152673319"></a>External storage
</td>
<td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.2.5.1.2 "><a name="p158961526113310"></a><a name="p158961526113310"></a>internal://share/
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.2.5.1.3 "><a name="p16896326133310"></a><a name="p16896326133310"></a>All apps
</td>
<td class="cellrowborder" valign="top" width="47.620000000000005%" headers="mcps1.2.5.1.4 "><a name="p5897126113313"></a><a name="p5897126113313"></a>Deleted when the app is uninstalled. Other apps with granted permissions can read and write files in this directory.
</td>
</tr>
</tbody>
</table>

### Usage Guidelines<a name="section149mcpsimp"></a>

The I/O APIs provided by the File Api can be classified into the following types based on the programming model:

-   Synchronous programming model

APIs whose names contain  **Sync**  are implemented as a synchronous model. When a synchronous API is called, the calling process waits until a value is returned.

The following example opens a file stream in read-only mode, attempts to read the first 4096 bytes, converts them into a UTF-8-encoded string, and then closes the file stream:

```
    import fileio from '@ohos.fileio';
    
    try {
        var ss = fileio.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);
    }
    ```

-   Asynchronous programming model: Promise

In the  **@ohos.fileio**  module, the APIs whose names do not contain  **Sync**  and to which a callback is not passed as their input parameter are implemented as the Promise asynchronous model. The Promise asynchronous model is one of the OHOS standard asynchronous models. When an asynchronous API using the Promise model is called, the API returns a Promise object while executing the concerned task asynchronously. The Promise object represents the asynchronous operation result. When there is more than one result, the results are returned as properties of the Promise object.

In the following example, a Promise chain is used to open a file stream in read-only mode, attempt to read the first 4096 bytes of the file, display the length of the content read, and then close the file:

```
    import fileio from '@ohos.fileio';
    
    try {
        let openedStream
        fileio.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)
    }
    ```

-   Asynchronous programming model: Callback

In the  **@ohos.fileio**  module, the APIs whose names do not contain  **Sync**  and to which a callback is directly passed as their input parameter are implemented as the callback asynchronous model. The callback asynchronous model is also one of the OHOS standard asynchronous models. When an asynchronous API with a callback passed is called, the API executes the concerned task asynchronously and returns the execution result as the input parameters of the registered callback. The first parameter is of the  **undefined**  or  **Error**  type, indicating that the execution succeeds or fails, respectively.

The following example creates a file stream asynchronously, reads the first 4096 bytes of the file asynchronously in the callback invoked when the file stream is created, and then closes the file asynchronously in the callback invoked when the file is read:

```
    import fileio from '@ohos.fileio';
    
    try {
        fileio.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)
    }
    ```

## Repositories Involved<a name="section178mcpsimp"></a>

- [**File Api**](https://gitee.com/openharmony/filemanagement_file_api)
- [filemanagement_dfs_service](https://gitee.com/openharmony/filemanagement_dfs_service)
- [filemanagement_user_file_service](https://gitee.com/openharmony/filemanagement_user_file_service)
- [filemanagement_storage_service](https://gitee.com/openharmony/filemanagement_storage_service)
- [filemanagement_app_file_service](https://gitee.com/openharmony/filemanagement_app_file_service)

hos-learning/filemanagement_file_api

简介

发行版

贡献者

近期动态

hos-learning/filemanagement_file_api .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

hos-learning/filemanagement_file_api