文件路径使用指导


文件路径使用指导

Openharmony上用户数据统一由媒体库进行管理,用户数据用户数据可以通过mediaLibrary提供的接口能力进行访问和操作。

说明:

在进行功能开发前,请开发者查阅媒体库开发概述,了解如何获取媒体库实例和如何申请媒体库功能开发相关权限。

为了保证应用的运行效率,大部分MediaLibrary调用都是异步的,对于异步调用的API均提供了callback和Promise两种方式,以下示例均采用Promise函数,更多方式可以查阅API参考

公共目录路径支持的文件格式

在使用文件路径进行开发之前,需要了解各公共目录路径支持的文件格式说明。

注意:
下表仅表示系统能识别的文件类型,在具体的开发中,开发者需要关注对应接口支持的文件格式。
如image编码功能只支持.jpeg和.webp,解码功能只支持.jpg .png .gif .bmp .webp RAW。

目录路径 目录类型 媒体类型 说明 支持的文件格式
Camera/ DIR_CAMERA VIDEO amd IMAGE 相机拍摄图片与录像的存放路径,目录与子目录下可以存放视频,图片类型文件。 .bmp / .bm / .gif / .jpg /. jpeg / .jpe / .png / .webp / .raw / .svg / .heif / .mp4 / .3gp / .mpg / .mov / .webm / .mkv
Videos/ DIR_VIDEO VIDEO 视频专有目录,目录与子目录下只可以存放视频类型文件。 .mp4 / .3gp / .mpg / .mov / .webm / .mkv
Pictures/ DIR_IMAGE IMAGE 图片专有目录,目录与子目录下只可以存放图片类型文件。 .bmp / .bm / .gif / .jpg /. jpeg / .jpe / .png / .webp / .raw / .svg / .heif
Audios/ DIR_AUDIO AUDIO 音频专有目录,目录与子目录下只可以存放音频类型文件。 .aac/.mp3/.flac/.wav/.ogg
Documents/ DIR_DOCUMENTS FILE 文档类型目录,目录与子目录下只可以存放音频,图片,视频以外类型文件。 -
Download/ DIR_DOWNLOAD ALLTYPE 下载文件存放目录,目录与子目录下文件类型不受限制。 -

获取文件保存的公共目录

不同类型的文件会保存到不同的公共目录下,可以通过接口getPublicDirectory来获取公共目录路径。

前提条件

  • 获取媒体库mediaLibrary实例。
  • 申请媒体库读权限“ohos.permission.READ_MEDIA。

下面以获取Camera文件保存的公共目录为例。

async function example(){
    const context = getContext(this);
    var media = mediaLibrary.getMediaLibrary(context);
    let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
    const dicResult = await media.getPublicDirectory(DIR_CAMERA);
    if (dicResult == 'Camera/') {
        console.info('mediaLibraryTest : getPublicDirectory passed');
    } else {
        console.info('mediaLibraryTest : getPublicDirectory failed');
    }
}
1
2
3
4
5
6
7
8
9
10
11

沙箱与公共路径间文件的复制

OpenHarmony提供应用沙箱机制,增加目录可见性数据访问防线,减少了应用数据和用户隐私信息泄露,建立了更加严格安全的应用沙盒隔离能力。

放在公共路径下的文件,用户可以通过系统应用“文件管理”、“图库”访问,但应用沙箱内的文件,只有应用本身可以访问。

复制文件

通过接口mediaLibrary.FileAsset.open可以打开公共路径文件。

通过接口fileio.open可以打开沙箱路径文件,沙箱路径必须通过应用上下文context进行访问。

前提条件

  • 获取媒体库mediaLibrary实例。
  • 申请媒体库读写权限“ohos.permission.WRITE_MEDIA。
  • 除了@ohos.multimedia.mediaLibrary外,还需要导入模块@ohos.fileio

开发步骤

  1. 调用context.filesDir获取应用沙箱路径。
  2. 调用MediaLibrary.getFileAssets和FetchFileResult.getFirstObject获取公共目录中的FileAsset实例。
  3. 调用fileio.open打开沙箱路径文件。
  4. 调用fileAsset.open打开公共路径文件。
  5. 调用fileio.copyfile复制文件。
  6. 调用fileAsset.close和fileio.close关闭文件。

示例1 将公共路径文件复制到沙箱路径下

async function copyPublic2Sandbox() {
    const context = getContext(this);
    var media = mediaLibrary.getMediaLibrary(context);
    let sandboxDirPath = globalThis.context.filesDir;
    let fileKeyObj = mediaLibrary.FileKey
    let fileAssetFetchOp = {
        selections: fileKeyObj.DISPLAY_NAME + '= ?' ,
        selectionArgs: ['testFile.txt'],
    };
    let fetchResult = await media.getFileAssets(fileAssetFetchOp);
    let fileAsset = await fetchResult.getFirstObject();

    let fdPub = await fileAsset.open('rw');
    let fdSand = await fileio.open(sandboxDirPath + '/testFile.txt', 0o2 | 0o100, 0o666);
    await fileio.copyFile(fdPub, fdSand);

    await fileAsset.close(fdPub);
    await fileio.close(fdSand);

    let content_sand = await fileio.readText(sandboxDirPath + '/testFile.txt');
    console.log('content read from sandbox file: ', content_sand)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

示例2 将应用沙箱路径文件复制到公共路径

async function copySandbox2Public() {
    const context = getContext(this);
    var media = mediaLibrary.getMediaLibrary(context);
    let sandboxDirPath = globalThis.context.filesDir;

    let DIR_DOCUMENTS = mediaLibrary.DirectoryType.DIR_DOCUMENTS;
    const publicDirPath = await media.getPublicDirectory(DIR_DOCUMENTS);
    try {
        let fileAsset = await media.createAsset(mediaLibrary.MediaType.FILE, 'testFile02.txt', publicDirPath);
        console.info('createFile successfully, message = ' + fileAsset);
    } catch (err) {
        console.info('createFile failed, message = ' + err);
    }
    try {
        let fileKeyObj = mediaLibrary.FileKey
        let fileAssetFetchOp = {
            selections: fileKeyObj.DISPLAY_NAME + '= ?' ,
            selectionArgs: ['testFile02.txt'],
        };
        let fetchResult = await media.getFileAssets(fileAssetFetchOp);
        var fileAsset = await fetchResult.getFirstObject();
    } catch (err) {
        console.info('file asset get failed, message = ', err)
    }
    var fdPub = await fileAsset.open('rw');
    var fdSand = await fileio.open(sandboxDirPath + 'testFile.txt', 0o2);
    await fileio.copyFile(fdSand, fdPub);
    await fileio.close(fdPub);
    await fileio.close(fdSand);
    let fdPubRead = await fileAsset.open('rw');
    try {
        var arrayBuffer = new ArrayBuffer(4096);
        await fileio.read(fdPubRead, arrayBuffer);
        var content_pub = String.fromCharCode(new Uint8Array(arrayBuffer));
        fileAsset.close(fdPubRead);
    } catch (err) {
        console.log('read text failed, message = ', err);
    }
    console.log('content read from public file: ', content_pub);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

读写文件内容

通过mediaLibrary的接口FileAsset.open和FileAsset.close可以打开和关闭文件。通过fileio的接口fileio.read和fileio.write可以读写文件。

前提条件

  • 获取媒体库mediaLibrary实例。
  • 申请媒体库读写权限“ohos.permission.WRITE_MEDIA。
  • 除了@ohos.multimedia.mediaLibrary外,还需要导入模块@ohos.fileio

开发步骤

  1. 创建用于读写示例的文件。

    async function example() {
        let mediaType = mediaLibrary.MediaType.FILE;
        let DIR_DOCUMENTS = mediaLibrary.DirectoryType.DIR_DOCUMENTS;
        const context = getContext(this);
        var media = mediaLibrary.getMediaLibrary(context);
        const path = await media.getPublicDirectory(DIR_DOCUMENTS);
        media.createAsset(mediaType, "testFile.text", path).then (function (asset) {
            console.info("createAsset successfully:"+ JSON.stringify(asset));
        }).catch(function(err){
            console.info("createAsset failed with error:"+ err);
        });
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
  2. 使用open打开文件。

  3. 使用fileio.write写入文件,以string形式传入写入数据。

  4. 使用fileio.read读取文件,以 ArrayBuffer 形式保存读取结果。

  5. 将ArrayBuffer转化为string,以string形式得到文件内容。

  6. 使用close关闭文件。

示例1 打开现有文件、向文件中写入

async function writeOnlyPromise() {
    const context = getContext(this);
    var media = mediaLibrary.getMediaLibrary(context);
    let fileKeyObj = mediaLibrary.FileKey
    let fileAssetFetchOp = {
        selections: fileKeyObj.DISPLAY_NAME + '= ?' ,
        selectionArgs: ['testFile.txt'],
    };
    let fetchResult = await media.getFileAssets(fileAssetFetchOp);
    let fileAsset = await fetchResult.getFirstObject();
    console.info('fileAssetName: ', fileAsset.displayName);

    try {
        let fd = await fileAsset.open('w');
        console.info('file descriptor: ', fd);
        await fileio.write(fd, "Write file test content.");
        await fileAsset.close(fd);
    } catch (err) {
        console.info('write file failed, message = ', err);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

示例2 打开现有文件,读取文件内容

async function readOnlyPromise() {
    const context = getContext(this);
    var media = mediaLibrary.getMediaLibrary(context);
    let fileKeyObj = mediaLibrary.FileKey
    let fileAssetFetchOp = {
        selections: fileKeyObj.DISPLAY_NAME + '= ?' ,
        selectionArgs: ['testFile.txt'],
    };
    let fetchResult = await media.getFileAssets(fileAssetFetchOp);
    let fileAsset = await fetchResult.getFirstObject();
    console.info('fileAssetName: ', fileAsset.displayName);

    try {
        let fd = await fileAsset.open('r');
        let arrayBuffer = new ArrayBuffer(4096);
        await fileio.read(fd, arrayBuffer);
        let fileContent = String.fromCharCode(...new Uint8Array(arrayBuffer));
        globalThis.fileContent = fileContent
        globalThis.fileName = fileAsset.displayName;
        console.info('file content: ', fileContent);
        await fileAsset.close(fd);
    } catch (err) {
        console.info('read file failed, message = ', err);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25