鴻蒙OS IDL接口開(kāi)發(fā)步驟

創(chuàng)建.idl文件

開(kāi)發(fā)者可以使用Java或C++編程語(yǔ)言構(gòu)建.idl文件。.idl示例如下：

package com.example
 
/** Example service ability interface */
interface com.example.IRemoteAbility {
    int plus([in] int num1, [in] int num2);
}

HarmonyOS SDK工具支持生成Java、C++語(yǔ)言的接口類、樁類和代理類。以Java語(yǔ)言開(kāi)發(fā)為例，開(kāi)發(fā)者只需將.idl文件保存至DevEco Studio項(xiàng)目的src/目錄內(nèi)，工具則會(huì)在構(gòu)建應(yīng)用時(shí)，在項(xiàng)目的generated/目錄中生成IRemoteObject接口文件、Stub文件、Proxy文件。生成的接口類文件名稱和.idl文件名稱保持一致，區(qū)別在于其使用.java 擴(kuò)展名。例如，IRemoteAbility.idl 生成的文件名是 IRemoteAbility.java、RemoteAbilityProxy.java、RemoteAbilityStub.java。

服務(wù)端公開(kāi)接口

HarmonyOS IDL工具生成的Stub類是接口類的抽象實(shí)現(xiàn)，并且會(huì)聲明.idl文件中的所有方法。

public abstract class RemoteAbilityStub extends RemoteObject implements IRemoteAbility {
    private static final String DESCRIPTOR = "com.example.IRemoteAbility";
 
    private static final int COMMAND_PLUS = IRemoteObject.MIN_TRANSACTION_ID + 0;
    ………
}

要實(shí)現(xiàn).idl生成的接口，請(qǐng)擴(kuò)展生成的RemoteObject接口，并實(shí)現(xiàn)繼承自.idl文件的方法。MyRemote定義了服務(wù)的遠(yuǎn)程過(guò)程調(diào)用接口，示例代碼如下：

class MyRemote extends MyRemoteAbilityStub {
 
    public MyRemote(String descriptor) {
        super(descriptor);
    }
 
    @Override
    public int plus(int num1, int num2) throws RemoteException {
        return num1 + num2;
    }
}

在服務(wù)實(shí)現(xiàn)接口后，需要向客戶端公開(kāi)該接口，以便客戶端進(jìn)程綁定。如果開(kāi)發(fā)者的服務(wù)要公開(kāi)該接口，請(qǐng)擴(kuò)展Ability并實(shí)現(xiàn)onConnect()從而返回IRemoteObject，以便客戶端能與服務(wù)進(jìn)程交互。服務(wù)端向客戶端公開(kāi)IRemoteAbility接口的代碼示例如下：

public class ServiceAbility extends Ability {
 
    private MyRemote remote = new MyRemote("MyRemoteAbility");
 
    class MyRemote extends RemoteAbilityStub {
 
        public MyRemote(String descriptor) {
            super(descriptor);
        }
 
        @Override
        public int plus(int num1, int num2) throws RemoteException {
            return num1 + num2;
        }
    }
 
    @Override
    public IRemoteObject onConnect(Intent intent) {
        return remote.asObject();
    }
}

客戶端調(diào)用IPC方法

客戶端調(diào)用connectAbility()以連接服務(wù)時(shí)，客戶端的onAbilityConnectDone()回調(diào)會(huì)接收服務(wù)的onConnect()方法返回的IRemoteObject實(shí)例。由于客戶端和服務(wù)在不同應(yīng)用內(nèi)，所以客戶端應(yīng)用的src/目錄內(nèi)必須包含.idl文件(SDK工具會(huì)自動(dòng)生成Proxy代理類)的副本。當(dāng)客戶端onAbilityConnectDone()回調(diào)中收到IRemoteObject，調(diào)用RemoteAbilityStub.asInterface(IRemoteObject)，以將返回的參數(shù)轉(zhuǎn)換為IRemoteAbility類型，例如：

IRemoteAbility proxy;
private IAbilityConnection conn = new IAbilityConnection() {
    @Override
    public void onAbilityConnectDone(ElementName element, IRemoteObject remote, int resultCode) {
        proxy = IRemoteAbilityStub.asInterface(remote);
    }
 
    @Override
    public void onAbilityDisconnectDone(ElementName element, int resultCode) {
        proxy = null;
    }
};

如果要斷開(kāi)連接，請(qǐng)調(diào)用Ability.disconnectAbility()。

IPC傳遞Sequenceable對(duì)象

開(kāi)發(fā)者可以通過(guò) IPC 接口，將某個(gè)類從一個(gè)進(jìn)程發(fā)送至另一個(gè)進(jìn)程。但是，必須確保 IPC 通道的另一端可使用該類的代碼，并且該類必須支持Sequenceable接口。HarmonyOS需要通過(guò)該Sequenceable接口將對(duì)象反序列化成各進(jìn)程能識(shí)別的對(duì)象。

如需創(chuàng)建支持Sequenceable 接口的類，開(kāi)發(fā)者必須執(zhí)行以下操作：

1. 自定義對(duì)象實(shí)現(xiàn)Sequenceable接口。
2. 實(shí)現(xiàn)marshalling方法，它會(huì)獲取對(duì)象的當(dāng)前狀態(tài)并將其學(xué)序列化后寫(xiě)入Parcel。
3. 實(shí)現(xiàn)unmarshalling方法，它會(huì)從Parcel中反序列化出對(duì)象。

ElementName.java類實(shí)現(xiàn)Sequenceable接口的代碼示例如下：

public class ElementName implements Sequenceable {
    private String deviceId = "";
    private String bundleName = "";
    private String abilityName = "";
 
    public ElementName() {
    }
 
    public ElementName(String deviceId, String bundleName, String abilityName) {
        this.deviceId = deviceId;
        this.bundleName = bundleName;
        this.abilityName = abilityName;
    }
 
    /**
    * @see ohos.utils.Sequenceable#marshalling(Parcel)
    *
    */
    @Override
    public boolean marshalling(Parcel out) {
        if (!out.writeString(bundleName)) {
            return false;
        }
        if (!out.writeString(abilityName)) {
            return false;
        }
        if (!out.writeString(deviceId)) {
            return false;
        }
        return true;
    }
 
    /**
    * @see ohos.utils.Sequenceable#unmarshalling(Parcel)
    *
    */
    @Override
    public boolean unmarshalling(Parcel in) {
        this.bundleName = in.readString();
        this.abilityName = in.readString();
        this.deviceId = in.readString();
        return true;
    }