使用配置文件开发意图

简介

从API version 11及以上版本，支持通过配置文件开发意图。主要包含两个环节：

1. 通过insight_intent.json配置文件定义意图，声明意图执行器的代码路径、绑定的Ability组件等意图信息。

2. 通过InsightIntentExecutor实现意图执行逻辑。

不同Ability组件类型需要配置的字段与需要实现的意图执行器，如下所示：

接口说明

意图执行器实现需要继承InsightIntentExecutor，实现onExecuteInUIAbilityForegroundMode等方法。开发者响应意图执行通过onExecuteInUIAbilityForegroundMode等接口实现，在不同的意图执行模式下，接口的触发时机也不同。针对不同意图执行模式的意图回调执行时机见各个回调的API说明。

开发步骤

意图绑定UIAbility组件

通过DevEco Studio工具可视化创建意图，操作及开发步骤如下。

1. 选中模块或模块下的文件，右键单击New > Insight Intent，进入意图框架配置界面。

2. 选择意图垂域、意图框架入口代码文件名以及意图配置。意图配置包含意图名称和绑定的Ability组件。

3. 点击Finish，完成意图框架创建。

   此时将在module目录 > src > main > resources > base > profile中，生成insight_intent.json文件，可在该文件查看当前意图框架配置的相关信息。

   {
     "insightIntents": [
       {
         "domain": "MusicDomain",
         "intentName": "PlayMusic",
         "intentVersion": "1.0.1",
         "srcEntry": "./ets/insightintents/PlayMusicExecutor.ets",
         "uiAbility": {
           "ability": "MusicPlayerAbility",
           "executeMode": [
             "foreground",
             "background"
           ]
         }
       }
     ]
   }
   

4. 在module目录 > src > main > ets > insightintents目录下生成入口代码文件。开发者在意图执行函数中实现意图的功能代码。

   // 本示例对应意图配置中的'srcEntry'字段对应的文件
   import { InsightIntentExecutor, insightIntent } from '@kit.AbilityKit';
   import { window } from '@kit.ArkUI';
   // ···
   
   export default class PlayMusicExecutor extends InsightIntentExecutor {
     // 由于意图配置中'executeMode'配置了'foreground'前台模式执行，故需要实现该接口
     async onExecuteInUIAbilityForegroundMode(intentName: string, params: Record<string, Object>,
       windowStage: window.WindowStage): Promise<insightIntent.ExecuteResult> {
       // 实现播放逻辑
       // ···
       const result: insightIntent.ExecuteResult = {
         code: 0
       };
       return Promise.resolve(result);
     }
   
     // 由于意图配置中'executeMode'配置了'background'后台模式执行，故需要实现该接口
     async onExecuteInUIAbilityBackgroundMode(intentName: string,
       params: Record<string, Object>): Promise<insightIntent.ExecuteResult> {
       // 后台控制逻辑
       const result: insightIntent.ExecuteResult = {
         code: 0
       };
       return Promise.resolve(result);
     }
   }
   

   PlayMusicExecutor.ets

说明：

配置文件范式仅提供基础执行能力，参数格式需开发者与系统入口协商。

开发者也可以选择按规范手动创建意图配置文件和意图执行器。需要关注如下注意点：

• 必须声明绑定的Ability组件和支持的意图执行模式。
• 配置文件必须命名为"insight_intent.json"。
• 配置文件存放路径为"resources/base/profile"。
• 配置文件关键字段遵循相应的约束。

意图绑定UIExtensionAbility组件

参考意图绑定UIAbility组件完成工程创建。

意图配置示例：

{
  "insightIntents": [
    {
      "domain": "MusicDomain",
      "intentName": "PlayMusic",
      "intentVersion": "1.0.1",
      "srcEntry": "./ets/insightintents/ExtensionExecutor.ets",
      "uiExtension": {
        "ability": "MusicExtensionAbility"
      }
    }
  ]
}

意图执行器实现：

import { InsightIntentExecutor, insightIntent, UIExtensionContentSession } from '@kit.AbilityKit';

export default class ExtensionExecutor extends InsightIntentExecutor {
  // 由于意图配置了uiExtension，故需要实现该接口
  async onExecuteInUIExtensionAbility(name: string, param: Record<string, Object>,
    pageLoader: UIExtensionContentSession): Promise<insightIntent.ExecuteResult> {
    const result: insightIntent.ExecuteResult = {
      code: 0
    };
    return Promise.resolve(result);
  }
}

系统入口通过UIExtensionComponent组件执行该意图。

意图绑定ServiceExtensionAbility组件

参考意图绑定UIAbility组件完成工程创建。

意图配置示例：

{
  "insightIntents": [
    {
      "domain": "MusicDomain",
      "intentName": "PlayMusic",
      "intentVersion": "1.0.1",
      "srcEntry": "./ets/insightintents/DownloadExecutor.ets",
      "serviceExtension": {
        "ability": "DownloadService"
      }
    }
  ]
}

意图执行器实现：

import { InsightIntentExecutor, insightIntent } from '@kit.AbilityKit';

export default class DownloadExecutor extends InsightIntentExecutor {
  // 由于意图配置了serviceExtension，故需要实现该接口
  async onExecuteInServiceExtensionAbility(name: string,
    param: Record<string, Object>): Promise<insightIntent.ExecuteResult> {
    const result: insightIntent.ExecuteResult = {
      code: 0
    };
    return Promise.resolve(result);
  }
}

系统入口通过startServiceExtensionAbility方式执行该意图。

意图绑定卡片

参考意图绑定UIAbility组件完成工程创建。

意图配置示例：

{
  "insightIntents": [
    {
      "domain": "MusicDomain",
      "intentName": "PlayMusic",
      "intentVersion": "1.0.1",
      "srcEntry": "./ets/insightintents/WidgetExecutor.ets",
      "form": {
        "ability": "PlayerWidgetAbility",
        "formName": "mini_player"
      }
    }
  ]
}

系统入口通过FormComponent组件展示卡片内容。

insight_intent.json配置文件说明

意图配置文件insight_intent.json位于工程的"resources/base/profile"目录，用于声明意图配置信息。其中，"insightIntents"数组包含通过配置文件开发的所有意图配置信息，数组中的属性如下：