1# 选择用户文件 2 3用户需要分享文件、保存图片、视频等用户文件时，开发者可以通过系统预置的[文件选择器（FilePicker）](../reference/apis-core-file-kit/js-apis-file-picker.md)，实现该能力。通过Picker访问相关文件，将拉起对应的应用，引导用户完成界面操作，接口本身无需申请权限。Picker获取的URI只具有临时权限，获取持久化权限需要通过[FilePicker设置永久授权](file-persistPermission.md#通过picker获取临时授权并进行授权持久化)方式获取。 4 5根据用户文件的常见类型，选择器（FilePicker）分别提供以下选项： 6 7- [PhotoViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#photoviewpickerdeprecated)：适用于图片或视频类型文件的选择与保存（该接口在后续版本不再演进）。请使用[PhotoAccessHelper的PhotoViewPicker](../reference/apis-media-library-kit/js-apis-photoAccessHelper.md#photoviewpicker)来选择图片文件。请使用[安全控件保存媒体库资源](../media/medialibrary/photoAccessHelper-savebutton.md)。 8 9- [DocumentViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#documentviewpicker)：适用于文件类型文件的选择与保存。DocumentViewPicker对接的选择资源来自于FilePicker，负责文件类型的资源管理，文件类型不区分后缀，比如浏览器下载的图片、文档等，都属于文件类型。 10 11- [AudioViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#audioviewpicker)：适用于音频类型文件的选择与保存。AudioViewPicker目前对接的选择资源来自于FilePicker。 12 13## 选择图片或视频类文件 14 15[PhotoViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#photoviewpickerdeprecated)在后续版本不再演进，请[PhotoAccessHelper的PhotoViewPicker](../reference/apis-media-library-kit/js-apis-photoAccessHelper.md#photoviewpicker)来选择图片文件。 16 17## 选择文档类文件 18 191. 导入选择器模块和基础文件API模块。 20 21 ```ts 22 import { picker } from '@kit.CoreFileKit'; 23 import { fileIo as fs } from '@kit.CoreFileKit'; 24 import { common } from '@kit.AbilityKit'; 25 import { BusinessError } from '@kit.BasicServicesKit'; 26 ``` 27 282. 创建文件类型、文件选择选项实例。 29 30 ```ts 31 const documentSelectOptions = new picker.DocumentSelectOptions(); 32 // 选择文档的最大数目（可选）。 33 documentSelectOptions.maxSelectNumber = 5; 34 // 指定选择的文件或者目录路径（可选）。 35 documentSelectOptions.defaultFilePathUri = "file://docs/storage/Users/currentUser/test"; 36 // 选择文件的后缀类型['后缀类型描述|后缀类型']（可选，不传该参数，默认不过滤，即显示所有文件），若选择项存在多个后缀名，则每一个后缀名之间用英文逗号进行分隔（可选），后缀类型名不能超过100。此外2in1设备支持通过通配符方式['所有文件(*.*)|.*']，表示为显示所有文件，手机暂不支持该配置。 37 documentSelectOptions.fileSuffixFilters = ['图片(.png, .jpg)|.png,.jpg', '文档|.txt', '视频|.mp4', '.pdf']; 38 //选择是否对指定文件或目录授权，true为授权，当为true时，defaultFilePathUri为必选参数，拉起文管授权界面；false为非授权(默认为false)，拉起常规文管界面（可选）仅支持2in1设备。 39 documentSelectOptions.authMode = false; 40 //批量授权模式，默认为false（非批量授权模式）。当multAuthMode为true时为批量授权模式。当multAuthMode为true时，只有multiUriArray参数生效，其他参数不生效。仅支持手机设备。 41 documentSelectOptions.multiAuthMode = false; 42 //需要传入批量授权的uri数组（仅支持文件，文件夹不生效）。配合multAuthMode使用。当multAuthMode为false时，配置该参数不生效。仅支持手机设备。 43 documentSelectOptions.multiUriArray = ["file://docs/storage/Users/currentUser/test", "file://docs/storage/Users/currentUser/2test"]; 44 //开启聚合视图模式，支持拉起文件管理应用的聚合视图。默认为DEFAULT，表示该参数不生效，非聚合视图。当该参数置为非DEFAULT时，其他参数不生效。仅支持手机设备。 45 documentSelectOptions.mergeMode = picker.MergeTypeMode.DEFAULT; 46 ``` 47 483. 创建[文件选择器DocumentViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#documentviewpicker)实例。调用[select()](../reference/apis-core-file-kit/js-apis-file-picker.md#select-3)接口拉起FilePicker应用界面进行文件选择。 49 50 ```ts 51 let uris: Array<string> = []; 52 // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext 53 let context = this.getUIContext().getHostContext() as common.UIAbilityContext; 54 // 创建文件选择器实例 55 const documentViewPicker = new picker.DocumentViewPicker(context); 56 documentViewPicker.select(documentSelectOptions).then((documentSelectResult: Array<string>) => { 57 //文件选择成功后，返回被选中文档的URI结果集。 58 uris = documentSelectResult; 59 console.info('documentViewPicker.select to file succeed and uris are:' + uris); 60 }).catch((err: BusinessError) => { 61 console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`); 62 }) 63 ``` 64 65 > **注意：** 66 > 67 > **1**、使用Picker获取的[select()](../reference/apis-core-file-kit/js-apis-file-picker.md#select-3)返回的URI权限是临时只读权限,待退出应用后台后，获取的临时权限就会失效。<br> 68 > **2**、如果想要获取持久化权限，请参考[文件持久化授权访问](file-persistPermission.md#通过picker获取临时授权并进行授权持久化)。<br> 69 > **3**、开发者可以根据结果集中URI做进一步的处理。建议定义一个全局变量保存URI。<br> 70 > **4**、如有获取元数据需求，可以通过[基础文件API](../reference/apis-core-file-kit/js-apis-file-fs.md)和[文件URI](../reference/apis-core-file-kit/js-apis-file-fileuri.md)根据URI获取部分文件属性信息，比如文件大小、访问时间、修改时间、文件名、文件路径等。 71 724. 待界面从FilePicker返回后，使用[基础文件API的fs.openSync](../reference/apis-core-file-kit/js-apis-file-fs.md#fsopensync)接口通过URI打开这个文件得到文件描述符（fd）。 73 74 ```ts 75 let uri: string = ''; 76 //这里需要注意接口权限参数是fs.OpenMode.READ_ONLY。 77 let file = fs.openSync(uri, fs.OpenMode.READ_ONLY); 78 console.info('file fd: ' + file.fd); 79 ``` 80 815. 通过fd使用[fs.readSync](../reference/apis-core-file-kit/js-apis-file-fs.md#readsync)接口读取这个文件内的数据。 82 83 ```ts 84 let buffer = new ArrayBuffer(4096); 85 let readLen = fs.readSync(file.fd, buffer); 86 console.info('readSync data to file succeed and buffer size is:' + readLen); 87 //读取完成后关闭fd。 88 fs.closeSync(file); 89 ``` 90 91## 选择音频类文件 92 931. 导入选择器模块和基础文件API模块。 94 95 ```ts 96 import { picker } from '@kit.CoreFileKit'; 97 import { fileIo as fs } from '@kit.CoreFileKit'; 98 import { BusinessError } from '@kit.BasicServicesKit'; 99 import { common } from '@kit.AbilityKit'; 100 ``` 101 1022. 创建音频类型文件选择选项实例。 103 104 > **说明：** 105 > 106 > 目前AudioSelectOptions不支持参数配置，默认可以选择所有类型的用户文件。 107 108 ```ts 109 const audioSelectOptions = new picker.AudioSelectOptions(); 110 ``` 111 1123. 创建[音频选择器AudioViewPicker](../reference/apis-core-file-kit/js-apis-file-picker.md#audioviewpicker)实例。调用[select()](../reference/apis-core-file-kit/js-apis-file-picker.md#select-5)接口拉起FilePicker应用界面进行文件选择。 113 114 ```ts 115 let uris: string = ''; 116 // 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext 117 let context = this.getUIContext().getHostContext() as common.UIAbilityContext; 118 const audioViewPicker = new picker.AudioViewPicker(context); 119 audioViewPicker.select(audioSelectOptions).then((audioSelectResult: Array<string>) => { 120 //文件选择成功后，返回被选中音频的URI结果集。 121 uris = audioSelectResult[0]; 122 console.info('audioViewPicker.select to file succeed and uri is:' + uris); 123 }).catch((err: BusinessError) => { 124 console.error(`Invoke audioViewPicker.select failed, code is ${err.code}, message is ${err.message}`); 125 }) 126 ``` 127 128 > **注意：** 129 > 130 > **1**、使用Picker获取的[select()](../reference/apis-core-file-kit/js-apis-file-picker.md#select-3)返回的URI权限是临时只读权限,待退出应用后台后，获取的临时权限就会失效。<br> 131 > **2**、如果想要获取持久化权限，请参考[文件持久化授权访问](file-persistPermission.md#通过picker获取临时授权并进行授权持久化)。<br> 132 > **3**、开发者可以根据结果集中的URI做读取文件数据操作。建议定义一个全局变量保存URI。例如通过[基础文件API](../reference/apis-core-file-kit/js-apis-file-fs.md)根据URI拿到音频资源的文件描述符（fd），再配合媒体服务实现音频播放的开发，具体请参考[音频播放开发指导](../media/audio/audio-playback-overview.md)。 133 1344. 待界面从FilePicker返回后，可以使用[基础文件API的fs.openSync](../reference/apis-core-file-kit/js-apis-file-fs.md#fsopensync)接口通过URI打开这个文件得到文件描述符（fd）。 135 136 ```ts 137 let uri: string = ''; 138 //这里需要注意接口权限参数是fs.OpenMode.READ_ONLY。 139 let file = fs.openSync(uri, fs.OpenMode.READ_ONLY); 140 console.info('file fd: ' + file.fd); 141 ``` 142 1435. 通过fd可以使用[基础文件API的fs.readSync](../reference/apis-core-file-kit/js-apis-file-fs.md#readsync)接口读取这个文件内的数据。 144 145 ```ts 146 let buffer = new ArrayBuffer(4096); 147 let readLen = fs.readSync(file.fd, buffer); 148 console.info('readSync data to file succeed and buffer size is:' + readLen); 149 //读取完成后关闭fd。 150 fs.closeSync(file); 151 ``` 152 153## 相关实例 154 155针对用户文件的选择，有以下相关实例可供参考： 156 157- [选择并查看文档与媒体文件（ArkTS）（API10）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/BasicFeature/FileManagement/FileShare/Picker) 158 159<!--RP1--><!--RP1End-->