• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 文件管理(标题以特性命名)
2
3### 介绍
4
5需要介绍本sample的主要实现原理,如使用了什么API、有什么关键性的配置和实现等等,附上链接,后面需要加上应用的使用说明,示例如下:
6
7本示例主要展示了文件管理相关的功能,使用[@ohos.filemanagement.userFileManager](https://docs.openharmony.cn/pages/v4.1/zh-cn/application-dev/reference/apis-core-file-kit/js-apis-userFileManager-sys.md) 、[@ohos.file.fileAccess](https://docs.openharmony.cn/pages/v5.0/zh-cn/application-dev/reference/apis-core-file-kit/js-apis-fileAccess-sys.md) 、[@ohos.fileio](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-core-file-kit/js-apis-fileio.md) 、[@ohos.file.fs](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-core-file-kit/js-apis-file-fs.md)、[@ohos.app.ability.contextConstant](https://docs.openharmony.cn/pages/v5.0/zh-cn/application-dev/reference/apis-ability-kit/js-apis-app-ability-contextConstant.md)
8等接口,实现了增添文件、删除文件、查找指定类型文件文件和预览图片的功能;
9
10### 效果预览
11
12屏幕截屏或者视频,文件不超过4个,每张截屏图片不能太大,推荐占1/4页左右,每张图片附上图片标题,示例效果如下所示;
13
14|主页|悬浮模式|列表|悬浮模式|
15|--------------------------------|--------------------------------|--------------------------------|--------------------------------|
16|![image](code/SystemFeature/FileManagement/FileManager/screenshots/main.png)|![image](code/SystemFeature/FileManagement/FileManager/screenshots/image_file_list.png)|![image](code/SystemFeature/FileManagement/FileManager/screenshots/image_preview.png)|![image](code/SystemFeature/FileManagement/FileManager/screenshots/document_list.png)|
17
18使用说明
19
20依次介绍sample具有什么功能,怎样使用这些功能,以及使用后会达到什么效果;示例如下:
21
221. 在主界面,可以点击图片、视频、文档、音频等按钮进入对应目录的文件列表浏览界面;
232. 在文件列表浏览界面,点击“+”按钮,可以添加文件;
243. 在文件列表浏览界面,长按列表项会出现删除图片,点击删除图标可以删除文件;
254. 在图片文件列表界面,点击图片可以进入图片预览界面。
26
27### 工程目录
28
29给出项目中关键的目录结构并描述它们的作用,示例如下:
30
31```
32entry/src/main/ets/
33|---Application
34|---filemanager
35|   |---data
36|   |   |---FileDataSource.ets             // 懒加载数据格式
37|   |---pages
38|   |   |---audio
39|   |   |   |---AudioFileList.ets          // 音频列表页面
40|   |   |---common
41|   |   |   |---FileList.ets               // 同类型文件列表展示页面,接收文件类型,展示特定类型的文件列表
42|   |   |---document
43|   |   |   |---DocumentFileList.ets       // 文档列表页面
44|   |   |---image
45|   |   |   |---ImageFileList.ets          // 图片列表页面
46|   |   |   |---ImagePreview.ets           // 图片预览页面
47|   |   |---video
48|   |   |   |---VideoFileList.ets          // 视频列表页面
49|   |   |---FileManagerHome.ets            // 首页主体内容
50|---MainAbility
51|---pages
52|   |---index.ets                          // 首页
53Library/src/main/ets/
54|---filemanager
55|   |---components
56|   |   |---ThumbnailImage.ets             // 缩略图组件
57|   |---fileio
58|   |   |---FileIoManager.ts               // 文件管理,待开发
59|   |---medialibrary
60|   |   |---MediaLibraryManager.ts         // 主要封装了mediaLibrary库相关的接口,实现相关功能,如:对文件的增、删、查和图片预览功能
61|   |---userfilemanager
62|   |   |---UserFileManager.ts             // 封装userFileManager库相关的接口
63|   |---FileManager.ts                     // 文件管理接口,统一封装了各模块对外提供的功能接口
64|---mock                                   // 本地数据
65|---utils                                  // 日志工具
66```
67
68### 具体实现
69
70* 增添文件、删除文件、查找指定类型文件文件和预览图片的功能接口封装在MediaLibraryManager,源码参考:[MediaLibraryManager.ts](code/SystemFeature/FileManagement/FileManager/Library/src/main/ets/filemanager/medialibrary/MediaLibraryManager.ts)
71    * 使用userFileManager.getUserFileMgr来获取userFileManager对象;
72    * 读取每个文件的数据:使用userFileManager.getPhotoAssets读取满足条件的文图片视频以及音频集合FetchResult,然后调用FetchResult.getFirstObject();
73    * 创建模拟文件:如果是视频或图片文件,使用createPhotoAsset()创建,如果是音频文件,使用createAudioAsset()创建,如果是文档文件,则使用fileAccess中的createFile()创建;
74    * 删除指定路径的文件:使用userFileManager中的delete();
75    * 获取预览图:使用image.createImageSource()创建指定的文件资源ImageSource,然后调用ImageSource.createPixelMap(),接口参考:[@ohos.multimedia.image](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-image-kit/js-apis-image.md)76
77* 在Library模块中通过封装FileManager向外提供功能接口,如MediaLibraryManager.getPixelMapByFileAsset(),源码参考:[FileManager.ts](code/SystemFeature/FileManagement/FileManager/Library/src/main/ets/filemanager/FileManager.ts)
78    * 如效果预览中的**图片列表**,读取指定类型的文件:在[FileList.ets](code/SystemFeature/FileManagement/FileManager/entry/src/main/ets/filemanager/pages/common/FileList.ets)
79      中调用FileManager.getFileAssets();
80    * 创建模拟文件:在[FileList.ets](code/SystemFeature/FileManagement/FileManager/entry/src/main/ets/filemanager/pages/common/FileList.ets)
81      中调用FileManager.createTxtFileAsset();
82    * 删除指定路径的文件:在[FileList.ets](code/SystemFeature/FileManagement/FileManager/entry/src/main/ets/filemanager/pages/common/FileList.ets)
83      中调用FileManager.deleteFileAsset();
84    * 获取缩略图:在[ThumbnailImage.ets](code/SystemFeature/FileManagement/FileManager/Library/src/main/ets/filemanager/components/ThumbnailImage.ets) 中调用FileManager.getThumbnail();
85    * 如效果预览中的**图片预览**,获取预览图:在[ImagePreview.ets](code/SystemFeature/FileManagement/FileManager/entry/src/main/ets/filemanager/pages/image/ImagePreview.ets) 中调用FileManager.getPixelMapByFileAsset()。
86
87### 相关权限
88
89附上使用到权限和链接,示例如下:
90
91[ohos.permission.WRITE_IMAGEVIDEO](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionwrite_imagevideo)
92
93[ohos.permission.READ_IMAGEVIDEO](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionread_imagevideo)
94
95[ohos.permission.READ_AUDIO](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionread_audio)
96
97[ohos.permission.WRITE_AUDIO](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionwrite_audio)
98
99[ohos.permission.READ_WRITE_DOWNLOAD_DIRECTORY](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionread_write_download_directory)
100
101[ohos.permission.GET_BUNDLE_INFO_PRIVILEGED](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionget_bundle_info_privileged)
102
103[ohos.permission.FILE_ACCESS_MANAGER](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionfile_access_manager)
104
105[ohos.permission.STORAGE_MANAGER](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/AccessToken/permissions-for-system-apps.md#ohospermissionstorage_manager)
106
107### 依赖
108
109如果涉及依赖其他Sample,需要进行说明,并且附上链接;
110
111### 约束与限制
112
113描述一些设备、SDK版本、IDE版本、接口限制、签名等约束和限制,示例如下:
114
1151. 本示例仅支持标准系统上运行,支持设备:RK3568;
1162. 本示例为Stage模型,仅支持API11版本SDK,SDK版本号(API Version 11 Beta),镜像版本号(4.1Beta)
1173. 本示例需要使用DevEco Studio 版本号(4.0Release)版本才可编译运行。
1184. 本示例涉及系统接口,需要配置系统应用签名,可以参考[特殊权限配置方法](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/hapsigntool-overview.md) ,把配置文件中的“app-feature”字段信息改为“hos_system_app”。
119
120### 下载
121
122给出单独下载本工程的命令,在代码中替换工程目录并以/结尾,如下面示例中的 **FileManager/FileManager**,示例如下:
123
124如需单独下载本工程,执行如下命令:
125
126```
127git init
128git config core.sparsecheckout true
129echo FileManager/FileManager/ > .git/info/sparse-checkout
130git remote add origin https://gitee.com/openharmony/applications_app_samples.git
131git pull origin master
132```