HarmonyOS如何自動(dòng)生成JS FA調(diào)用Java PA的模板代碼

JS UI框架提供了JS FA（Feature Ability）調(diào)用Java PA（Particle Ability）的機(jī)制，該機(jī)制提供了一種通道來傳遞方法調(diào)用、處理數(shù)據(jù)返回以及訂閱事件上報(bào)。

在往期的《JS UI框架下FA與PA是如何交互的》一文中，給大家介紹了如何通過利用FA、PA交互機(jī)制來完成基于JS UI框架的應(yīng)用開發(fā)。但是，開發(fā)者在實(shí)操過程中，都遇到一個(gè)共同的問題，就是需要手動(dòng)撰寫大量模板代碼，且模板代碼可能與業(yè)務(wù)代碼相互耦合，使得代碼可維護(hù)性和可讀性較差。于是，js2java-codegen工具應(yīng)運(yùn)而生。

本期，小編將通過開發(fā)一個(gè)簡單的計(jì)算器應(yīng)用，闡述JS UI框架下，如何使用js2java-codegen工具自動(dòng)生成JS FA調(diào)用Java PA的模板代碼。

注：以下內(nèi)容中涉及到的 “FA調(diào)用PA”，均是指JS UI框架下JS FA調(diào)用Java PA。

js2java-codegen是HarmonyOS SDK中Toolchains工具鏈從2.2.0.3版本開始提供的自動(dòng)生成FA調(diào)用PA代碼的輔助開發(fā)工具。它可以根據(jù)用戶源碼自動(dòng)生成FA調(diào)用PA時(shí)所需的Java和JS模板代碼，該模板代碼與用戶編寫的業(yè)務(wù)代碼相互分離，降低了代碼的耦合。

目前，js2java-codegen工具所支持的FA調(diào)用PA實(shí)現(xiàn)方式為InternalAbility類型，Ability類型尚不支持。

說明 ：當(dāng)前JS FA調(diào)用Java PA的機(jī)制中，提供了Ability和InternalAbility兩種調(diào)用方式：

Ability：擁有獨(dú)立的Ability生命周期，F(xiàn)A使用遠(yuǎn)端進(jìn)程通信拉起并請求PA服務(wù)，適用于基本服務(wù)供多FA調(diào)用或者服務(wù)在后臺獨(dú)立運(yùn)行的場景。

InternalAbility：與FA共進(jìn)程，采用內(nèi)部函數(shù)調(diào)用的方式和FA進(jìn)行通信，適用于對服務(wù)響應(yīng)時(shí)延要求較高的場景。該方式下PA不支持其他FA訪問調(diào)用。

更多JS FA調(diào)用Java PA的機(jī)制官網(wǎng)文檔

https://developer.harmonyos.com/cn/docs/documentation/doc-guides/ui-js-fa-call-pa-0000001050435961

由于該工具從HarmonyOS SDK中Toolchains的2.2.0.3版本開始支持，所以請先把DevEco Studio更新至最新的2.2 Beta2版本。

DevEco Studio官網(wǎng)下載鏈接：

https://developer.harmonyos.com/cn/develop/deveco-studio#download

1. 新建工程

在最新版的DevEco Studio 2.2 Beta2下，新建一個(gè)包含JS的手機(jī)項(xiàng)目。

2. 工具配置

開發(fā)者需在進(jìn)行代碼生成模塊下的build.gradle中進(jìn)行編譯設(shè)置及開關(guān)控制。編譯參數(shù)位于ohos -》 defaultConfig下，開發(fā)者需用以下方式設(shè)置JS模板代碼生成路徑，即‘jsOutputDir’對應(yīng)的值。代碼如下：

// 定義JS模板生成路徑def jsOutputDir = project.file（“src/main/js/default/generated”）.toString（）ohos { defaultConfig { javaCompileOptions { annotationProcessorOptions { // JS模板代碼生成路徑賦值 arguments = ［‘jsOutputDir’： jsOutputDir］ } } }}

工具開關(guān)位于ohos下，值設(shè)為true則啟用工具，false或不進(jìn)行配置則不啟用工具。配置代碼如下：

ohos { compileOptions { // 此處為啟用js2java-codegen工具的開關(guān)。值為true則啟用工具，false則不啟用工具。 f2pautogenEnabled true }}

3. PA側(cè)代碼編寫

開發(fā)者需在PA側(cè)用Java語言手動(dòng)編寫實(shí)現(xiàn)計(jì)算器業(yè)務(wù)邏輯的InternalAbility類，用于接收FA側(cè)傳來的運(yùn)算表達(dá)式，并對表達(dá)式的合法性進(jìn)行檢驗(yàn)。然后通過單獨(dú)編寫一個(gè)工具類來完成對運(yùn)算表達(dá)式的計(jì)算，并由InternalAbility來調(diào)用，將計(jì)算結(jié)果返回FA側(cè)。本示例中，開發(fā)者通過新建CalculateService類實(shí)現(xiàn)計(jì)算器的業(yè)務(wù)邏輯，并對CalculateService類本身添加@InternalAbility注解，表示該類為InternalAbility類，并且用參數(shù)指定該類注冊到同包中的MainAbility類。然后通過calculate（）方法來實(shí)現(xiàn)計(jì)算器的基本操作，包括入?yún)z驗(yàn)、調(diào)用工具類實(shí)現(xiàn)運(yùn)算表達(dá)式的計(jì)算、捕獲異常并返回結(jié)果，部分示例代碼如下所示：

package com.example.simplecalculatorfapa;import

com.example.simplecalculatorfapa.utils.Util;import

ohos.annotation.f2pautogen.InternalAbility;import java.util.EmptyStackException;import

java.util.regex.Pattern;// 注冊到同一個(gè)包下的MainAbility類中@InternalAbility（registerTo =

“com.example.simplecalculatorfapa.MainAbility”）public class CalculateService { public String

calculate（String exp） { // 排除不需計(jì)算就可發(fā)現(xiàn)的非法情況，此處列出一種為例 if （exp.isEmpty

（）） { return “NoResult”; } // ... // 使用工具類進(jìn)行計(jì)算，捕獲可能出現(xiàn)的異常 String result;

try { result = Util.getResult（exp）; } catch （NumberFormatException | ArithmeticException |

EmptyStackException e） { return “Wrong”; } // 返回合法結(jié)果 return result; }}

工具注解說明：js2java-codegen工具通過注解來獲取信息并生成開發(fā)者所需的代碼。因此用戶如果想使用該工具輔助開發(fā)，則需要了解以下三種注解的用法：@InternalAbility注解：類注解，用于被使用作InternalAbility的、包含實(shí)際業(yè)務(wù)代碼的類（簡稱InternalAbility類）。包含一個(gè)參數(shù)：registerTo，參數(shù)值為需要注冊的Ability類全名。

如下用例表示Service類是一個(gè)InternalAbility類，注冊到位于com.example包中的、名為Ability的Ability類。@InternalAbility （registerTo = “com.example.Ability”）

public class Service{}@ExportIgnore注解：方法注解，用于InternalAbility類中的某些方法，表示該方法不暴露給JS側(cè)來調(diào)用，僅對public方法有效。如下用例表示service方法不會被暴露給JS側(cè)。@ExportIgnore public int service（int input） {return input;}

@ContextInject注解：用于AbilityContext上的注解。該類由HarmonyOS的Java API提供，開發(fā)者可通過它獲取API中提供的信息。如下用例表示開發(fā)者可以借助abilityContext對象獲取API中提供的信息。

@ContextInject AbilityContext abilityContext;

4. 編譯

編寫完InternalAbility類的業(yè)務(wù)代碼后，下面FA調(diào)用PA的模板代碼生成工作就交給js2java-codegen工具吧！

開發(fā)者只需點(diǎn)擊菜單欄中的Build -》 Build HAP（s）/APP（s） -》 Build HAP（s），即可完成對項(xiàng)目的編譯，同時(shí)js2java-codegen工具會在編譯過程中完成FA調(diào)用PA通道代碼的生成。 編譯過程會生成Java和JS的模板代碼。

① 自動(dòng)生成的Java模板代碼位于entry 》 build 》 generated》 source 》 annotation 》 debug 下。部分Java模板代碼如下所示：

public boolean onRemoteRequest（int code，MessageParcel data， MessageParcel reply， MessageOption option） { Map《String， Object》 result = new HashMap《String，Object》（）; switch（code） { case OPCODE_calculate：{ java.lang.String zsonStr =data.readString（）; ZSONObject

zsonObject =ZSONObject.stringToZSON（zsonStr）; java.lang.String exp =zsonObject.getObject（“exp”，java.lang.String.class）;

result.put（“code”， SUCCESS）; result.put（“abilityResult”，service.calculate（exp））; break;} default:reply.writeString（“Opcode is not defined！”）;

return false; } return sendResult（reply，result， option.getFlags（） == MessageOption.TF_SYNC）;}rivate boolean sendResult（MessageParcel reply，Map《String， Object》 result， boolean isSync） { if （isSync） { reply.writeString（ZSONObject.toZSONString（result））; } else { MessageParcel response =MessageParcel.obtain（）;

response.writeString（ZSONObject.toZSONString（result））; IRemoteObject remoteReply =reply.readRemoteObject（）;

try { remoteReply.sendRequest（0， response，MessageParcel.obtain（）， new MessageOption（））; response.reclaim（）;

} catch （RemoteExceptionexception） { return false; } } return true;}

② 自動(dòng)生成的JS模板代碼位于開發(fā)者在編譯設(shè)置中設(shè)置的路徑，名稱與InternalAbility類的名稱相對應(yīng)。自動(dòng)生成的JS模板代碼如下所示：

// This file is automatically generated. Do not modify it！const ABILITY_TYPE_EXTERNAL = 0;const ABILITY_TYPE_INTERNAL = 1;

const ACTION_SYNC = 0;const ACTION_ASYNC = 1;const BUNDLE_NAME = ‘com.example.simplecalculatorfapa’;const ABILITY_NAME = ‘com.example.simplecalculatorfapa.CalculateServiceStub’;

const OPCODE_calculate = 0;const sendRequest = async （opcode， data） =》 { var action = {};

action.bundleName = BUNDLE_NAME; action.abilityName = ABILITY_NAME; action.messageCode = opcode; action.data = data; action.abilityType = ABILITY_TYPE_INTERNAL; action.syncOption = ACTION_SYNC; return FeatureAbility.callAbility（action）;

}class CalculateService { async calculate（exp） { if （arguments.length ！= 1） { throw new Error（“Method expected 1 arguments， got ” + arguments.length）;

} let data = {}; data.exp = exp; const result = await sendRequest（OPCODE_calculate， data）; return JSON.parse（result）;

}}export default CalculateService;

5. FA側(cè)代碼編寫

FA側(cè)的內(nèi)容包含“由html與css代碼編寫的靜態(tài)頁面”及“實(shí)現(xiàn)按鈕與方法動(dòng)態(tài)關(guān)聯(lián)的JS代碼”。首先，開發(fā)者需在開頭引入由js2java-codegen工具自動(dòng)生成的JS模板代碼的FA接口類，然后實(shí)現(xiàn)計(jì)算器按鈕對應(yīng)的方法。由于“=”按鈕對應(yīng)的方法調(diào)用了PA側(cè)的計(jì)算功能，因此需在該方法中新建FA接口示例，并調(diào)用對應(yīng)方法（名稱與InternalAbility類中需要被調(diào)用的方法名稱相同），并將輸入框的值傳入，將返回值打印在結(jié)果框中。

本示例中，開發(fā)者通過在開頭引入由js2java-codegen工具自動(dòng)生成的JS模板代碼的CalculateService接口類（from后的值需要與編譯設(shè)置中的路徑進(jìn)行統(tǒng)一，JS模板代碼文件名稱與InternalAbility類名相同），然后用data實(shí)現(xiàn)輸入框與結(jié)果框的動(dòng)態(tài)，并在等號按鈕對應(yīng)的calculate（）方法中新建接口實(shí)例，通過調(diào)用接口類的calculate（）方法，將輸入框值傳入，并把返回值賦給結(jié)果框。示例代碼如下所示：

// 引入calculateService類import CalculateService from ‘../../generated/CalculateService.js’;

export default { // 用于實(shí)現(xiàn)輸入框和結(jié)果框的動(dòng)態(tài)變化 data： { input： “”， // 輸入框內(nèi)容 result： “” // 結(jié)果框內(nèi)容 }， // 不需要調(diào)用PA的按鈕功能實(shí)現(xiàn)，此處列出退格鍵為例 deleteOne（） { this.result = “”; this.input = this.input.substr（0， this.input.length-1）;

}， // ... // 由等號觸發(fā)的方法，調(diào)用PA calculate（） { // 新建CalculateService示例 var service = new CalculateService（）;

// 調(diào)用calculate方法，傳入輸入框內(nèi)容并將返回結(jié)果賦值給結(jié)果框 service.calculate（this.input） .then（（data） =》 { this.result = data［“abilityResult”］;

}）; }}

啟動(dòng)手機(jī)模擬器，并運(yùn)行程序，即可生成結(jié)果。效果展示如下：

至此，一個(gè)運(yùn)用js2java-codegen工具開發(fā)的計(jì)算器Demo就完成了。該工具引入的代碼生成技術(shù)，大大提升了跨語言調(diào)用場景的開發(fā)效率，讓HarmonyOS開發(fā)者更能專注業(yè)務(wù)開發(fā)，提升開發(fā)體驗(yàn)。

責(zé)任編輯：haq