@ohos.file.fileuri (文件URI)

该模块提供通过PATH获取文件统一资源标志符（Uniform Resource Identifier，URI），后续可通过使用@ohos.file.fs进行相关open、read、write等操作，实现文件分享。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { fileUri } from '@kit.CoreFileKit';

使用该功能模块前，需要先获取其应用沙箱路径，开发示例如下：

  import { UIAbility } from '@kit.AbilityKit';
  import { window } from '@kit.ArkUI';

  export default class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
      let context = this.context;
      let pathDir = context.filesDir;
    }
  }

FileUri¹⁰⁺

属性

系统能力：SystemCapability.FileManagement.AppFileService

constructor¹⁰⁺

constructor(uriOrPath: string)

constructor是FileUri的构造函数。

原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.FileManagement.AppFileService

参数：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。 |错误码ID|错误信息 | |——–|———-| |13900005|I/O error| |13900042|Unknown error| |13900020|Invalid argument| |14300002|Invalid uri|

示例：

  let path = pathDir + '/test';
  let uri = fileUri.getUriFromPath(path);  // file://<packageName>/data/storage/el2/base/haps/entry/files/test
  let fileUriObject = new fileUri.FileUri(uri);
  console.info("The name of FileUri is " + fileUriObject.name);

toString¹⁰⁺

toString(): string

系统能力：SystemCapability.FileManagement.AppFileService

返回字符串类型URI。

返回值：

示例：

  let path = pathDir + '/test';
  let fileUriObject = new fileUri.FileUri(path);
  console.info("The uri of FileUri is " + fileUriObject.toString());

getFullDirectoryUri¹¹⁺

getFullDirectoryUri(): string

获取所在路径uri。uri指向文件则返回所在路径的uri，uri指向目录则不处理直接返回原串；uri指向的文件不存在或属性获取失败则返回空串。

如果当前FileUri指向文件，将返回文件所在路径uri。如xxx/example.txt，将返回xxx。

如果当前FileUri指向目录，将返回当前路径的uri。

原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.FileManagement.AppFileService

返回值：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  try {
    let path = pathDir + '/test.txt';
    let fileUriObject = new fileUri.FileUri(path);
    let directoryUri = fileUriObject.getFullDirectoryUri();
    console.log(`success to getFullDirectoryUri: ${JSON.stringify(directoryUri)}`);
  } catch (error) {
    console.error(`failed to getFullDirectoryUri because: ${JSON.stringify(error)}`);
  }

isRemoteUri¹²⁺

isRemoteUri(): boolean

判断当前uri是否是远端uri。

原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.FileManagement.AppFileService

返回值：

错误码：

以下错误码的详细介绍请参见文件管理子系统错误码。

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  function isRemoteUriExample() {
    let uri = "file://com.example.demo/data/stroage/el2/base/test.txt?networkid=xxxx";//?networkid设备id，远端URI的标识
    let fileUriObject = new fileUri.FileUri(uri);
    let ret = fileUriObject.isRemoteUri();
    if (ret) {
        console.log(`It is a remote uri.`);
    }
  }

fileUri.getUriFromPath

getUriFromPath(path: string): string

通过传入的路径path生成应用自己的uri；将path转uri时，路径中的中文及非数字字母的特殊字符将会被编译成对应的ASCII码，拼接在uri中。

原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

系统能力：SystemCapability.FileManagement.AppFileService

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码。 |错误码ID|错误信息 | |———-|———-| |401|The input parameter is invalid. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types|

示例：

  let filePath = pathDir + "/test";
  let uri = fileUri.getUriFromPath(filePath);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Core File Kit（文件基础服务）

harmony 鸿蒙Environment

harmony 鸿蒙FileIO

harmony 鸿蒙FileShare_PolicyErrorResult

harmony 鸿蒙FileShare_PolicyInfo

harmony 鸿蒙error_code.h

harmony 鸿蒙文件管理错误码

harmony 鸿蒙FileShare

harmony 鸿蒙FileUri

harmony 鸿蒙@ohos.application.BackupExtensionAbility (备份恢复扩展能力)(系统接口)