YTKJsBridge-Android

一个基于kotlin的javascript bridge

特性

双向调用
同步、异步调用 *
动态、静态调用
不需要继承定制的WebView，代码侵入性小

* Android调用JS仅支持suspend function形式的同步调用

使用

Android调用JS

Javascript:

//注册 javascript API
ytkBridge.provide('functionName', function(arg){
    return arg + "ok";
})

异步调用

动态

webView.call("functionName", "arg1") { result: String ->
    ...
}

静态

interface JsFunctions {
    fun func1(
        arg1: String,
        arg2: Int,
        onComplete: ((result: String) -> Unit)? = null
    )
}

val js = webView.getJsInterface<JsFunction>()
js.func1(...) { result ->
    ...
}

同步调用

仅支持suspend function的方式，详见 kotlin coroutines

动态：

GlobalScope.launch {
    val result = webView.call("functionName", "arg1")
    ...
}

其中WebView.call是一个suspend函数

静态：

interface JsFunctions {
    suspend fun func1(arg1: String, arg2: Int): String
}

GlobalScope.launch {
    val js = webView.getJsInterface<JsFunction>()
    val result = js.func1("somearg", 123)
    ...
}

JS调用Android

Android端：

object JsApi {
    //同步API
    @JavascriptInterface
    fun testSync(msg: String): String {
        return msg + "［syn call］"
    }

    //异步API
    @JavascriptInterface
    fun testAsync(msg: String, onComplete: JsCallback) {
        // do some work
        onComplete.onReceiveValue(msg+" [ asyn call]")
    }
}

webView.addYTKJavascriptInterface(JsApi)

可以添加多个JsApi，并且无需指定注入变量名，在javascript中统一用ytkBridge调用。

Javascript:

//同步调用
var str = ytkBridge.call("testSync", "some msg");

//异步调用
ytkBridge.call("testAsync", "some msg", function (v) {
  alert(v);
})

namespace

addYTKJavascriptInterface可指定一个namespace参数，用于添加多个JsApi对象时的方法重名问题。例如

object JsApi1 {
    @JavascriptInterface
    fun testFunc(msg: String): String {
        return msg + ", this is JsApi1"
    }
}

object JsApi2 {
    @JavascriptInterface
    fun testFunc(msg: String): String {
        return msg + ", this is JsApi2"
    }
}

webView.addYTKJavascriptInterface(JsApi1, "api1" /*namespace*/)

webView.addYTKJavascriptInterface(JsApi2, "api2")

前端调用时用

var str = ytkBridge.call("api1.testFunc", "some msg");

如果一个WebView同时添加了JsApi1和JsApi2，并且不指定namespace，前端在调用重名的方法时会调用最后一个被添加的对象中的方法。

YoungLeung/YTKJsBridge-Android