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