2 Star 5 Fork 3

Archermind-TI / JsBridge

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

JsBridge

项目介绍

  • 功能: 轻量可扩展 OHOS WebView 和 Javascript 双向交互框架。

image

安装教程

方式一

  1. 将debugkit模块内容拷贝到自己项目对应模块目录下
  2. 在需要使用的模块的build.gradle中引入
dependencies {
    compile project(path: ':jsbridge')
}

在sdk5,DevEco Studio2.1 Release下项目可直接运行

方式二

在project的build.gradle中添加mavenCentral()的引用

repositories {   
 	...   
 	mavenCentral()   
	 ...           
 }

在entry的build.gradle中添加依赖

dependencies { 
... 
implementation 'com.gitee.archermind-ti:jsbridge-ohos:1.0.0-beta2' 
implementation 'org.json:json:20090211'
... 
}

使用说明

我们以 JS 调用原生模块来实现 ajax 跨域请求来简单介绍下库的使用

1.创建模块

创建模块需要继承 JsModule 并实现getModuleName 方法, 模块命名要求和 java 变量命名一致, 不允许为空, 只允许 下划线(_) 字母 和数字, 如果是静态模块(不包含模块名),需要继承JsStaticModule, 下面创建了一个 Native 模块

public class NativeModule extends JsModule {

@Override
public String getModuleName() {
    return "native";
}

}

2.创建调用方法

Module 里面创建方法需要使用注解@JSBridgeMethod, 默认情况下 Java 方法名就是 JS 调用的方法名, 也可以通过@JSBridgeMethod(methodName = "xx")来指定调用方法名。方法要求不能为 static 或者 abstract, 可以包含返回类型,如果返回类型是对象默认转为 String 后返回给 JS, 方法的参数要求为以下类型,可以直接映射到它们对应的JS类型

Java 类型 映射的 JS 类型
Boolean / boolean Bool
Integer/ int Number
Float / float Number
Double / double Number
Long / long Number
String String
JBCallback function
JBMap Object
JBArray Array

为了 JS 更方便调用, 我们把方法参数定义成ajax一样, 我们先看下 ajax 请求结构

$.ajax({

	type:'GET',
	url:'xxx.com',
	dataType:'text'
	data:{a:1, b:'xx'},
	success:function(data){
	},
	error:function(err){
	}
})

ajax 方法参数是一个 JS 对象, 对象包含type、url、dataType 三个string 参数,data 参数也是一个对象,success 和 error 是 JS 回调方法,下面我们来定义 Java 方法。

@JSBridgeMethod
public void ajax(JBMap dataMap) {

        String type = dataMap.getString("type");
        String url = dataMap.getString("url");
        JBMap data = dataMap.getJBMap("data");
        JBCallback successCallback = dataMap.getCallback("success");
        JBCallback errorCallback = dataMap.getCallback("error");
        // 省略请求代码
        if (请求成功) {
        	  successCallback.apply(返回数据);
        } else {
        	  errorCallback.apply(错误);
        }
}

必须要添加@JSBridgeMethod注解,参数是JBMap 映射到 JS 的对象

JBCallback.apply用来回调 JS 的回调方法,不定参数,支持 Java 基本类型,数组(WritableJBArray),和 对象(WritableJBMap), 如果为其他对象,默认转为 string转递给 JS

3.注册 Module 有两种方式可以注册 module, 默认注册, 动态注册

JsBridgeConfig.getSetting().registerDefaultModule(NativeModule.class);

// 或者

JsBridge.loadModule(NativeModule.class) JsBridgeConfig 配置下如下:

方法 类型 描述 默认
setProtocol string JS调用的对象名 JsBridge
setLoadReadyMethod string 加载完成回调函数 onJsBridgeReady
registerDefaultModule JsModule 公用模块, 默认加载
debugMode bool 调试模式下输出TAG 为JsBridgeDebug 的日志 false

4.WebView 注入方法 & 设置回调

public class WebViewAbility extends BaseAbility {

   private JsBridge jsBridge;

    @Override
   public void onStart(Intent intent) {

       jsBridge = JsBridge.loadModule();
        WebView webView = (WebView) findComponentById(ResourceTable.Id_webview);
        
         webView.setBrowserAgent(new BrowserAgent(this) {
            
                   @Override
                   public boolean onJsTextInput(WebView webView, String url, String message, String defaultInput, JsTextInputResult result) {
      
                       if (jsBridge.callJsPrompt(message, result)) {
                           return true;
                       }
                       return super.onJsTextInput(webView, url, message, defaultInput, result);
                   }
       
               });
       
        webView.setWebAgent(new WebAgent() {
       
                   @Override
                   public void onPageLoaded(WebView webView, String url) {
                       super.onPageLoaded(webView, url);
                       // 页面加载结束后自定义处理
                       jsBridge.injectJs(getAbility(),webView);
                   }
               });
      
           }
   }

    @Override
    public void terminateAbility() {
        jsBridge.release();
        super.terminateAbility();
    
    }
}

现在,在 JS 代码中可以这样调用这个方法:

JsBridge.native.ajax({

	type:'GET',
	url:'xxx.com',
	dataType:'text'
	data:{a:1, b:'xx'},
	success:function(data){
	},
	error:function(err){
	}
})

如果想直接JsBridge.ajax, 把父类从JsModule 改成 JsStaticModule就好了

还有一个问题值得注意,因为 JS 执行是异步的,为了确保注入 JS 已经完成,请在回调里执行方法,或者判断 JsBridge 对象存在

window.onJsBridgeReady = function () {

    JsBridge.native.ajax({...});
}

// 或者

document.addEventListener('onJsBridgeReady', function(){

    JsBridge.native.ajax({...});
})

// 或者

if (JsBridge) {

	JsBridge.native.ajax({...});
}

更多的文档和示例请参考sample

版本迭代

  • v1.0.0

基线release版本

Releases v2.1.0

commit id af7f491e1c081cd1be5646fb200c1a0eacbe8e24

版权和许可信息

Copyright pengwei1024

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.

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.

About

A simpler, extendable bidirectional communication Frame between WebView and Javascript for OHOS expand collapse
Java and 2 more languages
Apache-2.0
Cancel

Releases (2)

All

Contributors

All

Activities

Load More
can not load any more
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/archermind-ti/jsbridge.git
git@gitee.com:archermind-ti/jsbridge.git
archermind-ti
jsbridge
JsBridge
master

Search

344bd9b3 5694891 D2dac590 5694891