意图框架是什么
意图框架能帮开发者将应用/元服务内的业务功能，智能分发到各系统入口，这个过程即智慧分发。其中系统入口包括：小艺对话、小艺搜索、小艺建议
001.png
意图框架分发的类型
002.png
意图的运行逻辑
003.png
004.png
意图框架接入流程
005.png
习惯推荐方案实现
当前习惯推荐可在小艺建议入口分发，在不同垂域中，填充功能详细参数或内容的逻辑不同，主要典型场景可分为常用接续、常用复访、常用推新三类。
当用户在应用/元服务内使用功能时，开发者需要按照标准意图Schema向系统共享行为数据，并支持意图调用（空调用与传参调用），以实现用户点击模板卡后跳转回对应页面。
006.png
意图注册
开发者需要编辑对应的意图配置 PROJECT_HOME/entry/src/main/resources/base/profile/insight_intent.json文件，实现意图注册。以歌曲续听推荐特性为例:
{
// 应用支持的意图列表
// 必须声明应用支持插件包含的必选意图，应用上架时会进行校验
"insightIntents": [
{
// 意图名称
// 名称应当遵循意图框架规范，当前仅支持预置垂域意图，不允许自定义
// 应用内意图名称唯一，不允许出现相同的名称定义
"intentName": "PlayMusic",
// 意图所属的垂域
"domain": "MusicDomain",
// 意图版本号
// 插件引用意图时会校验该版本号，只有和插件定义的版本号一致才能正常调用
"intentVersion": "1.0.1",
// 意图调用逻辑入口
// 根据意图调用文件实际路径和实际名称进行填写，此处文件仅做示意
"srcEntry": "./ets/entryability/InsightIntentExecutorImpl.ets",
"uiAbility": {
// 意图所在module、ability，以及代码相对路径入口
"ability": "EntryAbility",
// UIAbility支持前后台两种执行模式
"executeMode": [
"background",
"foreground"
]
}
}
]
}
端侧意图共享
构建意图对象，并且调用shareIntent()，实现意图共享。可同时构建多个PlayMusic或PlayMusicList的意图对象。
import { insightIntent } from '@kit.IntentsKit';
import { BusinessError } from '@kit.BasicServicesKit';
let playMusicIntent1: insightIntent.InsightIntent;
let playMusicIntent2: insightIntent.InsightIntent;
// 共享数据接口 意图数组可以是更多的实体
// 根据实际代码上下文自行传入合适的context
insightIntent.shareIntent(context, [playMusicIntent1, playMusicIntent2]).then(() => {
console.info('shareIntent succeed');
}).catch((err: BusinessError) => {
console.error(`error.code: ${err?.code}, failed because ${err?.message}`);
});
完整的意图共享示例如下所示，该示例构建了一个PlayMusic意图，并进行了shareIntent调用。
import { insightIntent } from '@kit.IntentsKit';
import { BusinessError } from '@kit.BasicServicesKit';
let playMusicIntent: insightIntent.InsightIntent = {
intentName: "PlayMusic",
intentVersion: "1.0",
identifier: "52dac3b0-6520-4974-81e5-25f0879449b5",
intentActionInfo: {
actionMode: "EXECUTED",
executedTimeSlots: {
executedStartTime: 1637393212000,
executedEndTime: 1637393112000,
},
currentPercentage: 50,
},
intentEntityInfo: {
entityName: "Music",
entityId: "C10194368",
entityGroupId: "C10194321312",
displayName: "测试歌曲1",
description: "NA",
logoURL: "https://www-file.abc.com/-/media/corporate/images/home/logo/abc_logo.png",
keywords: ["华为音乐", "化妆"],
rankingHint: 99,
expirationTime: 1637393212000,
metadataModificationTime: 1637393212000,
activityType: ["1", "2", "3"],
artist: ["测试歌手1", "测试歌手2"],
lyricist: ["测试词作者1", "测试词作者2"],
composer: ["测试曲作者1", "测试曲作者2"],
albumName: "测试专辑",
duration: 244000,
playCount: 100000,
musicalGenre: ["流行", "华语", "金曲", "00后"],
isPublicData: false,
}
}
// 共享数据接口 意图数组可以是更多的实体
// 根据实际代码上下文自行传入合适的context
insightIntent.shareIntent(context, [playMusicIntent]).then(() => {
console.info('shareIntent succeed');
}).catch((err: BusinessError) => {
console.error(`error.code: ${err?.code}, failed because ${err?.message}`);
});
端侧意图调用
意图执行组件为uiAbility的意图调用
步骤如下：
- 继承InsightIntentExecutor。
- 重写对应方法，例如目标拉起前台页面，则可重写onExecuteInUIAbilityForegroundMode方法。
- 通过意图名称，识别播放歌曲意图（PlayMusic），在对应的方法中传递意图参数（param），并拉起对应落地页（如歌曲落地页）。
import { insightIntent, InsightIntentExecutor } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import { BusinessError } from '@kit.BasicServicesKit';
/**
* 意图调用样例
*/
export default class InsightIntentExecutorImpl extends InsightIntentExecutor {
private static readonly PLAY_MUSIC = 'PlayMusic';
/**
* override 执行前台UIAbility意图
*
* @param name 意图名称
* @param param 意图参数
* @param pageLoader 窗口
* @returns 意图调用结果
*/
onExecuteInUIAbilityForegroundMode(name: string, param: Record<string, Object>, pageLoader: window.WindowStage):
Promise<insightIntent.ExecuteResult> {
//根据意图名称分发处理逻辑。接入方可根据实际业务实现页面跳转
switch (name) {
case InsightIntentExecutorImpl.PLAY_MUSIC:
return this.playMusic(param, pageLoader);
default:
break;
}
return Promise.resolve({
code: -1,
result: {
message: 'unknown intent'
}
} as insightIntent.ExecuteResult)
}
/**
* 实现调用播放歌曲功能
*
* @param param 意图参数
* @param pageLoader 窗口
*/
private playMusic(param: Record<string, Object>, pageLoader: window.WindowStage): Promise<insightIntent.ExecuteResult> {
return new Promise((resolve, reject) => {
let para: Record<string, string> = {
'result': JSON.stringify(param)
};
let localStorage: LocalStorage = new LocalStorage(para);
// TODO 实现意图调用，loadContent的入参为歌曲落地页路径，例如：pages/Index
pageLoader.loadContent('pages/Index', localStorage)
.then(() => {
let entityId: string = (param.items as Array<object>)?.[0]?.['entityId'];
// TODO 调用成功的情况，此处可以打印日志
resolve({
code: 0,
result: {
message: 'Intent execute succeed'
}
});
})
.catch((err: BusinessError) => {
// TODO 调用失败的情况
resolve({
code: -1,
result: {
message: 'Intent execute failed'
}
})
});
})
}
}
意图执行组件为form的意图调用
- 在意图执行绑定FormExtensionAbility的onAddForm(want: Want)中获取运行态意图框架传入的意图名（预定义keyName为ohos.insightIntent.executeParam.name）和意图执行参数（预定义keyName为ohos.insightIntent.executeParam.param）；
- 通过意图名称，识别播放歌曲意图(PlayMusic)，在对应的方法中传递意图参数（param），并加载对应数据用于卡片展示。
具体代码实现：
import { Want } from '@kit.AbilityKit';
import { formBindingData, FormExtensionAbility } from '@kit.FormKit';
/**
* 卡片意图调用示例
*/
export default class LoadCardFormAbility extends FormExtensionAbility {
onAddForm(want: Want): formBindingData.FormBindingData {
if (want?.parameters?.['ohos.insightIntent.executeParam.name'] != undefined) {
const intentName = want.parameters['ohos.insightIntent.executeParam.name']; //意图名
//TODO: 根据意图名称分发处理逻辑，若仅一个卡片意图，则可以忽略
}
if (want?.parameters?.['ohos.insightIntent.executeParam.param'] != undefined) {
const executeParameter = want.parameters['ohos.insightIntent.executeParam.param']; //意图执行参数
//TODO: 从 executeParameter 中解析具体意图执行参数，用于卡片内容展示
}
let formData = ''; //TODO: 仅示例，根据具体逻辑封装
return formBindingData.createFormBindingData(formData);
}
}
