3 Star 2 Fork 1

CHINASOFT6_OHOS / JavaJsCommunication

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

HarmonyOS JS FA 调用 JAVA PA 机制

实现效果

ddd.gif

一、项目介绍

    本项目使用模拟文件下载进度变化的功能来给你展示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能力。

二、代码结构解读

屏幕截图 20210802 100439.png
    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

  1. 右击—new—new project 。 屏幕截图 20210802 112335.png

  2. 选择模板—next。
    屏幕截图 20210802 112527.png

  3. 输入项目名称、选择项目类型(单选)、api版本,设备类型,点击finish即可。 屏幕截图 20210802 112653.png

四、订阅PA解读

  1. 点击下载按钮,向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; // 隐藏进度条
        }
    })
}
  1. 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;
}
  1. 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();
}
  1. 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解读

  1. 获取input输入的值,作为js端传递过去的值。
 /** 
  * 取传过去的第一个值 
  */
    numOne (e){
        this.numOne = e.value
    },  
 /** 
  * 获取传过去的第二个值
  */
    numTwo (e){
        this.numTwo = e.value
    }
  1. 点击求积按钮 发送调用模式的请求。
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);
    }
},
  1. 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;
}
  1. 返回到前一个页面,这里在页面js中import router from '@system.router',然后利用router对象的相关方法返回。
back(){
    router.back() // 返回到前一个页面
}

六、代码参考

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

作者 :晋国晨

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Js FA 调用 Java PA示例 展开 收起
Java 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/chinasoft6_ohos/java-js-communication.git
git@gitee.com:chinasoft6_ohos/java-js-communication.git
chinasoft6_ohos
java-js-communication
JavaJsCommunication
master

搜索帮助