README_zh.md
1# 图库源码开发说明
2## 1. 简介
3图库是系统内置的可视资源访问应用，提供图片和视频的管理、浏览、显示、编辑操作等功能，并支持默认相册和用户相册管理。
4图库项目采用 TS 语言开发。
5
6
7
8
9
10图库整体以 OpenHarmony 既有的 MVVM 的 App 架构设计为基础，向下扩展出一套 MVP（View, Presenter, Model）分层架构（既有的 MVVM 框架整体理解为新扩展的 MVP 框架的 View 层），用于处理图库的业务逻辑与数据管理。
11
12各层的作用分别如下：
13
14- 视图层（View）：负责更新 UI 显示以及触摸与点击事件的监听。
15- 展现层（Presenter）：负责处理视图层（View）发送的业务逻辑处理请求，并连通 Model 层获取数据。
16- 模型层（Model）：负责处理展现层（Presenter） 中关于数据处理的请求以及返回数据请求结果。
17
18应用各层中重要类及其功能如下表所示
19
20| 模块 | 层级 | 类名 | 作用 |
21| ------ | ------ | ------------------------ | ------------------------------------ |
22| photos | 视图层 | phone.view.Index | phone图库入口画面的视图层逻辑控制类 |
23| photos | 视图层 | pad.view.Index | pad图库入口画面的视图层逻辑控制类 |
24| photos | 视图层 | TimelinePage | 图库图片视图层逻辑控制类 |
25| photos | 视图层 | AlbumSetPage | 图库相册视图层逻辑控制类 |
26| photos | 视图层 | PhotoBrowser | 图库大图浏览视图层逻辑控制类 |
27| photos | 视图层 | PhotoGridPage | 图库宫格视图层逻辑控制类 |
28| photos | 视图层 | ThirdSelectAlbumSetPage | 图库三方选择相册视图层逻辑控制类 |
29| photos | 视图层 | ThirdSelectPhotoGridPage | 图库三方选择宫格视图层逻辑控制类 |
30| photos | 视图层 | ThirdSelectPhotoBrowser | 图库三方选择大图浏览视图层逻辑控制类 |
31| photos | 展现层 | GroupItemDataSource | 图库列大图浏览展现层数据逻辑类 |
32| photos | 展现层 | TimelineItemDataSource | 图库日试图展现层数据逻辑类 |
33| photos | 展现层 | AlbumsDataSource | 图库相册展现层数据逻辑类 |
34| photos | 展现层 | GroupItemDataSource | 图库宫格展现层数据逻辑类 |
35| photos | 展现层 | SelectManager | 图库展现层选择逻辑类 |
36| photos | 展现层 | BroadCast | 图库展现层消息分发类 |
37| photos | 模型层 | AlbumDataItem | 图库模型层相册信息类 |
38| photos | 模型层 | MediaDataItem | 图库模型层媒体信息类 |
39| photos | 模型层 | TimelineDataItem | 图库模型层日试图信息类 |
40
41
42
43## 2. 目录
44
45```
46/applications
47├── src
48│ └── main
49│ ├── ets # ets代码目录
50│ ├── MainAbility
51│ ├── common # 共同代码目录
52│ ├── model # model目录
53│ ├── common # 共同业务逻辑和实体模型目录
54│ └── view # 共同视图组件
55│ ├── actionbar # 共同标题栏、底层栏和工具栏组件目录
56│ ├── browserOperation # 共同操作项目录
57│ └── dialog # 共同对话框目录
58│ ├── feature # 功能模块目录
59│ ├── album # 相册组件目录
60│ ├── model # 相册model目录
61│ └── view # 相册视图组件目录
62│ ├── albumSelect # 相册视图目录
63│ ├── model # 三方相册选择model目录
64│ ├── utils # 三方相册选择工具目录
65│ └── view # 三方相册选择视图组件目录
66│ ├── brower # 图库浏览功能目录
67│ ├── view # 图库浏览视图组件目录
68│ ├── editor # 图库图片编辑功能目录
69│ ├── base # 图片编辑基础目录
70│ ├── crop # 裁剪框组件目录
71│ ├── utils # 图片编辑工具目录
72│ └── view # 图片编辑视图组件目录
73│ ├── formEditor # 图库FA卡片编辑功能目录
74│ ├── view # 图库FA卡片编辑视图组件目录
75│ ├── newAlbum # 新建相册功能目录
76│ ├── model # 新建相册model目录
77│ └── view # 新建相册视图组件目录
78│ ├── photoGrid # 图片宫格功能目录
79│ ├── model # 图片宫格model目录
80│ └── view # 图片宫格视图组件目录
81│ ├── thirdSelect # 第三方选择功能目录
82│ ├── model # 第三方选择model目录
83│ └── view # 第三方选择视图组件目录
84│ └── timeline # 日视图宫格功能目录
85│ ├── model # 日视图model目录
86│ └── view # 日试图视图目录
87│ ├── product # 产品模块目录
88│ ├── pad # pad模块目录
89│ └── view # pad模块视图目录
90│ └── phone # phone模块目录
91│ └── view # phone模块视图目录
92│ ├── resources # 资源目录
93│ └── module.json5 # 项目配置信息
94```
95###
96
97## 3. 基础开发说明
98### 资源引用
99#### 定义资源文件
100- 在 `src/main/resources/`目录下，根据不同的资源类型，定义资源文件。
101
102 ```json
103 {
104 "name": "default_background_color",
105 "value": "#F1F3F5"
106 },
107 ```
108#### 引用资源
109- 在有对应page的ets文件中，可直接通过`$r()`引用。
110 ```` JavaScript
111 @Provide backgroundColor: Resource = $r('app.color.default_background_color');
112 ````
113## 4. 典型接口的使用
1141. 相机启动图库大图浏览
115
116 ```
117 this.context.startAbility({
118 bundleName:"com.ohos.photos",
119 abilityName: "com.ohos.photos.MainAbility",
120 parameters: {
121 uri: "photodetail"
122 }
123 }).then((data) => {
124 console.debug('startAbility complete');
125 }).catch((error) => {
126 console.debug(`startAbility failed, error: ${JSON.stringify(error)}`);
127 })
128 ```
129
1302. 三方应用启动图库三方单选
131
132 ```
133 let startParmameter = {
134 bundleName:"com.ohos.photos",
135 abilityName: "com.ohos.photos.MainAbility",
136 parameters: {
137 uri: "singleselect"
138 }
139 };
140 this.context.startAbilityForResult(startParmameter).then((result) => {
141 console.info(`startAbilityForResult Promise.resolve is called, result.resultCode = ${JSON.stringify(result)}`)
142 let want = result['want'];
143 console.info(`test select single ${JSON.stringify(want)}`);
144 if (want != null && want != undefined) {
145 let param = want['parameters'];
146 console.info(`test select single ${JSON.stringify(param)}`);
147 if (param != null && param != undefined) {
148 let uri = param['select-item-list'];
149 console.info(`test select single ${uri}`);
150 }
151 }
152 }, (error) => {
153 console.info(`startAbilityForResult Promise.Reject is called, error.code = ${error.code}`)
154 })
155 ```
156
1573. 三方应用启动图库三方多选
158
159 ```
160 let startParmameter = {
161 bundleName:"com.ohos.photos",
162 abilityName: "com.ohos.photos.MainAbility",
163 parameters: {
164 uri: "multipleselect"
165 }
166 };
167 this.context.startAbilityForResult(startParmameter).then((v) => {
168 let want = v['want'];
169 console.info(`test select multiple ${want}`);
170 if (want != null && want != undefined) {
171 let param = want['parameters'];
172 console.info(`test select multiple ${param}`);
173 if (param != null && param != undefined) {
174 let uri = param['select-item-list'];
175 console.info(`test select multiple ${uri[0]} ${uri[1]}`);
176 }
177 }
178 }, (error) => {
179 console.debug(`startAbility failed, error: ${JSON.stringify(error)}`);
180 })
181 ```
182
183## 5. 签名打包
184### 签名
185#### 签名文件的获取
1861. 拷贝 OpenHarmony 标准版的 prebuilts\signcenter 目录到操作目录。
1872. 标准版的签名文件下载路径：https://gitee.com/openharmony/signcenter_tool?_from=gitee_search。
1883. 拷贝图库工程的 signature\photos.p7b 到该目录下。
189
190
191#### 签名文件的配置
192打开项目工程，选择 File → Project Structure
193
194
195
196选择 Modules → Signing Configs，将对应的签名文件配置如下，完成后点击Apply，再点击OK。
197密码为生成签名文件时的密码，如果使用默认的签名文件，则使用默认密码123456。
198
199
200
201配置完成后，对应的build.gradle文件中会出现如下内容
202
203
204
205使用的SDK 3.2.2.5版本编译master仓代码，在/entry/package.json里手动触发npm install
206
207
208### 打包
209DevEco Studio 支持 debug 与 release 两种打包类型。可以在 OhosBuild Variants 窗口中进行切换。
210
211 
212
213#### release打包
2141. 代码准备完成后，在 OhosBuild Variants 窗口的 Selected Variant 中选择 release
215
216 
217
2182. 选择Build → Build Haps(s)/APP(s) → Build Hap(s)
219
220 
221
2223. 编译完成后，hap包会生成在工程目录下的 `\build\outputs\hap\release\`路径下（如果没有配置签名，则只会生成未签名的hap包）
223
224 
225
226
227## 6. 安装、运行、调试
228### 应用安装
229配置 hdc：
230进入SDK目录中的toolchains文件夹下，获取文件路径：
231
232
233
234
235并将此路径配置到环境变量中：
236
237
238
239连接开发板，打开一个新的cmd命令窗口，执行`hdc list targets`，弹出窗口如下：
240
241
242
243等待一段时间后，窗口出现如下打印，可回到输入 hdc list targets 的命令窗口继续操作:
244
245
246
247再次输入hdc list targets，出现如下结果，说明hdc连接成功
248
249
250
251首次安装需要卸载系统自带的图库
252
253```html
254hdc shell mount -o remount,rw /
255
256hdc shell rm -rf /system/app/com.ohos.photos/Photos.hap
257
258hdc shell reboot
259```
260
261安装签过名的hap包
262
263```html
264hdc install 包路径
265```
266
267长按图库图标添加到工作区
268
269### 应用调试
270#### log打印
271- 在程序中添加 log
272```JS
273const TAG = "MoudleXXX"
274
275entry() {
276 let input = 'hello'
277 Log.info(TAG, `onPhotoChanged start ${input}`);
278}
279```
280上述log打印为：
281
282```
283Photos_MoudleXXX:entry: hello
284```
285
286可以在DevEco Studio中查看log
287
288
289#### log获取及过滤
290- log获取
291
292
293将log输出至文件
294```
295hdc shell hilog > 输出文件名称
296```
297
298例：
299在真实环境查看log，将全log输出到当前目录的hilog.log文件中
300```
301hdc shell hilog > hilog.log
302```
303
304- log过滤
305
306在命令行窗口中过滤log
307```
308hilog | grep 过滤信息
309```
310
311例：过滤包含信息 Album的 hilog
312```
313hilog | grep Album
314```
315## 7. 贡献代码
316### Fork 代码仓库
3171. 在码云上打开 photos代码仓库（[仓库地址](https://gitee.com/OHOS_STD/applications_photos)）。
3182. 点击仓库右上角的 Forked 按钮
319 
3203. 在弹出的画面中，选择将仓库 fork 到哪里，点击确认。
321 
3224. Fork 成功之后，会在自己的账号下看见 fork 的代码仓库。
323 
324
325### 提交代码
3261. 访问我们自己在码云账号上 fork 的代码仓库，点击“克隆/下载”按钮，选择 SSH，点击“复制”按钮。
327 
328
3292. 在本地新建 Photos 目录，在 Photos 目录中执行如下命令
330 ```
331 git clone 步骤1中复制的地址
332 ```
333
3343. 修改代码。
335
336 > 将代码引入工程，以及编译工程等相关内容请参见 **3. 代码使用** 部分的相关内容。
3374. 提交代码到 fork 仓库。
338 > 修改后的代码，首先执行 `git add` 命令，然后执行 `git commit` 命令与 `git push` 命令，将代码 push 到我们自己的 fork 仓中。
339 > 关于代码提交的这部分内容涉及 git 的使用，可以参照 [git官网](https://git-scm.com/) 的内容，在此不再赘述。
340 > 注意事项：需要使用commit -s,暴露提交者信息，否则门禁不通过
341
342### 发起 Pull Request (PR)
343在将代码提交到 fork 仓之后，我们可以通过发起 Pull Request（PR）的方式来为 OpenHarmony 的相关项目贡献代码。
344
3451. 打开 fork 仓库。选择 `Pull Requests` → `新建 Pull Request`
346
347 
348
3492. 在 `新建 Pull Request` 画面填入标题与说明，点击 `创建` 按钮。
350
351 
3523. 创建 Pull Request 完成。 PR 创建完成后，会有专门的代码审查人员对代码进行评审，评审通过之后会合入相应的代码库。
353
354 
355
356
357
358
