HarmonyOS JS FA 調用 Java PA 機制

作者：晉國晨 2021-09-10 15:13:41

本項目使用模擬文件下載進度變化的功能來給你展示JS FA訂閱JAVA PA的能力，訂閱之后JS可以一直實時獲取到JAVA返回的進度數據來更新JS界面的進度條。

想了解更多內容，請訪問：

51CTO和華為官方合作共建的鴻蒙技術社區

https://harmonyos.51cto.com

實現效果

一、項目介紹

本項目使用模擬文件下載進度變化的功能來給你展示JS FA訂閱JAVA PA的能力，訂閱之后JS可以一直實時獲取到JAVA返回的進度數據來更新JS界面的進度條。另外，文件模擬下載完成跳轉到一個求積的頁面，在這個頁面輸入兩個數，點擊求積按鈕會給你展示JS FA調用JAVA PA的能力，此處并不像訂閱一樣可以一直獲取到java返回的數據，采用的模式是調用一次返回一次數據。

通過本項目，是想讓你了解如下知識點：

1) FeatureAbility.callAbility(OBJECT)：調用PA能力。

2) FeatureAbility.subscribeAbilityEvent(OBJECT, Function)：訂閱PA能力。

3) FeatureAbility.unsubscribeAbilityEvent(OBJECT)：取消訂閱PA能力。

二、代碼結構解讀

HarmonyOS JS FA 調用 JAVA PA 機制-鴻蒙HarmonyOS技術社區

1、java/ServiceAbility : java與js的通信代碼;

2、java-RequestParam ：請求參數的實體類;

3、js-pages-index.hml : js模擬文件下載頁;

4、js-pages-index.js : js訂閱java pa代碼;

5、js-calculate-calculate.hml : js求積頁面;

6、js-calculate-calculate.js : 調用java pa代碼;

7、config.json : js、java的配置文件，里面包括頁面配置、service配置、窗體配置等等。

三、新建js project

右擊—new—new project 。

選擇模板—next。

輸入項目名稱、選擇項目類型(單選)、api版本，設備類型，點擊finish即可。

四、訂閱PA解讀

點擊下載按鈕，向java端發送訂閱請求。

/** 
 * 請求開啟訂閱模式 
 */ 
subscribe: async function() { 
    this.isShow = true; // 顯示進度條內容 
    var that = this; 
 
    var actionData = {}; 
    actionData.firstNum = that.message; 
 
    var action = {}; 
    action.bundleName = 'com.example.javajscommunication'; // Ability的包名稱，需要與PA端匹配，區分大小寫 
    action.abilityName = 'com.example.javajscommunication.ServiceAbility'; // Ability名稱，需要與PA端匹配，區分大小寫 
    action.messageCode = ACTION_MESSAGE_CODE_PLUS_SUB; // Ability操作碼（操作碼定義PA的業務功能，需要與PA端約定) 
    action.data = actionData; // 發送到Ability的數據,數據字段名稱需要與PA端約定 
    action.abilityType = ABILITY_TYPE_EXTERNAL; // Ability類型，對應PA端不同的實現方式 
    action.syncOption = ACTION_SYNC; // PA側請求消息處理同步/異步選項 0：同步方式，默認方式。 1：異步方式 
 
    await FeatureAbility.subscribeAbilityEvent(action, function (callbackData) { 
        var callbackJson = JSON.parse(callbackData); // json字符串反序列化 
        that.message = callbackJson.data.abilityEvent; 
        if (that.message == 100) { // message 為100時進行跳轉計算頁面 
            router.push({ 
                uri: "pages/calculate/calculate" 
            }) 
            that.unsubscribe(); // 取消訂閱 
            that.isShow = false; // 隱藏進度條 
        } 
    }) 
}

java端在ServiceAbility中對訂閱請求進行處理，在內部類MyRemote的onRemoteRequest方法中根據code參數來判斷請求類型進行相應處理。

case ACTION_MESSAGE_CODE_PLUS_SUB: { 
    go = true; // 開啟可以下載狀態 
    remoteObjectHandler = data.readRemoteObject(); // 獲取請求參數對象 
    String zsonStr = data.readString(); // 獲取參數字符串 
 
    try { 
        param = ZSONObject.stringToClass(zsonStr, RequestParam.class); // 字符串對象轉成RequestParam實例 
    } catch (RuntimeException e) { 
 
    } 
    startNotify(param); // 給js端發送信息 
 
    Map<String, Object> zsonResult = new HashMap<String, Object>();// 返回結果，關鍵字段應與Js方協商 
    zsonResult.put("code", SUCCESS); 
    reply.writeString(ZSONObject.toZSONString(zsonResult)); // map 對象轉成json字符串，并返回給js端 
    return true; 
}

java端開啟線程，按照5*3 每15毫秒的頻率返回數據給js端。這里java發送給js的數據，js端會通過訂閱java pa的回調函數中而實時獲取到。

/** 
 *  開啟線程，按照5*3 每15毫秒的頻率返回數據給js端。這里java發送給js的數據， 
 *  js端會通過訂閱java pa的回調函數中而實時獲取到 
 */ 
public void startNotify(RequestParam param) { 
    number = param.getFirstNum(); // 獲取當前進度值從請求中獲取 
    new Thread(() -> { // 開啟線程 
        while (go) { 
            try { 
                Thread.sleep(5 * 3); // 線程睡眠15毫秒后繼續往下執行 
                MessageParcel data = MessageParcel.obtain(); // 創建索引為0的空MessageParcel對象 
                MessageParcel reply = MessageParcel.obtain(); 
                zsonEvent.put("abilityEvent", number++); 
                if (number == 101) { // number超過100 go狀態設為false 下載結束 
                    go = false; 
                } 
                data.writeString(ZSONObject.toZSONString(zsonEvent)); // 數據存到MessageParcel載體 
                remoteObjectHandler.sendRequest(100, data, reply, option); // 發送 
                reply.reclaim(); // 回收 
                data.reclaim(); 
            } catch (RemoteException | InterruptedException e) { 
                break; 
            } 
        } 
    }).start(); 
}

js頁面點擊取消按鈕，取消訂閱模式， java端停止返回數據。

js端代碼如下：

/** 
 * 請求取消訂閱, java端停止返回數據 
 */ 
unsubscribe: async function() { 
    var action = {}; 
    action.bundleName = 'com.example.javajscommunication'; // Ability的包名稱，需要與PA端匹配，區分大小寫 
    action.abilityName = 'com.example.javajscommunication.ServiceAbility'; // Ability名稱，需要與PA端匹配，區分大小寫 
    action.messageCode = ACTION_MESSAGE_CODE_PLUS_UNSUB; // Ability操作碼（操作碼定義PA的業務功能，需要與PA端約定) 
    action.abilityType = ABILITY_TYPE_EXTERNAL; // Ability類型，對應PA端不同的實現方式 
    action.syncOption = ACTION_SYNC;  // PA側請求消息處理同步/異步選項 0：同步方式，默認方式。 1：異步方式 
 
    var result = await FeatureAbility.unsubscribeAbilityEvent(action); // 取消訂閱 
    var ret = JSON.parse(result); // 反序列化， 
    if (ret.code == 0) { 
        prompt.showToast({ 
            message: '取消下載成功' 
        }) 
    } else { 
        prompt.showToast({ 
            message: '取消下載失敗' 
        }) 
    } 
}

java端service代碼如下：

case ACTION_MESSAGE_CODE_PLUS_UNSUB: { 
    go = false; // 停止方法startNotify中的while循環,停止往js端發送消息 
    Map<String, Object> zsonResult = new HashMap<String, Object>(); 
    zsonResult.put("code", SUCCESS); 
    reply.writeString(ZSONObject.toZSONString(zsonResult)); // 響應js端 
    return true; 
}

五、調用PA解讀

獲取input輸入的值，作為js端傳遞過去的值。

/**  
  * 取傳過去的第一個值  
  */ 
    numOne (e){ 
        this.numOne = e.value 
    },   
 /**  
  * 獲取傳過去的第二個值 
  */ 
    numTwo (e){ 
        this.numTwo = e.value 
    }

點擊求積按鈕發送調用模式的請求。

calculate: async function() { 
    var actionData = {}; // key值對應PA端的RequestParam類的成員字段 
    actionData.firstNum = this.numOne; 
    actionData.secondNum = this.numTwo; 
 
    var action = {}; 
    action.bundleName = 'com.example.javajscommunication'; // Ability的包名稱，需要與PA端匹配，區分大小寫 
    action.abilityName = 'com.example.javajscommunication.ServiceAbility'; // Ability名稱，需要與PA端匹配，區分大小寫 
    action.messageCode = ACTION_MESSAGE_CODE_PLUS; // Ability操作碼（操作碼定義PA的業務功能，需要與PA端約定) 
    action.data = actionData; // 發送到Ability的數據,數據字段名稱需要與PA端約定 
    action.abilityType = ABILITY_TYPE_EXTERNAL; // Ability類型，對應PA端不同的實現方式 
    action.syncOption = ACTION_SYNC;  // PA側請求消息處理同步/異步選項 0：同步方式，默認方式。 1：異步方式 
 
    var result = await FeatureAbility.callAbility(action); 
    var ret = JSON.parse(result); 
    if (ret.code == 0) { 
        this.message =  'java端傳回的數據為:' + JSON.stringify(ret.abilityResult); 
    } else { 
        this.message =  'java端傳回的數據報錯' + JSON.stringify(ret.code); 
    } 
},

java端在ServiceAbility中對訂閱請求進行處理，在內部類MyRemote的onRemoteRequest方法中根據code參數來判斷請求類型進行相應處理。這里java發送給js的數據，js端會通過調用java pa的結果而獲取到。

case ACTION_MESSAGE_CODE_PLUS: { 
    String zsonStr = data.readString(); // 獲取傳入參數的字符串 
    RequestParam param = new RequestParam(); 
    try { 
        param = ZSONObject.stringToClass(zsonStr, RequestParam.class); // 字符串對象轉成RequestParam實例 
    } catch (RuntimeException e) { 
 
    } 
 
    // 返回結果僅支持可序列化的Object類型 
    Map<String, Object> zsonResult = new HashMap<>(); 
    zsonResult.put("code", SUCCESS); 
    zsonResult.put("abilityResult", param.getFirstNum() + " * " + param.getSecondNum() + " = " + (param.getFirstNum() * param.getSecondNum())); 
    reply.writeString(ZSONObject.toZSONString(zsonResult)); // 數據返回給js端 
    return true; 
}

返回到前一個頁面，這里在頁面js中import router from ‘@system.router’，然后利用router對象的相關方法返回。

back(){ 
    router.back() // 返回到前一個頁面 
}

六、代碼參考

https://gitee.com/chinasoft6_ohos/java-js-communication

想了解更多內容，請訪問：

51CTO和華為官方合作共建的鴻蒙技術社區

https://harmonyos.51cto.com

責任編輯：jianghua 來源：鴻蒙社區

鴻蒙 HarmonyOS 應用