OpenHarmony实战开发：ServiceAbility组件开发

往期鸿蒙全套实战精彩文章必看内容：

• 鸿蒙开发核心知识点，看这篇文章就够了

• 最新版！鸿蒙HarmonyOS Next应用开发实战学习路线

• 鸿蒙HarmonyOS NEXT开发技术最全学习路线指南

• 鸿蒙应用开发实战项目，看这一篇文章就够了（部分项目附源码）

---

创建ServiceAbility

1. 创建ServiceAbility。

   通过DevEco Studio开发平台创建ServiceAbility时，DevEco Studio会默认生成onStart、onStop、onCommand方法，其他方法需要开发者自行实现，接口说明参见前述章节。开发者也可以添加其他Ability请求与ServiceAbility交互时的处理方法，示例如下：

   import type Want from '@ohos.app.ability.Want';
   import rpc from '@ohos.rpc';
   import hilog from '@ohos.hilog';
   
   const TAG: string = '[Sample_FAModelAbilityDevelop]';
   const domain: number = 0xFF00;
   
   class FirstServiceAbilityStub extends rpc.RemoteObject {
     constructor(des: Object) {
       if (typeof des === 'string') {
         super(des);
       } else {
         return;
       }
     }
   
     onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption): boolean {
       hilog.info(domain, TAG, 'ServiceAbility onRemoteRequest called');
       if (code === 1) {
         let string = data.readString();
         hilog.info(domain, TAG, `ServiceAbility string=${string}`);
         let result = Array.from(string).sort().join('');
         hilog.info(domain, TAG, `ServiceAbility result=${result}`);
         reply.writeString(result);
       } else {
         hilog.info(domain, TAG, 'ServiceAbility unknown request code');
       }
       return true;
     }
   }
   
   class ServiceAbility {
     onStart(): void {
       hilog.info(domain, TAG, 'ServiceAbility onStart');
     }
   
     onStop(): void {
       hilog.info(domain, TAG, 'ServiceAbility onStop');
     }
   
     onCommand(want: Want, startId: number): void {
       hilog.info(domain, TAG, 'ServiceAbility onCommand');
     }
   
     onConnect(want: Want): rpc.RemoteObject {
       hilog.info(domain, TAG, 'ServiceAbility onDisconnect' + want);
       return new FirstServiceAbilityStub('test');
     }
   
     onDisconnect(want: Want): void {
       hilog.info(domain, TAG, 'ServiceAbility onDisconnect' + want);
     }
   }
   
   export default new ServiceAbility();
   

2. 注册ServiceAbility。

   ServiceAbility需要在应用配置文件config.json中进行注册，注册类型type需要设置为service。"visible"属性表示ServiceAbility是否可以被其他应用调用，true表示可以被其他应用调用，false表示不能被其他应用调用（仅应用内可以调用）。若ServiceAbility需要被其他应用调用，注册ServiceAbility时需要设置"visible"为true，同时需要设置支持关联启动。

   {
     ...
     "module": {
       ...
       "abilities": [
         ...
         {
           "name": ".ServiceAbility",
           "srcLanguage": "ets",
           "srcPath": "ServiceAbility",
           "icon": "$media:icon",
           "description": "$string:ServiceAbility_desc",
           "type": "service",
           "visible": true
         },
         ...
       ]
       ...
     }
   }

启动ServiceAbility

ServiceAbility的启动与其他Ability并无区别，应用开发者可以在PageAbility中通过featureAbility的startAbility接口拉起ServiceAbility，在ServiceAbility中通过particleAbility的startAbility接口拉起ServiceAbility。

如下示例展示了在PageAbility中通过startAbility启动bundleName为"com.example.myapplication"，abilityName为"ServiceAbility"的ServiceAbility的方法。启动FA模型的ServiceAbility时，需要在abilityName前拼接bundleName字符串。

import featureAbility from '@ohos.ability.featureAbility'
import Want from '@ohos.app.ability.Want';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';

const LOG_DOMAIN: number = 0x0000;
const LOG_TAG: string = 'startServiceAbility';
const startServiceAbility = async () => {
  try {
    hilog.info(LOG_DOMAIN, LOG_TAG, 'Begin to start ability');
    let want: Want = {
      bundleName: 'com.samples.famodelabilitydevelop',
      abilityName: 'com.samples.famodelabilitydevelop.ServiceAbility'
    };
    await featureAbility.startAbility({ want });
    promptAction.showToast({
      message: 'start service success'
    });
    hilog.info(LOG_DOMAIN, LOG_TAG, 'Start ability succeed');
  } catch (error) {
    hilog.info(LOG_DOMAIN, LOG_TAG, 'Start ability failed with ' + error);
  }
}

执行上述代码后，Ability将通过startAbility()方法来启动ServiceAbility。

• 如果ServiceAbility尚未运行，则系统会先调用onStart()来初始化ServiceAbility，再回调Service的onCommand()方法来启动ServiceAbility。

• 如果ServiceAbility正在运行，则系统会直接回调ServiceAbility的onCommand()方法来启动ServiceAbility。

连接ServiceAbility

如果ServiceAbility需要与PageAbility或其他应用的ServiceAbility进行交互，则须创建用于连接的Connection。ServiceAbility支持其他Ability通过connectAbility()方法与其进行连接。PageAbility的connectAbility()方法定义在featureAbility中，ServiceAbility的connectAbility()方法定义在particleAbility中。连接ServiceAbility的规则详见组件启动规则章节。在使用connectAbility()处理回调时，需要传入目标Service的Want与IAbilityConnection的实例。IAbilityConnection提供了以下方法供开发者实现。

表1 IAbilityConnection接口说明

接口名	描述
onConnect()	用于处理连接Service成功的回调。
onDisconnect()	用来处理Service异常死亡的回调。
onFailed()	用来处理连接Service失败的回调。

PageAbility创建连接本地ServiceAbility回调实例的代码以及连接本地ServiceAbility的示例代码如下：

import featureAbility from '@ohos.ability.featureAbility';
import common from '@ohos.app.ability.common';
import Want from '@ohos.app.ability.Want';
import promptAction from '@ohos.promptAction';
import rpc from '@ohos.rpc';
import hilog from '@ohos.hilog';

const LOG_TAG: string = '[Sample_FAModelAbilityDevelop]';
const LOG_DOMAIN: number = 0xFF00;
let option: common.ConnectOptions = {
  onConnect: (element, proxy) => {
    hilog.info(LOG_DOMAIN, LOG_TAG, 'onConnectLocalService onConnectDone element:' + JSON.stringify(element));
    if (proxy === null) {
      promptAction.showToast({
        message: 'connect service failed'
      });
      return;
    }
    let data = rpc.MessageParcel.create();
    let reply = rpc.MessageParcel.create();
    let option = new rpc.MessageOption();
    data.writeInterfaceToken('connect.test.token');
    proxy.sendRequest(0, data, reply, option);
    promptAction.showToast({
      message: 'connect service success'
    });
  },
  onDisconnect: (element) => {
    hilog.info(LOG_DOMAIN, LOG_TAG, `onConnectLocalService onDisconnectDone element:${element}`);
    promptAction.showToast({
      message: 'disconnect service success'
    });
  },
  onFailed: (code) => {
    hilog.info(LOG_DOMAIN, LOG_TAG, `onConnectLocalService onFailed errCode:${code}`);
    promptAction.showToast({
      message: 'connect service failed'
    });
  }
};

let request: Want = {
  bundleName: 'com.samples.famodelabilitydevelop',
  abilityName: 'com.samples.famodelabilitydevelop.ServiceAbility',
};
let connId = featureAbility.connectAbility(request, option);
hilog.info(LOG_DOMAIN, LOG_TAG, `connectAbility id:${connId}`);

同时，Service侧也需要在onConnect()时返回IRemoteObject，从而定义与Service进行通信的接口。onConnect()需要返回一个IRemoteObject对象。系统提供了IRemoteObject的默认实现，开发者可以通过继承rpc.RemoteObject来创建自定义的实现类。

Service侧把自身的实例返回给调用侧的示例代码如下：

import type Want from '@ohos.app.ability.Want';
import rpc from '@ohos.rpc';
import hilog from '@ohos.hilog';

const TAG: string = '[Sample_FAModelAbilityDevelop]';
const domain: number = 0xFF00;

class FirstServiceAbilityStub extends rpc.RemoteObject {
  constructor(des: Object) {
    if (typeof des === 'string') {
      super(des);
    } else {
      return;
    }
  }

  onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption): boolean {
    hilog.info(domain, TAG, 'ServiceAbility onRemoteRequest called');
    if (code === 1) {
      let string = data.readString();
      hilog.info(domain, TAG, `ServiceAbility string=${string}`);
      let result = Array.from(string).sort().join('');
      hilog.info(domain, TAG, `ServiceAbility result=${result}`);
      reply.writeString(result);
    } else {
      hilog.info(domain, TAG, 'ServiceAbility unknown request code');
    }
    return true;
  }
}
//...

看完三件事❤️

• 如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：
• 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
• 关注作者 ，不定期分享原创知识。
• 同时可以期待后续文章ing🚀。   ​