1# 从一个例子开始
2
3
4本章通过一个天气应用,介绍一多应用的整体开发过程,包括UX设计、工程管理及调试、页面开发等。
5
6
7## UX设计
8
9本示例中的天气应用包含主页、管理城市和添加城市三个页面,其中主页中又包含菜单和更新间隔两个弹窗,基本业务逻辑如下所示。
10
11![image-20220820153523548](figures/image-20220820153523548.png)
12
13“一多”建议从最初的设计阶段开始就拉通多设备综合考虑。考虑实际智能终端设备种类繁多,设计师无法针对每种具体设备各自出一份UX设计图。“一多”建议从设备屏幕宽度的维度,将设备划分为四大类。设计师只需要针对这四大类设备做设计,而无需关心具体的设备形态。
14
15  | 设备类型 | 屏幕宽度(vp) |
16| -------- | -------- |
17| 超小设备 | [0, 320) |
18| 小设备 | [320, 600) |
19| 中设备 | [600, 840) |
20| 大设备 | [840, +∞) |
21
22> **说明:**
23> - vp是virtual pixel(虚拟像素)的缩写,是常用的长度单位<!--Del-->,详见[视觉基础](../../../design/ux-design/visual-basis.md)小节中的介绍<!--DelEnd-->。
24>
25> - 此处基于设备屏幕宽度划分不同设备是为了方便理解。通常智能设备上的应用都是以全屏的形式运行,但随着移动技术的发展,当前部分智能设备支持应用以自由窗口模式运行(即用户可以通过拖拽等操作自由调整应用运行窗口的尺寸),故以应用窗口尺寸为基准进行划分更为合适,本文后续的响应式布局章节中将详细介绍相关内容。
26>
27> - OpenHarmony当前仅有默认设备和平板两种设备形态,DevEco Studio在创建OpenHarmony工程时也仅可以选择默认设备和平板。随着演进,其支持的设备形态会不断丰富,本文也会定期刷新相关介绍。
28
29默认设备和平板对应于小设备、中设备及大设备,本示例以这三类设备场景为例,介绍不同设备上的UX设计。天气主页在不同设备上的设计图如下所示。
30
31  |  | 小设备 | 中设备 | 大设备 |
32| -------- | -------- | -------- | -------- |
33| 主页 | ![zh-cn_image_0000001334020938](figures/zh-cn_image_0000001334020938.png) | ![zh-cn_image_0000001385380457](figures/zh-cn_image_0000001385380457.jpg) | ![zh-cn_image_0000001348546856](figures/zh-cn_image_0000001348546856.jpg) |
34
35另外,大设备中天气主页还允许用户开启或者隐藏侧边栏。
36
37  | 开启侧边栏 | 隐藏侧边栏 |
38| -------- | -------- |
39| ![zh-cn_image_0000001334340566](figures/zh-cn_image_0000001334340566.jpg) | ![zh-cn_image_0000001385100509](figures/zh-cn_image_0000001385100509.jpg) |
40
41从天气应用在各设备上的UX设计图中,可以观察到如下UX的一些“规律”:
42
43- 在不同的屏幕宽度下,应用的整体风格基本保持一致。
44
45- 在相近的屏幕宽度范围内,应用的布局基本不变;在不同的屏幕宽度范围内,应用的布局有较大差异。
46
47- 应用在小屏幕下显示的元素,是大屏幕中显示元素的子集。
48  - 考虑到屏幕尺寸及显示效果,大屏幕中可以显示的元素数量一定不少于小屏幕。
49  - 为充分利用屏幕尺寸优势,大屏幕可以有其独有的元素或设计(如本示例中的侧边栏)。
50
51如此,既在各设备上体现了UX的一致性,也在各设备上体现了UX的差异性,从而既可以保障各设备上应用界面的体验,也可以最大程度复用界面代码。
52
53<!--Del-->
54在[应用UX设计章节](../../../design/ux-design/app-ux-design.md)中,将详细介绍应用的UX设计规则。<!--DelEnd-->
55
56
57## 工程管理及调试
58
59在本文[DevEco Studio使用章节](ide-using.md)中,将详细介绍一多的工程创建及管理等,本小节仅介绍最基础的工程创建及多设备预览调试。
60
61
62### 工程创建
63
64一多应用的工程创建过程,与传统应用并无较大差异。只需在工程创建过程中,注意在“Device Type”选项中勾选所有该应用期望运行的目标设备类型,保证后续该应用可以在所有目标设备上正确安装即可。
65
66![project](figures/project.png)
67
68
69### 预览调试
70
71在代码开发过程中,可以开启预览器,并打开“Multi-profile preview”开关,实时观察应用在不同设备下的表现。
72
73![zh-cn_image_0000001384621049](figures/zh-cn_image_0000001384621049.jpg)
74
75特别的,还可以点击“+ New Profile”按钮,新增自定义预览器。
76
77![previewer](figures/previewer.jpg)
78
79
80## 页面开发
81
82天气应用中涉及较多的页面和弹窗,本小节以天气主页为例,简单介绍不同设备下的页面实现思路。
83
84  观察天气主页在不同设备上的UX设计图,可以进行如下设计:
85- 将天气主页划分为9个基础区域,如:
86  ![home_full](figures/home_full.png)
87
88- 基础区域9仅在大设备上显示,基础区域1-8虽然在各设备上始终展示但其尺寸及区域内的布局基本保持不变,可以结合[自适应布局](adaptive-layout.md)能力以[自定义组件](../../quick-start/arkts-create-custom-components.md)的形式分别实现这9个基础区域。
89    |  | 小设备 | 中设备 | 大设备 |
90  | -------- | -------- | -------- | -------- |
91  | 主页 | ![Home_sm](figures/Home_sm.png) | ![Home_md_mark](figures/Home_md_mark.png) | ![Home_lg_mark](figures/Home_lg_mark.png) |
92
93- 基础区域1-8之间的布局在不同设备上有较大差异,可以使用响应式布局中的[栅格布局](responsive-layout.md#栅格布局)能力实现组件间的布局效果。
94
95- 展开和隐藏侧边栏的功能可以通过[侧边栏组件](../../reference/apis-arkui/arkui-ts/ts-container-sidebarcontainer.md)来实现。侧边栏是大设备上独有的,借助响应式布局中的[媒体查询](responsive-layout.md#媒体查询)能力,控制仅在大设备上展示侧边栏即可。
96
97
98### 主页基础区域
99
100天气主页中的9个基础区域介绍及实现方案如下表所示。
101
102  | 编号 | 简介 | 实现方案 |
103| -------- | -------- | -------- |
104| 1 | 标题栏 | 自适应布局拉伸能力。|
105| 2 | 天气概览 | Row和Column组件,并指定其子组件按照主轴起始方向对齐或居中对齐。 |
106| 3 | 每小时天气 | 自适应布局延伸能力 。|
107| 4 | 每日天气 | 自适应布局延伸能力 。|
108| 5 | 空气质量 | Canvas画布组件绘制空气质量图,并使用Row组件和Column组件控制内部元素的布局。 |
109| 6 | 生活指数 | 自适应布局均分能力。 |
110| 7 | 日出日落 | Canvas画布组件绘制日出日落图 。|
111| 8 | 应用信息 | Row和Column组件,并指定其子组件居中对齐。 |
112| 9 | 侧边导航栏 | 综合运用自适应布局中的拉伸能力、占比能力和延伸能力 。|
113
114天气主页涉及的内容较多,因篇幅限制,本小节仅介绍区域3(每小时天气)的实现<!--Del-->,读者可以自行查看开源代码,了解其它基础区域的实现<!--DelEnd-->。
115
116延伸能力是指容器组件内的子组件,按照其在列表中的先后顺序,随容器组件尺寸变化显示或隐藏。随着可用显示区域的增加,用户可以看到的“每小时天气”信息也不断增加,故“每小时天气”可以通过延伸能力实现,其核心代码如下所示。
117
118
119```ts
120import { Forecast, getHoursData, MyDataSource, Style } from '@ohos/common';
121
122@Component
123export default struct HoursWeather {
124  private hoursData: Forecast[] = getHoursData(0);
125  @State hoursDataResource: MyDataSource = new MyDataSource(this.hoursData);
126
127  build() {
128    // 通过列表组件实现延伸能力
129    List() {
130      LazyForEach(this.hoursDataResource, (hoursItem:IDataSource) => {
131        ListItem() {
132          // 具体每个小时的天气情况
133          Column() {
134              // ...
135            }
136        }
137      })
138    }
139    .height(Style.CARD_HEIGHT)
140    .borderRadius(Style.NORMAL_RADIUS)
141    .backgroundColor(Style.CARD_BACKGROUND_COLOR)
142    // 将列表方向设置为水平方向
143    .listDirection(Axis.Horizontal)
144  }
145}
146```
147
148
149### 城市天气详情
150
151天气主页右侧的城市天气详情由区域1-8组成,区域1(标题栏)始终固定在页面顶部,区域2-8在不同设备下的布局不同且可以随页面上下滚动。本小节介绍如何实现城市天气详情中区域2~8的布局效果。
152
153设备屏幕可能无法一次性显示区域2-8的所有内容,故需要在外层增加滚动组件(即Scroll组件)以支持上下滚动。不同设备下区域2-8的相对位置一共有三套不同的布局,可以借助响应式布局中的[栅格布局](responsive-layout.md#栅格布局)实现这一效果。本示例中将栅格在不同场景下分别划分为4列、8列和12列,区域2-8在不同场景下的布局如下表所示。
154
155  | 小设备 | 中设备&nbsp;或&nbsp;大设备(侧边栏显示状态) | 大设备(侧边栏隐藏状态) |
156| -------- | -------- | -------- |
157| ![zh-cn_image_0000001395631821](figures/zh-cn_image_0000001395631821.png) | ![zh-cn_image_0000001345312038](figures/zh-cn_image_0000001345312038.png) | ![zh-cn_image_0000001349454550](figures/zh-cn_image_0000001349454550.png) |
158
159> **说明:**
160>
161> 为提升用户体验,大设备侧边栏隐藏状态下,每日天气与空气质量的相对顺序发生了改变。可以通过调整GridCol栅格子组件的order属性,实现目标效果。
162
163
164```ts
165import AirQuality from './AirQuality'; //组件请参考相关实例
166import HoursWeather from './HoursWeather';
167import IndexHeader from './IndexHeader';
168import IndexEnd from './IndexEnd';
169import LifeIndex from './LifeIndex';
170import MultidayWeather from './MultidayWeather';
171import SunCanvas from './SunCanvas';
172import { CityListData, Style } from '@ohos/common';
173
174@Component
175export default struct HomeContent {
176  private cityListData: CityListData | undefined = undefined;
177  private index: number = 1;
178  @Prop showSideBar: boolean;
179  @State headerOpacity: number = 1;
180
181  build() {
182    // 支持滚动
183    Scroll() {
184      GridRow({
185        columns: { sm: 4, md: 8, lg: this.showSideBar ? 8 : 12 },
186        gutter: { x: Style.GRID_GUTTER, y: Style.GRID_GUTTER },
187        breakpoints: { reference: BreakpointsReference.WindowSize } }) {
188        // 天气概览
189        GridCol({ span: { sm: 4, md: 8, lg: this.showSideBar ? 8 : 12 }, order: 1 }) {
190          IndexHeader({ headerDate: this.cityListData.header, index: this.index })
191            .opacity(this.headerOpacity)
192        }
193        // 每小时天气
194        GridCol({ span: { sm: 4, md: 8, lg: 8 }, order: 2 }) {
195          HoursWeather({ hoursData: this.cityListData.hoursData })
196        }
197        // 每日天气
198        GridCol({ span: 4, order: {sm: 3, md: 3, lg: this.showSideBar ? 3 : 4} }) {
199          MultidayWeather({ weekData: this.cityListData.weekData })
200        }
201        // 空气质量
202        GridCol({ span: 4, order: {sm: 4, md: 4, lg: this.showSideBar ? 4 : 3} }) {
203          AirQuality({ airData: this.cityListData.airData, airIndexData: this.cityListData.airIndex })
204        }
205        // 生活指数
206        GridCol({ span: 4, order: 5 }) {
207          LifeIndex({ lifeData: this.cityListData.suitDate })
208        }
209        // 日出日落
210        GridCol({ span: 4, order: 6 }) {
211          SunCanvas()
212        }
213        // 应用信息
214        GridCol({ span: { sm: 4, md: 8, lg: this.showSideBar ? 8 : 12 }, order: 7 }) {
215          IndexEnd()
216        }
217      }
218    }
219    .width('100%')
220  }
221}
222```
223
224
225### 主页整体实现
226
227综合考虑各设备下的效果,天气主页的根节点使用侧边栏组件:
228
229- 小设备和中设备既不展示侧边栏,也不提供控制侧边栏显示和隐藏的按钮。
230
231- 大设备默认展示侧边栏,同时提供控制侧边栏显示和隐藏的按钮。
232
233另外主页右侧的城市天气详情,支持左右滑动切换城市,可以使用Swiper组件实现目标效果。
234
235- 小设备和中设备开启Swiper组件的导航点,引导用户通过左右滑动切换不同城市。
236
237- 大设备中用户通过点击侧边栏中的城市列表即可高效的切换不同城市,此时需要关闭Swiper组件的导航点。
238
239
240```ts
241import HomeContent from './home/HomeContent'; //组件请参考相关实例
242import IndexTitleBar from './home/IndexTitleBar';
243import SideContent from './home/SideContent';
244import { CityListData,  getCityListWeatherData } from '@ohos/common';
245
246@Entry
247@Component
248struct Home {
249  @State cityListWeatherData: CityListData[] = getCityListWeatherData();
250  @State curBp: string = 'md';
251  @State showSideBar: boolean = false;
252
253  build() {
254    SideBarContainer(SideBarContainerType.Embed) {
255      // 左侧侧边栏
256      SideContent({ showSideBar: $showSideBar })
257      // 右侧内容区
258      Flex({direction: FlexDirection.Column}) {
259        // 基础区域1标题栏
260        IndexTitleBar({ curBp: this.curBp, showSideBar: $showSideBar })
261          .height(56)
262        // 天气详情,通过Swiper组件实现左右滑动切换城市的效果
263        Swiper() {
264          ForEach(this.cityListWeatherData, (item:CityListData, index) => {
265            HomeContent({ showSideBar: this.showSideBar, cityListData: item, index: index })
266          })
267        }
268        // 大设备关闭导航点
269        .indicator(this.curBp !== 'lg')
270        .width('100%')
271      }
272    }
273    .height('100%')
274    .sideBarWidth('33.3%')
275    // 通过状态变量,控制不同设备下侧边栏的显隐状态
276    .showSideBar(this.showSideBar)
277  }
278}
279```
280
281
282最终,天气首页的运行效果如下图所示。
283
284
285  | 小设备 | 中设备 | 大设备(隐藏侧边栏) | 大设备(显示侧边栏) |
286| -------- | -------- | -------- | -------- |
287| ![zh-cn_image_0000001344993822](figures/zh-cn_image_0000001344993822.jpg) | ![zh-cn_image_0000001345473362](figures/zh-cn_image_0000001345473362.jpg) | ![zh-cn_image_0000001400662385](figures/zh-cn_image_0000001400662385.png) | ![zh-cn_image_0000001395713305](figures/zh-cn_image_0000001395713305.jpg) |
288
289
290## 功能开发
291
292应用开发不仅包含应用页面开发,还包括应用后端功能开发以及服务器端开发等。服务器端开发不在本文的讨论范围内,本小节仅介绍多设备上应用功能开发的注意事项。
293
294如前文所示,本示例的目标运行设备是小设备、中设备和大设备,对应实际的设备类型为默认设备和平板等。这些设备运行的都是标准系统,其系统能力一致,所以无需做特别考虑。但是在超小设备(对应的实际设备类型为智能穿戴设备等)上,考虑CPU、内存、硬盘等硬件限制,往往会对系统进行裁剪。如果在应用后端功能开发时调用当前系统没有的能力,就可能会引发异常。
295
296通常有两种方式解决上述问题:
297
298- 在应用安装包中描述其需要的系统能力,保证本应用仅被分发和安装到可以满足其诉求的系统中。
299
300- 在使用特定系统能力前,通过canIUse接口判断系统能力是否存在,进而执行不同的逻辑。
301
302在本文的[功能开发的一多能力介绍](development-intro.md)章节中,将详细展开介绍。
303
304## 相关实例
305
306针对天气应用,有以下相关实例可供参考:
307
308天气应用:[天气应用示例](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SuperFeature/MultiDeviceAppDev/Weather)
309
310
311
312<!--no_check-->