1# UIAbility组件启动模式
2
3
4[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)的启动模式是指UIAbility实例在启动时的不同呈现状态。针对不同的业务场景，系统提供了三种启动模式：
5
6
7- [singleton（单实例模式）](#singleton启动模式)
8
9- [multiton（多实例模式）](#multiton启动模式)
10
11- [specified（指定实例模式）](#specified启动模式)
12
13> **说明：**
14>
15> `standard`是`multiton`的曾用名，效果与多实例模式一致。
16
17## singleton启动模式
18
19singleton启动模式为单实例模式，也是默认情况下的启动模式。
20
21每次调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法时，如果应用进程中该类型的[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)实例已经存在，则复用系统中的UIAbility实例。系统中只存在唯一一个该UIAbility实例，即在最近任务列表中只存在一个该类型的UIAbility实例。
22
23**图1** 单实例模式演示效果  
24![uiability-launch-type1](figures/uiability-launch-type1.gif)  
25
26> **说明**：
27>
28> 应用的UIAbility实例已创建，该UIAbility配置为单实例模式，再次调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法启动该UIAbility实例。由于启动的还是原来的UIAbility实例，并未重新创建一个新的UIAbility实例，此时只会进入该UIAbility的[onNewWant()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityonnewwant)回调，不会进入其[onCreate()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityoncreate)和[onWindowStageCreate()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityonwindowstagecreate)生命周期回调。
29
30如果需要使用singleton启动模式，在[module.json5配置文件](../quick-start/module-configuration-file.md)中的`launchType`字段配置为`singleton`即可。
31
32
33```json
34{
35  "module": {
36    // ...
37    "abilities": [
38      {
39        "launchType": "singleton",
40        // ...
41      }
42    ]
43  }
44}
45```
46
47
48## multiton启动模式
49
50multiton启动模式为多实例模式，每次调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法时，都会在应用进程中创建一个新的该类型[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)实例。即在最近任务列表中可以看到有多个该类型的UIAbility实例。这种情况下可以将UIAbility配置为multiton（多实例模式）。
51
52**图2** 多实例模式演示效果  
53![uiability-launch-type2](figures/uiability-launch-type2.gif)  
54
55multiton启动模式的开发使用，在[module.json5配置文件](../quick-start/module-configuration-file.md)中的`launchType`字段配置为`multiton`即可。
56
57
58```json
59{
60  "module": {
61    // ...
62    "abilities": [
63      {
64        "launchType": "multiton",
65        // ...
66      }
67    ]
68  }
69}
70```
71
72
73## specified启动模式
74
75specified启动模式为指定实例模式，针对一些特殊场景使用（例如文档应用中每次新建文档希望都能新建一个文档实例，重复打开一个已保存的文档希望打开的都是同一个文档实例）。
76
77**图3** 指定实例模式演示效果   
78![uiability-launch-type3](figures/uiability-launch-type3.gif)  
79
80例如有两个[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)：EntryAbility和SpecifiedAbility，SpecifiedAbility配置为指定实例模式启动，需要从EntryAbility的页面中启动SpecifiedAbility。
81
821. 在SpecifiedAbility中，将[module.json5配置文件](../quick-start/module-configuration-file.md)的`launchType`字段配置为`specified`。
83
84   ```json
85   {
86     "module": {
87       // ...
88       "abilities": [
89         {
90           "launchType": "specified",
91           // ...
92         }
93       ]
94     }
95   }
96   ```
97
982. 在创建UIAbility实例之前，开发者可以为该实例指定一个唯一的字符串Key，这样在调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法时，应用就可以根据指定的Key来识别响应请求的UIAbility实例。在EntryAbility中，调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法时，可以在[want](../reference/apis-ability-kit/js-apis-app-ability-want.md)参数中增加一个自定义参数，例如`instanceKey`，以此来区分不同的UIAbility实例。
99
100   ```ts
101    // 在启动指定实例模式的UIAbility时，给每一个UIAbility实例配置一个独立的Key标识
102    // 例如在文档使用场景中，可以用文档路径作为Key标识
103    import { common, Want } from '@kit.AbilityKit';
104    import { hilog } from '@kit.PerformanceAnalysisKit';
105    import { BusinessError } from '@kit.BasicServicesKit';
106
107    const TAG: string = '[Page_StartModel]';
108    const DOMAIN_NUMBER: number = 0xFF00;
109
110    function getInstance(): string {
111      return 'KEY';
112    }
113
114    @Entry
115    @Component
116    struct Page_StartModel {
117      private KEY_NEW = 'KEY';
118
119      build() {
120        Row() {
121          Column() {
122            // ...
123            Button()// ...
124              .onClick(() => {
125                let context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
126                // context为调用方UIAbility的UIAbilityContext;
127                let want: Want = {
128                  deviceId: '', // deviceId为空表示本设备
129                  bundleName: 'com.samples.stagemodelabilitydevelop',
130                  abilityName: 'SpecifiedFirstAbility',
131                  moduleName: 'entry', // moduleName非必选
132                  parameters: {
133                    // 自定义信息
134                    instanceKey: this.KEY_NEW
135                  }
136                };
137                context.startAbility(want).then(() => {
138                  hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in starting SpecifiedAbility.');
139                }).catch((err: BusinessError) => {
140                  hilog.error(DOMAIN_NUMBER, TAG, `Failed to start SpecifiedAbility. Code is ${err.code}, message is ${err.message}`);
141                })
142                this.KEY_NEW = this.KEY_NEW + 'a';
143              })
144            // ...
145            Button()// ...
146              .onClick(() => {
147                let context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
148                // context为调用方UIAbility的UIAbilityContext;
149                let want: Want = {
150                  deviceId: '', // deviceId为空表示本设备
151                  bundleName: 'com.samples.stagemodelabilitydevelop',
152                  abilityName: 'SpecifiedSecondAbility',
153                  moduleName: 'entry', // moduleName非必选
154                  parameters: {
155                    // 自定义信息
156                    instanceKey: getInstance()
157                  }
158                };
159                context.startAbility(want).then(() => {
160                  hilog.info(DOMAIN_NUMBER, TAG, 'Succeeded in starting SpecifiedAbility.');
161                }).catch((err: BusinessError) => {
162                  hilog.error(DOMAIN_NUMBER, TAG, `Failed to start SpecifiedAbility. Code is ${err.code}, message is ${err.message}`);
163                })
164                this.KEY_NEW = this.KEY_NEW + 'a';
165              })
166            // ...
167          }
168          .width('100%')
169        }
170        .height('100%')
171      }
172    }
173   ```
174   
1753. 由于SpecifiedAbility的启动模式被配置为指定实例启动模式，因此在SpecifiedAbility启动之前，会先进入对应的AbilityStage的[onAcceptWant()](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md#abilitystageonacceptwant)生命周期回调中，以获取该[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)实例的Key值。然后系统会自动匹配，如果存在与该UIAbility实例匹配的Key，则会启动与之绑定的UIAbility实例，并进入该UIAbility实例的[onNewWant()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityonnewwant)回调函数；否则会创建一个新的UIAbility实例，并进入该UIAbility实例的[onCreate()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityoncreate)回调函数和[onWindowStageCreate()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityonwindowstagecreate)回调函数。
176
177   示例代码中，通过实现[onAcceptWant()](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md#abilitystageonacceptwant)生命周期回调函数，解析传入的[want](../reference/apis-ability-kit/js-apis-app-ability-want.md)参数，获取自定义参数`instanceKey`。业务逻辑会根据这个参数返回一个字符串Key，用于标识当前UIAbility实例。如果返回的Key已经对应一个已启动的UIAbility实例，系统会将该UIAbility实例拉回前台并获焦，而不会创建新的实例。如果返回的Key没有对应已启动的UIAbility实例，则系统会创建新的UIAbility实例并启动。
178
179   ```ts
180    import { AbilityStage, Want } from '@kit.AbilityKit';
181
182    export default class MyAbilityStage extends AbilityStage {
183      onAcceptWant(want: Want): string {
184        // 在被调用方的AbilityStage中，针对启动模式为specified的UIAbility返回一个UIAbility实例对应的一个Key值
185        // 当前示例指的是module1 Module的SpecifiedAbility
186        if (want.abilityName === 'SpecifiedFirstAbility' || want.abilityName === 'SpecifiedSecondAbility') {
187          // 返回的字符串Key标识为自定义拼接的字符串内容
188          if (want.parameters) {
189            return `SpecifiedAbilityInstance_${want.parameters.instanceKey}`;
190          }
191        }
192        // ...
193        return 'MyAbilityStage';
194      }
195    }
196   ```
197
198   > **说明：**
199   >
200   > 1. 当应用的UIAbility实例已经被创建，并且配置为指定实例模式时，如果再次调用[startAbility()](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)方法启动该UIAbility实例，且[AbilityStage](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md)的[onAcceptWant()](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md#abilitystageonacceptwant)回调匹配到一个已创建的UIAbility实例，则系统会启动原来的UIAbility实例，并且不会重新创建一个新的UIAbility实例。此时，该UIAbility实例的onNewWant()回调会被触发，而不会触发onCreate()和onWindowStageCreate()生命周期回调。
201   > 2. DevEco Studio默认工程中未自动生成AbilityStage，AbilityStage文件的创建请参见[AbilityStage组件容器](abilitystage.md)。
202
203   例如在文档应用中，可以为不同的文档实例内容绑定不同的Key值。每次新建文档时，可以传入一个新的Key值（例如可以将文件的路径作为一个Key标识），此时[AbilityStage](../reference/apis-ability-kit/js-apis-app-ability-abilityStage.md)中启动[UIAbility](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md)时都会创建一个新的UIAbility实例；当新建的文档保存之后，回到桌面，或者新打开一个已保存的文档，回到桌面，此时再次打开该已保存的文档，此时AbilityStage中再次启动该UIAbility时，打开的仍然是之前原来已保存的文档界面。
204
205   以如下步骤所示进行举例说明。
206
207   1. 打开`文件A`，对应启动一个新的UIAbility实例，例如启动`UIAbility实例1`。
208   2. 在最近任务列表中关闭`文件A`的任务进程，此时`UIAbility实例1`被销毁，回到桌面，再次打开`文件A`，此时对应启动一个新的UIAbility实例，例如启动`UIAbility实例2`。
209   3. 回到桌面，打开`文件B`，此时对应启动一个新的UIAbility实例，例如启动`UIAbility实例3`。
210   4. 回到桌面，再次打开`文件A`，此时仍然启动之前的`UIAbility实例2`，因为系统会自动匹配UIAbility实例的Key值，如果存在与之匹配的Key，则会启动与之绑定的UIAbility实例。在此例中，之前启动的`UIAbility实例2`与`文件A`绑定的Key是相同的，因此系统会拉回`UIAbility实例2`并让其获焦，而不会创建新的实例。
211
212## 相关实例
213
214针对UIAbility组件启动模式，有以下相关实例可供参考：
215
216- [Ability的启动模式（ArkTS）(API9)](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/ApplicationModels/AbilityStartMode)
217<!--RP1-->
218<!--RP1End-->