• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 显式Want与隐式Want匹配规则
2
3
4在启动目标Ability时,会通过显式Want和隐式Want进行目标Ability的匹配,这里说的匹配规则就是调用方Want中设置的参数如何与目标Ability声明的配置文件进行匹配。
5
6
7- **显式Want匹配原理**
8    | 名称 | 类型 | 匹配项 | 必选 | 规则 |
9  | -------- | -------- | -------- | -------- | -------- |
10  | deviceId | string | 是 | 否 | 留空将仅匹配本设备内Ability。 |
11  | bundleName | string | 是 | 是 | 如果指定abilityName,而不指定bundleName,则匹配失败。 |
12  | moduleName | string | 是 | 否 | 留空时当同一个应用内存在多个模块且模块间存在重名Ability,将默认匹配第一个。 |
13  | abilityName | string | 是 | 是 | 该字段必须设置表示显式匹配。 |
14  | uri | string | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标Ability。 |
15  | type | string | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标Ability。 |
16  | action | string | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标Ability。 |
17  | entities | Array<string> | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标Ability。 |
18  | flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
19  | parameters | {[key: string]: any} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标Ability。 |
20
21- **隐式Want匹配原理**
22    | 名称 | 类型 | 匹配项 | 必选 | 规则 |
23  | -------- | -------- | -------- | -------- | -------- |
24  | deviceId | string | 是 | 否 | 跨设备目前不支持隐式调用。 |
25  | abilityName | string | 否 | 否 | 该字段必须留空表示隐式匹配。 |
26  | bundleName | string | 是 | 否 | -&nbsp;声明bundleName时,隐式搜索将仅限于对应应用包内。<br/>-&nbsp;声明bundleName与moduleName时,隐式搜索将仅限于对应应用的对应Module内。<br/>-&nbsp;单独声明moduleName时,该字段无效。<br/>-&nbsp;同时声明bundleName与moduleName时,隐式搜索将仅限于对应应用包内的对应模块内。<br/>这些字段将用来隐式匹配,具体规则可参考[隐式Want匹配原理详解](#隐式want匹配原理详解)。 |
27  | moduleName | string | 是 | 否 |
28  | uri | string | 是 | 否 |
29  | type | string | 是 | 否 |
30  | action | string | 是 | 否 |
31  | entities | Array&lt;string&gt; | 是 | 否 |
32  | flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
33  | parameters | {[key:&nbsp;string]:&nbsp;any} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标Ability。 |
34
35
36## 隐式Want匹配原理详解
37
38
39从隐式Want的定义,可得知:
40
41
42- 调用方传入的want参数,表明调用方需要执行的操作,并提供相关数据以及其他应用类型限制。
43
44- 待匹配Ability的skills配置,声明其具备的能力([module.json5配置文件](../quick-start/module-configuration-file.md)中的[skills标签](../quick-start/module-configuration-file.md#skills标签)参数)。
45
46
47系统将调用方传入的want参数(包含action、entities、uri和type属性)与已安装待匹配的应用Ability的skills配置(包含actions、entities、uris和type属性)依次进行匹配。当四个属性匹配均通过,则此应用才会被应用选择器展示给用户进行选择。
48
49
50### want参数的action匹配规则
51
52将调用方传入的want参数的action与待匹配Ability的skills配置中的actions进行匹配。
53
54- 调用方传入的want参数的action不为空,待匹配Ability的skills配置中的actions为空,则action匹配失败。
55
56- 调用方传入的want参数的action为空,待匹配Ability的skills配置中的actions不为空,则action匹配成功。
57
58- 调用方传入的want参数的action不为空,待匹配Ability的skills配置中的actions不为空且包含调用方传入的want参数的action,则action匹配成功。
59
60- 调用方传入的want参数的action不为空,待匹配Ability的skills配置中的actions不为空且不包含调用方传入的want参数的action,则action匹配失败。
61
62  **图1** want参数的action匹配规则
63
64  ![want-action](figures/want-action.png)
65
66
67### want参数的entities匹配规则
68
69将调用方传入的want参数的entities与待匹配Ability的skills配置中的entities进行匹配。
70
71- 调用方传入的want参数的entities为空,待匹配Ability的skills配置中的entities不为空,则entities匹配成功。
72
73- 调用方传入的want参数的entities为空,待匹配Ability的skills配置中的entities为空,则entities匹配成功。
74
75- 调用方传入的want参数的entities不为空,待匹配Ability的skills配置中的entities为空,则entities匹配失败。
76
77- 调用方传入的want参数的entities不为空,待匹配Ability的skills配置中的entities不为空且包含调用方传入的want参数的entities,则entities匹配成功。
78
79- 调用方传入的want参数的entities不为空,待匹配Ability的skills配置中的entities不为空且不完全包含调用方传入的want参数的entities,则entities匹配失败。
80
81  **图2** want参数的entities匹配规则
82
83  ![want-entities](figures/want-entities.png)
84
85
86### want参数的uri和type匹配规则
87
88调用方传入的want参数中设置uri和type参数发起组件启动请求,系统会遍历当前系统已安装的组件列表,并逐个匹配待匹配Ability的skills配置中的uris数组,如果待匹配Ability的skills配置中的uris数组中只要有一个可以匹配调用方传入的want参数中设置的uri和type即为匹配成功。
89
90
91实际应用中,uri和type共存在四种情况,下面将讲解四种情况的具体匹配规则:
92
93- 调用方传入的want参数的uri和type都为空。
94  1. 如果待匹配Ability的skills配置中的uris数组为空,匹配成功。
95  2. 如果待匹配Ability的skills配置中的uris数组中存在uri的scheme和type都为空的元素,匹配成功。
96  3. 除以上两种情况,其他情况均为匹配失败。
97
98- 调用方传入的want参数的uri不为空,type为空。
99  1. 如果待匹配Ability的skills配置中的uris数组为空,匹配失败。
100  2. 如果待匹配Ability的skills配置中的uris数组存在一条数据[uri匹配](#uri匹配规则)成功且type为空,则匹配成功,否则匹配失败。
101
102- 调用方传入的want参数的uri为空,type不为空。
103  1. 如果待匹配Ability的skills配置中的uris数组为空,匹配失败。
104  2. 如果待匹配Ability的skills配置中的uris数组存在一条数据uri的scheme为空且[type匹配](#type匹配规则)成功,则匹配成功,否则匹配失败。
105
106- 调用方传入的want参数的uri和type都不为空,如图3所示。
107  1. 如果待匹配Ability的skills配置中的uris数组为空,匹配失败。
108  2. 如果待匹配Ability的skills配置中的uris数组存在一条数据[uri匹配](#uri匹配规则)和[type匹配](#type匹配规则)需要均匹配成功,则匹配成功,否则匹配失败。
109
110最左uri匹配:当配置文件待匹配Ability的skills配置中的uris数组中只配置scheme;或者只配置scheme和host;或者只配置scheme,host和port时。
111传入want参数的uri的最左边依次需要和scheme;或者scheme和host;或者scheme,host,port都匹配,才满足最左uri匹配。
112
113  **图3** want参数中uri和type皆不为空时的匹配规则
114
115  ![want-uri-type1](figures/want-uri-type1.png)
116
117下图为了简化描述,称want中传入的uri为w_uri,称want中传入的type为w_type, 待匹配Ability的skills配置中uris为s_uris,其中每个元素为s_uri;按自上而下顺序匹配。
118
119
120  **图4** want参数中uri和type的具体匹配规则
121
122![want-uri-type2](figures/want-uri-type2.png)
123
124
125### uri匹配规则
126
127这里为了简化描述,称want中传入的uri为w_uri,待匹配Ability的skills配置中uri为s_uri,具体的匹配规则如下:
128
129- 如果s_uri的scheme为空,当w_uri为空时匹配成功,否则匹配失败;
130
131- 如果s_uri的host为空,当w_uri和s_uri的scheme相同时匹配成功,否则匹配失败;
132
133- 如果s_uri的port为空,当w_uri和s_uri中的scheme和host相同时匹配成功,否则匹配失败;
134
135- 如果s_uri的path、pathStartWith和pathRegex都为空,当w_uri和s_uri中的scheme,host和port相同时匹配成功,否则匹配失败;
136
137- 如果s_uri的path不为空,当w_uri和s_uri**全路径表达式**相同时匹配成功,否则继续进行pathStartWith的匹配;
138
139- 如果s_uri的pathStartWith不为空,当w_uri包含s_uri**前缀表达式**时匹配成功,否则继续进行pathRegex的匹配;
140
141- 如果s_uri的pathRegex不为空,当w_uri满足s_uri**正则表达式**时匹配成功,否则匹配失败;
142
143> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
144> 待匹配Ability的skills配置的uris中scheme、host、port、path、pathStartWith和pathRegex属性拼接,如果依次声明了path、pathStartWith和pathRegex属性时,uris将分别拼接为如下三种表达式:
145>
146> - **全路径表达式**:scheme://host:port/path
147>
148> - **前缀表达式**:scheme://host:port/pathStartWith
149>
150> - **正则表达式**:scheme://host:port/pathRegex
151>
152> - **前缀uri表达式**:当配置文件只配置scheme,或者只配置scheme和host,或者只配置scheme,host和port时,参数传入以配置文件为前缀的Uri
153>     * `scheme://`
154>     * `scheme://host`
155>     * `scheme://host:port`
156
157### type匹配规则
158
159> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
160> 此小节所述的type匹配规则的适用性需建立在want参数内type不为空的基础上。当want参数内type为空时请参考[want参数的uri和type匹配规则](#want参数的uri和type匹配规则)。
161
162这里为了简化描述,称want中传入的uri为w_type,待匹配Ability的skills数组中uris的type数据为s_type,具体的匹配规则如下:
163
164- 如果s_type为空,则匹配失败。
165
166- 如果s_type或者w_type为通配符"\*/\*",则匹配成功。
167
168- 如果s_type最后一个字符为通配符'\*',如"prefixType/\*",则当w_type包含"prefixType/"时匹配成功,否则匹配失败。
169
170- 如果w_type最后一个字符为通配符'\*',如"prefixType/\*",则当s_type包含"prefixType/"时匹配成功,否则匹配失败。
171