harmony 鸿蒙保存用户文件

2023-06-24
浏览 (1882)

保存用户文件

在从网络下载文件到本地或将已有用户文件另存为新的文件路径等场景下，需要使用FilePicker提供的保存用户文件的能力。需关注以下关键点：

权限说明

通过Picker获取的uri默认只具备临时读写权限，临时授权在应用退出后台自动失效。
获取持久化权限需要通过FilePicker设置永久授权方式获取。（仅限2in1设备）。
使用Picker对音频、图片、视频、文档类文件的保存操作无需申请权限。

系统隔离说明

通过Picker保存的文件存储在用户指定的目录。此类文件与图库管理的资源隔离，无法在图库中看到。
若开发者需要保存图片、视频资源到图库，可使用用户无感的安全控件进行保存。

保存图片或视频类文件

PhotoViewPicker在后续版本不再演进，建议使用Media Library Kit（媒体文件管理服务）中能力来保存媒体库资源。

如果开发场景无法调用安全控件进行图片、视频保存，可使用相册管理模块PhotoAccessHelper.showAssetsCreationDialog接口进行保存操作。

保存文档类文件

模块导入。

   import { picker } from '@kit.CoreFileKit';
   import { fileIo as fs } from '@kit.CoreFileKit';
   import { BusinessError } from '@kit.BasicServicesKit';
   import { common } from '@kit.AbilityKit';

配置保存选项。

   // 创建文件管理器选项实例。
   const documentSaveOptions = new picker.DocumentSaveOptions();
   // 保存文件名（可选）。 默认为空。
   documentSaveOptions.newFileNames = ["DocumentViewPicker01.txt"];
   // 保存文件类型['后缀类型描述|后缀类型'],选择所有文件：'所有文件(*.*)|.*'（可选） ，如果选择项存在多个后缀（做大限制100个过滤后缀），默认选择第一个。如果不传该参数，默认无过滤后缀。
   documentSaveOptions.fileSuffixChoices = ['文档|.txt', '.pdf'];

创建文件选择器DocumentViewPicker实例。调用save()接口拉起FilePicker界面进行文件保存。

   let uris: Array<string> = [];
   // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
   let context = this.getUIContext().getHostContext() as common.UIAbilityContext; 
   const documentViewPicker = new picker.DocumentViewPicker(context);
   documentViewPicker.save(documentSaveOptions).then((documentSaveResult: Array<string>) => {
     uris = documentSaveResult;
     console.info('documentViewPicker.save to file succeed and uris are:' + uris);
   }).catch((err: BusinessError) => {
     console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
   })

注意：

URI存储建议：

避免在Picker回调中直接操作URI。

建议使用全局变量保存URI以供后续使用。

快捷保存：

可以通过DOWNLOAD模式直达下载目录。

待界面从FilePicker返回后，使用基础文件API的fs.openSync接口，通过URI打开这个文件得到文件描述符（fd）。

   const uri = '';
   //这里需要注意接口权限参数是fs.OpenMode.READ_WRITE。
   let file = fs.openSync(uri, fs.OpenMode.READ_WRITE);
   console.info('file fd: ' + file.fd);

通过（fd）使用基础文件API的fs.writeSync接口对这个文件进行编辑修改，编辑修改完成后关闭（fd）。

   let writeLen: number = fs.writeSync(file.fd, 'hello, world');
   console.info('write data to file succeed and size is:' + writeLen);
   fs.closeSync(file);

保存音频类文件

模块导入。

   import { picker } from '@kit.CoreFileKit';
   import { fileIo as fs } from '@kit.CoreFileKit';
   import { BusinessError } from '@kit.BasicServicesKit';
   import { common } from '@kit.AbilityKit';

配置保存选项。

   const audioSaveOptions = new picker.AudioSaveOptions();
   // 保存文件名（可选） 
   audioSaveOptions.newFileNames = ['AudioViewPicker01.mp3'];

创建音频选择器AudioViewPicker实例。调用save()接口拉起FilePicker界面进行文件保存。

   let uri: string = '';
   // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
   let context = this.getUIContext().getHostContext() as common.UIAbilityContext;  
   const audioViewPicker = new picker.AudioViewPicker(context);
   audioViewPicker.save(audioSaveOptions).then((audioSelectResult: Array<string>) => {
     uri = audioSelectResult[0];
     console.info('audioViewPicker.save to file succeed and uri is:' + uri);
   }).catch((err: BusinessError) => {
     console.error(`Invoke audioViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
   })

注意：

URI存储建议：

避免在Picker回调中直接操作URI。

建议使用全局变量保存URI以供后续使用。

快捷保存：

可以通过DOWNLOAD模式直达下载目录。

待界面从FilePicker返回后，可以使用基础文件API的fs.openSync接口，通过URI打开这个文件得到文件描述符（fd）。

   //这里需要注意接口权限参数是fileIo.OpenMode.READ_WRITE。
   let file = fs.openSync(uri, fs.OpenMode.READ_WRITE);
   console.info('file fd: ' + file.fd);

通过（fd）使用基础文件API的fs.writeSync接口对这个文件进行编辑修改，编辑修改完成后关闭（fd）。

   let writeLen = fs.writeSync(file.fd, 'hello, world');
   console.info('write data to file succeed and size is:' + writeLen);
   fs.closeSync(file);

DOWNLOAD模式保存文件

模式特点

自动创建在Download/包名/目录。
跳过文件选择界面直接保存。
返回的URI已具备持久化权限，用户可在该URI下创建文件。
模块导入。

   import { fileUri, picker } from '@kit.CoreFileKit';
   import { fileIo as fs } from '@kit.CoreFileKit';
   import { BusinessError } from '@kit.BasicServicesKit';
   import { common } from '@kit.AbilityKit';

配置下载模式。

   const documentSaveOptions = new picker.DocumentSaveOptions();
   // 配置保存的模式为DOWNLOAD，若配置了DOWNLOAD模式，此时配置的其他documentSaveOptions参数将不会生效。
   documentSaveOptions.pickerMode = picker.DocumentPickerMode.DOWNLOAD;

   let uri: string = '';
   // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
   let context = this.getUIContext().getHostContext() as common.UIAbilityContext; 
   const documentViewPicker = new picker.DocumentViewPicker(context);
   const documentSaveOptions = new picker.DocumentSaveOptions();
   documentSaveOptions.pickerMode = picker.DocumentPickerMode.DOWNLOAD;
   documentViewPicker.save(documentSaveOptions).then((documentSaveResult: Array<string>) => {
     uri = documentSaveResult[0];
     console.info('documentViewPicker.save succeed and uri is:' + uri);
     const testFilePath = new fileUri.FileUri(uri + '/test.txt').path;
     const file = fs.openSync(testFilePath, fs.OpenMode.CREATE|fs.OpenMode.READ_WRITE);
     fs.writeSync(file.fd, 'Hello World!');
     fs.closeSync(file.fd);
   }).catch((err: BusinessError) => {
     console.error(`Invoke documentViewPicker.save failed, code is ${err.code}, message is ${err.message}`);
   })