作者:zhenyu ,華為軟件開發工程師
在當前HarmonyOS版本下,如何基于JS UI框架來開發呢?
1JS UI框架下FA與PA交互的使用場景通常一個典型使用JS UI框架的HarmonyOS應用開發模型
HarmonyOS的用戶應用程序包APP由一個或多個Hap包組成。每個Hap可以包含一個或多個Ability。Ability分為兩種類型:Feature Ability(簡稱FA)和Particle Ability(簡稱PA),FA和PA是HarmonyOS應用的基本組成單元,能夠實現特定的業務功能。
FA有UI界面,而PA無UI界面。FA有多種展現形式,如普通界面形式Page Ability,服務卡片形式Form等,一般使用JS 語言實現前臺界面。PA支持ServiceAbility和Data Ability。ServiceAbility提供后臺運行任務的能力,如處理復雜后臺任務等。Data Ability用于對外部提供統一的數據訪問抽象。這兩個Ability一般使用Java 語言實現。
JS UI框架提供的聲明式編程,使應用開發更加簡單,但當前HarmonyOS JS API還不夠豐富,無法處理數據等更復雜的業務。為了達到處理復雜業務,同時保證業務數據和UI的解耦,一般會將復雜邏輯放到PA中即JAVA端實現,而界面交互則放到FA中的UI部分即JS端實現,如圖1所示。
這就涉及到FA(JS端)與PA(JAVA端)的交互,為此,Harmony OS JS UI框架提供了JS FA(Feature Ability)調用JAVA PA(Particle Ability)的機制,該機制提供了一種通道來傳遞方法調用、處理數據返回以及訂閱事件上報。
下面我們通過一兩個例子來解釋該方法涉及的技術原理。
2HarmonyOS下FA調用PA機制1接口拓展機制為支持ACE開發框架一次開發,跨平臺運行的目標,采用了接口拓展機制打通前端應用層和后端平臺層。JS UI框架提供了一種自動封裝平臺能力擴展API的機制,讓應用開發者輕松調用API即能完成JS端到JAVA端的傳遞方法調用、處理數據返回以及訂閱事件上報。
如圖2所示,當前HarmonyOS支持JS作為前端應用開發語言,提供API接口,供開發者實現業務邏輯,通過類似接口拓展機制將JS層的參數傳遞到平臺層(Native),同時在平臺層提供插件代碼(Plugin Native code)供三方平臺實現業務邏輯。
◆ JS FrameWork
提供API用于傳遞方法調用,數據流通信,以及訂閱事件回調。并通過JsBridge橋接起C++與JS,JsBridge主要負責加載JS代碼,運行在QJS Engine上,將JS代碼通過全局函數橋接到C++上,并將C++的結果返回給JS層。
◆ QJS Engine
QuickJS 是一個輕量且可嵌入的 JavaScript 引擎,包括模塊、異步生成器和代理。
◆ ACE Framework
將JS的消息往平臺層透傳,將JS數據轉換成C++類型的數據,再通過C++與JAVA的JNI接口類,將C++的數據傳遞到JAVA側,并接收JAVA側返回的數據。
◆ Native
負責平臺層數據編解碼,并根據解碼后得到的FunctionName調用第三方開發者的插件代碼邏輯。◆ HarmonyOS API平臺層提供JAVA端API接口。開發者實現JAVA端對應接口的業務邏輯。2HarmonyOS下FA調用PA機制JS UI框架當前提供了Ability和Internal Ability兩種FA調用PA的方式:
● Ability調用方式:擁有獨立的Ability生命周期,FA使用遠端進程通信拉起并請求PA服務,適用于基本服務PA有多個FA調用或者PA在后臺獨立運行的場景。
● Internal Ability調用方式:PA與FA共進程,PA和FA采用內部函數調用的方式進行通信,適用于對服務響應時延要求較高的場景。該方式下PA不支持其他FA訪問調用。
這兩種調用方式在代碼中可通過abilityType來標識FA調用PA注意事項:
● JS和JAVA側定義好的“方法調用”在對外開放后,需要保證前向兼容性。
● 序列化數據默認最大支持200KB數據量,若需要傳輸大數據,可以使用對應接口ohos.utils.Parcel.setCapacity()調整buffer容量大小。
3FA調用PA開發方法下面來給大家詳細介紹JS FA調用JAVA PA的開發方法。
當FeatureAbility Plugin收到JS調用請求后,系統根據開發者在JS接口中設置的參數如指定的abilityType(Ability或Internal Ability),來選擇對應的方式進行處理。開發者在onRemoteRequest()中實現PA提供的業務邏輯,不同的業務通過業務碼來區分。
◆ FA端
1.Channel JS API提供以下模塊能力:
● ModuleGroup
用于傳遞方法調用的類,通常用于上層應用者調用native中的某個方法而定義使用。調用callNative()方法即可將function以及對應的參數傳遞到平臺層,需要在Native層也適配相應的邏輯代碼。
簡言之,即ModuleGroup實現JS調用JAVA方法,提供的JS API如下:
√ 調用PA能力,FeatureAbility.callAbility(OBJECT)
● EventGroup
用于數據流通信,通常用于平臺層觸發的Native事件通知應用層。在應用層調用subscribe()方法注冊回調事件啟動監聽平臺,調用unSubscribe()取消平臺監聽。第三方開發者在平臺層需要適配相應的邏輯代碼。
簡言之,即EventGroup實現JAVA回調JS,提供的JS API如下:
√ 訂閱PA能力,FeatureAbility.subscribeAbilityEvent(OBJECT, Function)
√ 取消訂閱PA能力,FeatureAbility.unsubscribeAbilityEvent(OBJECT)
2.FeatureAbility Plugin主要完成方法調用、數據流的參數傳遞(編解碼)、線程切換、JNI轉換等處理。其主要提供以下2個重點模塊:
● Internal Ability Manager
用于Internal Ability的管理,包括注冊管理等,注冊后的Internal Ability與FA共生命周期。
● Connection Manager
JS端與JAVA端通過接口擴展機制進行通信,通過bundleName和abilityName來進行關聯。
◆ PA端
PA端提供以下兩類接口:
● IRemoteObject.onRemoteRequest(int, MessageParcel, MessageParcel, MessageOption)
Ability調用方式,FA使用遠端進程通信拉起并請求PA服務。
● AceInternalAbility.AceInternalAbilityHandler.onRemoteRequest(int, MessageParcel, MessageParcel, MessageOption)
Internal Ability調用方式,采用內部函數調用的方式和FA進行通信。
4Ability調用方式流程
1.FA JS端指定PA的調用方式及相關消息碼和內容,調用PA(訂閱PA類似)。設置bundleName,abilityName,abilityType等。2.PA JAVA端響應:通過Ability方式拉起的PA繼承自Ability,FA在請求PA服務時會連接到PA,連接成功后,PA在onConnect返回一個remote對象(RemoteObject),用于FA向PA發送消息。remote對象實現onRemoteRequest方法,用于響應FA端的請求。示例代碼如下:e.g.兩數求和
◆ FA端 (Ability方式)
// abilityType: 0-Ability; 1-Internal Abilityconst ABILITY_TYPE_EXTERNAL = 0;const ABILITY_TYPE_INTERNAL = 1;// syncOption(Optional, default sync): 0-Sync; 1-Asyncconst ACTION_SYNC = 0;const ACTION_ASYNC = 1;const ACTION_MESSAGE_CODE_PLUS = 1001;export default { plus: async function() { var actionData = {}; actionData.firstNum = 1024; actionData.secondNum = 2048; // 請求參數,abilityName、bundleName、messageCode、abilityType、actionData需要求和的2個入參 var action = {}; action.bundleName = ‘com.example.hiaceservice’; action.abilityName = ‘com.example.hiaceservice.ComputeServiceAbility’; action.messageCode = ACTION_MESSAGE_CODE_PLUS; action.data = actionData; // 使用ability方式 action.abilityType = ABILITY_TYPE_EXTERNAL; action.syncOption = ACTION_SYNC; // FA調用PA var result = await FeatureAbility.callAbility(action); var ret = JSON.parse(result); if (ret.code == 0) { console.info(‘plus result is:’ + JSON.stringify(ret.abilityResult)); } else { console.error(‘plus error code:’ + JSON.stringify(ret.code)); } }}
◆ PA端(Ability方式)
public class ComputeServiceAbility extends Ability { private MyRemote remote = new MyRemote(); // FA在請求PA服務時會連接PA,連接成功后,需要在onConnect返回一個remote對象,供FA向PA發送消息 @Override protected IRemoteObject onConnect(Intent intent) { super.onConnect(intent); return remote.asObject(); } // remote對象的實現,完成消息請求處理,回傳 class MyRemote extends RemoteObject implements IRemoteBroker { private static final int SUCCESS = 0; private static final int ERROR = 1; private static final int PLUS = 1001; MyRemote() { super(“MyService_MyRemote”); } @Override public boolean onRemoteRequest(int code, MessageParcel data, MessageParcel reply, MessageOption option) { switch (code) { // 消息碼PLUS case PLUS: { // 消息參數解析 String dataStr = data.readString(); RequestParam param = new RequestParam(); try { param = ZSONObject.stringToClass(dataStr, RequestParam.class); } catch (RuntimeException e) { HiLog.error(LABEL, “convert failed.”); } // 返回結果設置 Map《String, Object》 result = new HashMap《String, Object》(); result.put(“code”, SUCCESS); result.put(“abilityResult”, param.getFirstNum() + param.getSecondNum()); // 返回結果回傳 reply.writeString(ZSONObject.toZSONString(result)); break; } default: { Map《String, Object》 result = new HashMap《String, Object》(); result.put(“abilityError”, ERROR); reply.writeString(ZSONObject.toZSONString(result)); return false; } } return true; } @Override public IRemoteObject asObject() { return this; } }}
5Internal Ability調用方式流程
1.FA JS端指定PA的調用方式及相關消息碼和內容,調用PA(訂閱PA類似)。設置bundleName,abilityName,abilityType等。2.PA JAVA端響應:通過Internal Ability方式拉起的PA需要繼承自AceInternalAbility,且需要在AceAbility中注冊該Internal Ability(AceAbility中執行register方法)。PA中通過setInternalAbilityHandler方法注冊onRemoteRequest方法,用于響應FA端的請求。示例代碼如下:e.g.兩數求和
◆ FA端(Internal Ability方式)
和使用ability方式代碼類似,區別是需要改變方式類型為Internal Ability:
action.abilityType = ABILITY_TYPE_INTERNAL;
◆ PA端(Internal Ability方式):
//Internal Ability注冊:在MainAbility注冊public class MainAbility extends AceAbility { @Override public void onStart(Intent intent) { // 注冊, 如果需要在Page初始化(onInit或之前)時調用AceInternalAbility的能力,注冊操作需要在super.onStart之前進行 ComputeInternalAbility.register(this); 。。。 super.onStart(intent); } @Override public void onStop() { // 注銷 ComputeInternalAbility.unregister(); super.onStop(); }}
在JAVA目錄下實現InternalAbility(此處為ComputeInternalAbility)
public class ComputeInternalAbility extends AceInternalAbility { private static final String BUNDLE_NAME = “com.example.hiaceservice”; private static final String ABILITY_NAME = “com.example.hiaceservice.ComputeInternalAbility”; private static final int SUCCESS = 0; private static final int ERROR = 1; private static final int PLUS = 1001; private static ComputeInternalAbility instance; private AbilityContext abilityContext; // 如果多個Ability實例都需要注冊當前InternalAbility實例,需要更改構造函數,設定自己的bundleName和abilityName public ComputeInternalAbility() { super(BUNDLE_NAME, ABILITY_NAME); } public boolean onRemoteRequest(int code, MessageParcel data, MessageParcel reply, MessageOption option) { switch (code) { case PLUS: { String dataStr = data.readString(); RequestParam param = new RequestParam(); try { param = ZSONObject.stringToClass(dataStr, RequestParam.class); } catch (RuntimeException e) { HiLog.error(LABEL, “convert failed.”); } // 返回結果當前僅支持String,對于復雜結構可以序列化為ZSON字符串上報 Map《String, Object》 result = new HashMap《String, Object》(); result.put(“code”, SUCCESS); result.put(“abilityResult”, param.getFirstNum() + param.getSecondNum()); // SYNC if (option.getFlags() == MessageOption.TF_SYNC) { reply.writeString(ZSONObject.toZSONString(result)); } else { // ASYNC MessageParcel responseData = MessageParcel.obtain(); responseData.writeString(ZSONObject.toZSONString(result)); IRemoteObject remoteReply = reply.readRemoteObject(); try { remoteReply.sendRequest(0, responseData, MessageParcel.obtain(), new MessageOption()); } catch (RemoteException exception) { return false; } finally { responseData.reclaim(); } } break; } default: { Map《String, Object》 result = new HashMap《String, Object》(); result.put(“abilityError”, ERROR); reply.writeString(ZSONObject.toZSONString(result)); return false; } } return true; }
/** * Internal ability 注冊接口。 */ public static void register(AbilityContext abilityContext) { instance = new ComputeInternalAbility(); instance.onRegister(abilityContext); } private void onRegister(AbilityContext abilityContext) { this.abilityContext = abilityContext; this.setInternalAbilityHandler((code, data, reply, option) -》 { return this.onRemoteRequest(code, data, reply, option); }); } /** * Internal ability 注銷接口。 */ public static void unregister() { instance.onUnregister(); } private void onUnregister() { abilityContext = null; this.setInternalAbilityHandler(null); }}
以上代碼樣例只是關鍵部分,完整代碼樣例可參考官網資料【JS FA如何調用PA】:● JS FA如何調用PAhttps://developer.harmonyos.com/cn/docs/documentation/doc-guides/ui-js-fa-call-pa-0000001050435961
本文介紹了JS FA(Feature Ability)調用JAVA PA(Particle Ability)的機制和使用場景,基于JS UI框架開發的應用可以使用該機制完成更豐富的功能。未來HarmonyOS會持續豐富完善JS API,為開發者提供更便捷的API能力。
編輯:jq
-
HarmonyOS
+關注
關注
79文章
1983瀏覽量
30630
原文標題:JS UI框架下FA與PA是如何交互的
文章出處:【微信號:gh_019562b5fb4b,微信公眾號:gh_019562b5fb4b】歡迎添加關注!文章轉載請注明出處。
發布評論請先 登錄
相關推薦
HarmonyOS開發指導類文檔更新速遞(下)
![<b class='flag-5'>HarmonyOS</b><b class='flag-5'>開發</b>指導類文檔更新速遞(<b class='flag-5'>下</b>)](https://file1.elecfans.com/web3/M00/04/41/wKgZO2dx_aKABcX5AAAL_e1qV7Q863.png)
評論