- 需要申请
ohos.permission.DISTRIBUTED_DATASYNC权限,配置方式请参见 配置文件权限声明 。 - 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见 向用户申请授权 。
- 获取目标设备的设备ID。
import deviceManager from '@ohos.distributedDeviceManager';
let dmClass: deviceManager.DeviceManager; function initDmClass() { // 其中createDeviceManager接口为系统API try{ dmClass = deviceManager.createDeviceManager('ohos.samples.demo'); } catch(err) { console.error("createDeviceManager err: " + JSON.stringify(err)); } } function getRemoteDeviceId(): string|undefined { if (typeof dmClass === 'object' && dmClass !== null) { let list = dmClass.getAvailableDeviceListSync(); if (typeof (list) === 'undefined'||typeof (list.length) === 'undefined') { console.info('getRemoteDeviceId err: list is null'); return; } if (list.length === 0) { console.info("getRemoteDeviceId err: list is empty"); return; } return list[0].networkId; } else { console.info('getRemoteDeviceId err: dmClass is null'); return; } }
- 设置目标组件参数,调用
startAbility()接口,启动UIAbility或ServiceExtensionAbility。
import { BusinessError } from '@ohos.base'; import Want from '@ohos.app.ability.Want'; let want: Want = { deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', abilityName: 'EntryAbility', moduleName: 'entry', // moduleName非必选 } // context为发起端UIAbility的AbilityContext this.context.startAbility(want).then(() => { // ... }).catch((err: BusinessError) => { // ... console.error("startAbility err: " + JSON.stringify(err)); })
- 当设备A发起端应用不需要设备B上的ServiceExtensionAbility时,可调用stopServiceExtensionAbility 接口退出。(该接口不支持UIAbility的退出,UIAbility由用户手动通过任务管理退出)
import Want from '@ohos.app.ability.Want'; import { BusinessError } from '@ohos.base'; let want: Want = { deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', moduleName: 'module1', // moduleName非必选 } // 退出由startAbility接口启动的ServiceExtensionAbility this.context.stopServiceExtensionAbility(want).then(() => { console.info("stop service extension ability success") }).catch((err: BusinessError) => { console.info("stop service extension ability err is " + JSON.stringify(err)) })
通过跨设备启动UIAbility组件实现多端协同(获取返回数据)
在设备A上通过应用提供的启动按钮,启动设备B上指定的UIAbility,当设备B上的UIAbility退出后,会将返回值发回设备A上的发起端应用。
接口说明
表2 跨设备启动,返回结果数据API接口功能描述
| 接口名 | 描述 |
|---|---|
| startAbilityForResult(want: Want, callback: AsyncCallback): void; | 启动UIAbility并在该Ability退出的时候返回执行结果(callback形式)。 |
| terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; | 停止UIAbility,配合startAbilityForResult使用,返回给接口调用方AbilityResult信息(callback形式)。 |
| terminateSelfWithResult(parameter: AbilityResult): Promise; | 停止UIAbility,配合startAbilityForResult使用,返回给接口调用方AbilityResult信息(promise形式)。 |
开发步骤
- 需要申请
ohos.permission.DISTRIBUTED_DATASYNC权限,配置方式请参见 配置文件权限声明 。 - 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见 向用户申请授权。
- 在发起端设置目标组件参数,调用startAbilityForResult()接口启动目标端UIAbility,异步回调中的data用于接收目标端UIAbility停止自身后返回给调用方UIAbility的信息。getRemoteDeviceId方法参照 通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据 。
import AbilityConstant from '@ohos.app.ability.AbilityConstant'; import common from '@ohos.app.ability.common'; import { BusinessError } from '@ohos.base'; import Want from '@ohos.app.ability.Want'; @Entry @Component struct PageName { private context = getContext(this) as common.UIAbilityContext; build() { // ... Button('StartAbilityForResult') .onClick(()=>{ let want: Want = { deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', moduleName: 'module1', // moduleName非必选 } // context为发起端UIAbility的AbilityContext this.context.startAbilityForResult(want).then((data) => { // ... }).catch((error: BusinessError) => { console.info("startAbilityForResult err: " + JSON.stringify(error)); }) } ) } }
- 在目标端UIAbility任务完成后,调用terminateSelfWithResult()方法,将数据返回给发起端的UIAbility。
import { BusinessError } from '@ohos.base'; import common from '@ohos.app.ability.common'; @Entry @Component struct PageName { private context = getContext(this) as common.UIAbilityContext; build() { // ... Button('terminateSelfWithResult') .onClick(()=>{ const RESULT_CODE: number = 1001; // context为目标端UIAbility的AbilityContext this.context.terminateSelfWithResult( { resultCode: RESULT_CODE, want: { bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', moduleName: 'module1', }, }, (err: BusinessError) => { // ... console.info("terminateSelfWithResult err: " + JSON.stringify(err)); }); } // ... ) } }
- 发起端UIAbility接收到目标端UIAbility返回的信息,对其进行处理。
import common from '@ohos.app.ability.common'; import { BusinessError } from '@ohos.base'; import Want from '@ohos.app.ability.Want'; @Entry @Component struct PageName { private context = getContext(this) as common.UIAbilityContext; build() { // ... Button('StartAbilityForResult') .onClick(()=>{ let want: Want = { deviceId: getRemoteDeviceId(), bundleName: 'com.example.myapplication', abilityName: 'FuncAbility', moduleName: 'module1', // moduleName非必选 } const RESULT_CODE: number = 1001; // ... // context为调用方UIAbility的UIAbilityContext this.context.startAbilityForResult(want).then((data) => { if (data?.resultCode === RESULT_CODE) { // 解析目标端UIAbility返回的信息 let info = data.want?.parameters?.info; // ... } }).catch((error: BusinessError) => { // ... }) } ) } }
通过跨设备连接ServiceExtensionAbility组件实现多端协同
系统应用可以通过 connectServiceExtensionAbility() 跨设备连接一个服务,实现跨设备远程调用。比如:分布式游戏场景,平板作为遥控器,智慧屏作为显示器。
接口说明
表3 跨设备连接API接口功能介绍
| 接口名 | 描述 |
|---|---|
| connectServiceExtensionAbility(want: Want, options: ConnectOptions): number; | 连接ServiceExtensionAbility。 |
| disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback): void; | 断开连接(callback形式)。 |
| disconnectServiceExtensionAbility(connection: number): Promise; | 断开连接(promise形式)。 |
开发步骤
- 需要申请
ohos.permission.DISTRIBUTED_DATASYNC权限,配置方式请参见配置文件权限声明。 - 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见向用户申请授权。
- 如果已有后台服务,请直接进入下一步;如果没有,则 实现一个后台服务 。
- 连接一个后台服务。
- 实现IAbilityConnection接口。IAbilityConnection提供了以下方法供开发者实现:onConnect()是用来处理连接Service成功的回调,onDisconnect()是用来处理Service异常终止的回调,onFailed()是用来处理连接Service失败的回调。
- 设置目标组件参数,包括目标设备ID、Bundle名称、Ability名称。
- 调用connectServiceExtensionAbility发起连接。
- 连接成功,收到目标设备返回的服务句柄。
- 进行跨设备调用,获得目标端服务返回的结果。
import rpc from '@ohos.rpc';
import Want from '@ohos.app.ability.Want';
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
@Entry
@Component
struct PageName {
private context = getContext(this) as common.UIAbilityContext;
build() {
// ...
Button('connectServiceExtensionAbility')
.onClick(()=>{
const REQUEST_CODE = 99;
let want: Want = {
"deviceId": getRemoteDeviceId(),
"bundleName": "com.example.myapplication",
"abilityName": "ServiceExtAbility"
};
// 建立连接后返回的Id需要保存下来,在解绑服务时需要作为参数传入
let connectionId = this.context.connectServiceExtensionAbility(want,
{
onConnect(elementName, remote) {
console.info('onConnect callback');
if (remote === null) {
console.info(onConnect remote is null);
return;
}
let option = new rpc.MessageOption();
let data = new rpc.MessageSequence();
let reply = new rpc.MessageSequence();
data.writeInt(1);
data.writeInt(99); // 开发者可发送data到目标端应用进行相应操作
// @param code 表示客户端发送的服务请求代码。
// @param data 表示客户端发送的{@link MessageSequence}对象。
// @param reply 表示远程服务发送的响应消息对象。
// @param options 指示操作是同步的还是异步的。
//
// @return 如果操作成功返回{@code true}; 否则返回 {@code false}。
remote.sendMessageRequest(REQUEST_CODE, data, reply, option).then((ret: rpc.RequestResult) => {
let msg = reply.readInt(); // 在成功连接的情况下,会收到来自目标端返回的信息(100)
console.info(sendRequest ret:${ret} msg:${msg});
}).catch((error: BusinessError) => {
console.info('sendRequest failed');
});
},
onDisconnect(elementName) {
console.info('onDisconnect callback');
},
onFailed(code) {
console.info('onFailed callback');
}
});
})
}
}
getRemoteDeviceId方法参照 通过跨设备启动uiability和serviceextensionability组件实现多端协同无返回数据 。
- 断开连接。调用disconnectServiceExtensionAbility()断开与后台服务的连接。
import common from '@ohos.app.ability.common'; import { BusinessError } from '@ohos.base'; @Entry @Component struct PageName { private context = getContext(this) as common.UIAbilityContext; build() { // ... Button('disconnectServiceExtensionAbility') .onClick(()=>{ let connectionId: number = 1 // 在通过connectServiceExtensionAbility绑定服务时返回的Id this.context.disconnectServiceExtensionAbility(connectionId).then(() => { console.info('disconnectServiceExtensionAbility success'); }).catch((error: BusinessError) => { console.error('disconnectServiceExtensionAbility failed'); }) }) } }
通过跨设备Call调用实现多端协同
跨设备Call调用的基本原理与设备内Call调用相同,请参见 通过Call调用实现UIAbility交互(仅对系统应用开放)。
下面介绍跨设备Call调用实现多端协同的方法。
接口说明
表4 Call API接口功能介绍
| 接口名 | 描述 |
|---|---|
| startAbilityByCall(want: Want): Promise; | 启动指定UIAbility至前台或后台,同时获取其Caller通信接口,调用方可使用Caller与被启动的Ability进行通信。 |
| on(method: string, callback: CalleeCallBack): void | 通用组件Callee注册method对应的callback方法。 |
| off(method: string): void | 通用组件Callee解注册method的callback方法。 |
| call(method: string, data: rpc.Parcelable): Promise | 向通用组件Callee发送约定序列化数据。 |
| callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageSequence> | 向通用组件Callee发送约定序列化数据, 并将Callee返回的约定序列化数据带回。 |
| release(): void | 释放通用组件的Caller通信接口。 |
| on(type: “release”, callback: OnReleaseCallback): void | 注册通用组件通信断开监听通知。 |
开发步骤
- 需要申请
ohos.permission.DISTRIBUTED_DATASYNC权限,配置方式请参见 配置文件权限声明 。 - 同时需要在应用首次启动时弹窗向用户申请授权,使用方式请参见 向用户申请授权 。
- 创建被调用端UIAbility。 被调用端UIAbility需要实现指定方法的数据接收回调函数、数据的序列化及反序列化方法。在需要接收数据期间,通过on接口注册监听,无需接收数据时通过off接口解除监听。
- 配置UIAbility的启动模式。 配置module.json5,将CalleeAbility配置为单实例”singleton”。
| Json字段 | 字段说明 |
|---|---|
| “launchType” | Ability的启动模式,设置为”singleton”类型。 |
UIAbility配置标签示例如下:
"abilities":[{ "name": ".CalleeAbility", "srcEntry": "./ets/CalleeAbility/CalleeAbility.ts", "launchType": "singleton", "description": "media:icon", "label": "$string:CalleeAbility_label", "exported": true }]
- 导入UIAbility模块。
import UIAbility from '@ohos.app.ability.UIAbility';
- 定义约定的序列化数据。 调用端及被调用端发送接收的数据格式需协商一致,如下示例约定数据由number和string组成。
import rpc from '@ohos.rpc' class MyParcelable { num: number = 0; str: string = "";
constructor(num: number, string: string) { this.num = num; this.str = string; }
marshalling(messageSequence: rpc.MessageSequence) { messageSequence.writeInt(this.num); messageSequence.writeString(this.str); return true; }
unmarshalling(messageSequence: rpc.MessageSequence) { this.num = messageSequence.readInt(); this.str = messageSequence.readString(); return true; } }
- 实现Callee.on监听及Callee.off解除监听。 如下示例在Ability的onCreate注册MSG_SEND_METHOD监听,在onDestroy取消监听,收到序列化数据后作相应处理并返回。应用开发者根据实际业务需要做相应处理。
import rpc from '@ohos.rpc'; import Want from '@ohos.app.ability.Want'; import UIAbility from '@ohos.app.ability.UIAbility'; import AbilityConstant from '@ohos.app.ability.AbilityConstant'; const TAG: string = '[CalleeAbility]'; const MSG_SEND_METHOD: string = 'CallSendMsg';
function sendMsgCallback(data: rpc.MessageSequence): MyParcelable { console.info('CalleeSortFunc called');
// 获取Caller发送的序列化数据
let receivedData: MyParcelable = new MyParcelable(0, '');
data.readParcelable(receivedData);
console.info(receiveData[${receivedData.num}, ${receivedData.str}]);
// 作相应处理
// 返回序列化数据result给Caller
return new MyParcelable(Number(receivedData.num) + 1, send ${receivedData.str} succeed);
}
export default class CalleeAbility extends UIAbility {
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
try {
this.callee.on(MSG_SEND_METHOD, sendMsgCallback);
} catch (error) {
console.info(${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)});
}
}
onDestroy() {
try {
this.callee.off(MSG_SEND_METHOD);
} catch (error) {
console.error(TAG, ${MSG_SEND_METHOD} unregister failed with error ${JSON.stringify(error)});
}
}
}
- 获取Caller接口,访问被调用端UIAbility。
- 导入UIAbility模块。
import UIAbility from '@ohos.app.ability.UIAbility';
- 获取Caller通信接口。 Ability的context属性实现了startAbilityByCall方法,用于获取指定通用组件的Caller通信接口。如下示例通过this.context获取Ability实例的context属性,使用startAbilityByCall拉起Callee被调用端并获取Caller通信接口,注册Caller的onRelease和onRemoteStateChange监听。应用开发者根据实际业务需要做相应处理。
import UIAbility, { Caller } from '@ohos.app.ability.UIAbility'; import { BusinessError } from '@ohos.base'; export default class EntryAbility extends UIAbility { // ... async onButtonGetRemoteCaller() { let caller: Caller|undefined; let context = this.context;
context.startAbilityByCall({
deviceId: getRemoteDeviceId(),
bundleName: 'com.samples.CallApplication',
abilityName: 'CalleeAbility'
}).then((data) => {
if (data != null) {
caller = data;
console.info('get remote caller success');
// 注册caller的release监听
caller.onRelease((msg) => {
console.info(remote caller onRelease is called ${msg});
})
console.info('remote caller register OnRelease succeed');
// 注册caller的协同场景下跨设备组件状态变化监听通知
try {
caller.onRemoteStateChange((str) => {
console.info('Remote state changed ' + str);
});
} catch (error) {
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!