demo地址:http://www.reibang.com/p/c20513cad758
前段時(shí)間項(xiàng)目有深度和前端對接過政模,也是碰了一些坑改鲫,現(xiàn)在有時(shí)間就拿出來分享下
JS調(diào)用原生不外乎就兩種追迟,一種是傳假的url艘刚,也就是url攔截的方式蚌成,類似于下面這種:
//js代碼
function sendCommand(param){
var url="js-call://"+param;
document.location = url;
}
sendCommand("PlaySnake");
//Java代碼
mWebView.setWebViewClient(new WebViewClient() {
@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
if (url.contains("js-call:")) {
if (url.contains("PlaySnake")) {
Log.d("X5WebViewActivity", "玩蛇");
} else if (url.contains("WhatDoesTheFoxSay")) {
Log.d("X5WebViewActivity", "叮鈴鈴鈴叮鈴鈴");
} else {
showInfoAsToast("龜兒娃,你調(diào)得不對");
}
return false;
}
view.loadUrl(url);
return true;
}
});
這種方法來調(diào)用原生晌砾,好處就是集成比較迅速坎拐,約定一個(gè)標(biāo)識(shí),類似于示例中的“js-call”养匈,再約定一波Type哼勇,比如“玩蛇”之類的,代碼很簡單呕乎,畢竟大家都很忙积担。
但是如果你打算長期把這個(gè)項(xiàng)目做下去的話,這種方式還是不要了吧猬仁,缺點(diǎn)太明顯了帝璧。首先是給原生傳數(shù)據(jù),只能是字符串湿刽;然后業(yè)務(wù)擴(kuò)展起來的烁,你的else if越寫越多,里面再加一大把switch诈闺,代碼越來臃腫撮躁,維護(hù)起來那感覺真的酸爽。
另一種就是通過谷歌提供的JS與Java綁定的接口买雾,約定好要交互的對象名把曼,類似于下面的“App”
//通過WebView提供的addJavascriptInterface這行代碼,我們在瀏覽器的JS環(huán)境中創(chuàng)建了一個(gè)"App"對象
//這個(gè)對象下的函數(shù)就是自定義接口類里面通過 @JavascriptInterface注解的Java方法轉(zhuǎn)換而來的
mWebView.addJavascriptInterface(new JavaFuckJSInterface(this), "App");
/**
* 自定義的交互接口類
*/
public class JavaFuckJSInterface{
private WeakReference<X5WebViewActivity> x5WebViewActivity;
public JavaFuckJSInterface(X5WebViewActivity context) {
x5WebViewActivity = new WeakReference<>(context);
}
//通過這個(gè)@JavascriptInterface轉(zhuǎn)化成綁定的“App”對象下的同名函數(shù)漓穿,js代碼可以直接調(diào)用
@JavascriptInterface
public void presentCamera(String data) {
//拍照上傳
x5WebViewActivity.get().presentCamera(data);
}
}
//js代碼
var parameter = {};
parameter.size = "1024*768";
parameter.format = "JPEG";
var parameterStr = JSON.stringify(parameter);
App.presentCamera(parameterStr);
這樣寫的話嗤军,規(guī)范了不少,即使函數(shù)再多晃危,這個(gè)接口里面也是一目了然叙赚,調(diào)函數(shù)就是調(diào)函數(shù),傳參數(shù)就是傳參數(shù)僚饭,相比于之前那個(gè)方法震叮,可讀性高了不少
不過上面寫的這些破玩意網(wǎng)上資料一大把,我特么是吃多了么鳍鸵,再寫一遍苇瓣?
NoNoNo,這些東西確實(shí)足夠我們與JS交互了偿乖,但是前端不想搞JSON.stringify(parameter)這種操作啊击罪,他要直接傳對象過來。為什么別人IOS都可以拿到我的對象贪薪,你拿的就是undefined媳禁?為什么別人IOS能給我對象,你就不給我對象画切,偏要給我字符串竣稽?憑什么別人IOS能拿到我的匿名回調(diào)函數(shù)來調(diào)用,你偏偏讓我寫一個(gè)回調(diào)函數(shù)給你調(diào)霍弹?
ok,也不是不能做到庞萍,不過這就需要通過注入JS代碼來完成了
talk is cheap , show me the code
下面這個(gè)微型的SDK能夠?qū)崿F(xiàn)互調(diào)傳JSON對象拧烦,調(diào)用js傳入的匿名函數(shù)
//需要注入的js代碼,加//"是因?yàn)楹啎鴷?huì)忽略\"這個(gè)回引號(hào)钝计,不加的話后面的代碼都是字符串的顏色了
//原理是通過這個(gè)SDKNativeEvents來保存?zhèn)魅氲哪涿瘮?shù)callback恋博,等原生做完該做的操作之后
//接著去調(diào)用sdk_nativeCallback這個(gè)函數(shù)來運(yùn)行存進(jìn)去的callback
var SDKNativeEvents = {}
function sdk_launchFunc(funcName,data,callback){
if(!data){
alert(\"必須傳入data\");//"
return;
}
if(!callback){
alert(\"必須傳入回調(diào)function\");//"
return;
}
SDKNativeEvents[funcName] = callback;
var jsObj={};
jsObj.funcName=funcName;
jsObj.data=JSON.stringify(data);
var str = JSON.stringify(jsObj);
App.native_launchFunc(str) //這個(gè)函數(shù)要在JavascriptInterface里申明
}
function sdk_nativeCallback(funcName,data){
var obj= JSON.parse(data);
if(SDKNativeEvents[funcName]){
SDKNativeEvents[funcName](obj);
if(funcName != \"updateLocation\"){//定位回調(diào)會(huì)不定時(shí)去重復(fù)觸發(fā),不做置空操作"
SDKNativeEvents[funcName] = null;
}
}
}
//下面實(shí)現(xiàn)的功能和通過@JavascriptInterface注解的Java方法是一樣的私恬,App為約定好的注入對象名
//App.xxx為暴露給前端的js函數(shù)
App.login = function(data,callback){
sdk_launchFunc(\"login\",data,callback);//"
}
App.xxxxxxxxxxxxx = function(data,callback){
sdk_launchFunc(\"xxxxxxxxxxxxx\",data,callback);//"
}
...
上面那些App.xxx的函數(shù)其實(shí)也可以不用注入债沮,實(shí)現(xiàn)起來就是把 sdk_launchFunc這個(gè)函數(shù)注入到App對象下面,讓前端直接調(diào)用本鸣,這樣不用增加一個(gè)調(diào)用就多注入一個(gè)函數(shù)疫衩,前端只用改funcName就能實(shí)現(xiàn)所有的調(diào)用。但是我覺得荣德,調(diào)函數(shù)就是調(diào)函數(shù)闷煤,傳參數(shù)就是傳參數(shù)童芹,將每個(gè)功能拆成function可以提高代碼的可讀性
注入JS代碼也很簡單,把上面那些js代碼都粘貼到string這個(gè)資源文件里面鲤拿,再通過mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code1))來注入就行假褪,其中js_sdk_code1就是js代碼的字符串
示例代碼:
//在網(wǎng)頁加載時(shí)提前注入,可以保證頁面一旦加載完畢前端就能立即調(diào)到函數(shù)
mWebView.setWebChromeClient(new WebChromeClient() {
@Override
public void onProgressChanged(WebView webView, int i) {
super.onProgressChanged(webView, i);
if (i >= 10 && canInject) {
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code1));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code2));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code3));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code4));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code5));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code6));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code7));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code8));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code9));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code10));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code11));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code12));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code13));
mWebView.loadUrl("javascript:" + getString(R.string.js_sdk_code14));
canInject = false;
}
if (i == 100) {
canInject = true;
}
}
});
這個(gè)時(shí)候有人就要問了近顷,怎么注入這么多次生音,我也不想啊,這里有個(gè)坑的窒升,一次注入的代碼超過三行左右(分號(hào)結(jié)束為一行)吧缀遍,就會(huì)有幾率出現(xiàn)注入失敗,會(huì)造成所有js代碼都沒法注入進(jìn)去饱须,我就干脆直接一次注入一行代碼來跳出這個(gè)坑域醇,比如下面的js_sdk_code3就可以注入,雖然這個(gè)function內(nèi)部有好幾行代碼冤寿,但是整體來說也算一行代碼歹苦,這行代碼定義了這個(gè)function。然而我又試了督怜,在這個(gè)function里面再多加一行代碼就會(huì)注入失敗殴瘦,搞得現(xiàn)在我也不確定他失敗的零界點(diǎn)在哪里,反正盡量拆開注入吧号杠。
細(xì)心的同學(xué)已經(jīng)發(fā)現(xiàn)了蚪腋,搞了這么多花里胡哨的,最關(guān)鍵的原生怎么來響應(yīng)js的調(diào)用還沒說明姨蟋,別急屉凯,下面上代碼
//@JavascriptInterface的代碼應(yīng)該放在哪里不用我講了吧
//通過與js交互的接口類來拿到做什么事,以及傳過來的JSON對象轉(zhuǎn)成的字符串
@JavascriptInterface
public void native_launchFunc(String data) {
try {
JSONObject jsonObject = new JSONObject(data);
String funcName = jsonObject.getString("funcName");
String dataStr = jsonObject.getString("data");
switchName(funcName, dataStr);
} catch (JSONException e) {
e.printStackTrace();
}
}
private void switchName(String funcName, String dataStr) {
if (funcName == null) {
return;
}
switch (funcName) {
case "login":
x5WebViewActivity.get().login(data);
break;
case "xxx":
x5WebViewActivity.get().xxx(data);
break;
}
}
//這里演示調(diào)用了login讓原生來登陸眼溶,等登陸成功之后悠砚,我們?nèi)フ{(diào)用js的匿名回調(diào),并傳入token
JsonObject jsonObject = new JsonObject();
jsonObject.addProperty("token", PreferencesHelper.getInstance().getToken());
String js = "javascript:sdk_nativeCallback(\'login\',\'" + jsonObject + "\')";
mWebView.loadUrl(js);
Android原生調(diào)用JS代碼也有兩種堂飞,一種是通過上面的loadUrl灌旧,一種是下面這種:
String script = "sdk_nativeCallback(\'login\',\'" + jsonObject + "\')";
mWebView.evaluateJavascript(script, responseJson -> {
if (!TextUtils.isEmpty(responseJson)) {
//拿到j(luò)s函數(shù)的返回值
}
});
區(qū)別就是一個(gè)能拿到j(luò)s函數(shù)的返回值,一個(gè)拿不到绰筛,這個(gè)根據(jù)自己的需求來選用
前端js調(diào)用原生傳入匿名回調(diào)的示例代碼:
//js代碼
var fucker = {};
fucker.name = "pdd";
fucker.age = 18;
App.login(fucker, function (data) {
if (data.err) {
alert(data.err);
}
alert(data.token);
});
我們可以看到枢泰,前端給我們傳入的是對象和匿名回調(diào)函數(shù),匿名回調(diào)需要的參數(shù)依然是個(gè)對象铝噩,我們通過注入的SDK保存了這個(gè)回調(diào)函數(shù)衡蚂,并自己做了對象和字符串轉(zhuǎn)換,實(shí)際上Java代碼最終拿到和傳出去還都是字符串,我們通過這個(gè)sdk統(tǒng)一的進(jìn)行了轉(zhuǎn)換毛甲,前端js代碼那邊不用判斷手機(jī)是iPhone或者是Android年叮,統(tǒng)一發(fā)出和接受對象,傳入回調(diào)函數(shù)丽啡,能夠減少他們很多工作量谋右。
對了补箍,因?yàn)锳ndroid版本不一致,webview的兼容性參差不齊啸蜜,選用了騰訊的X5內(nèi)核瀏覽器來加載坑雅,其中有個(gè)坑就是全屏播放視頻會(huì)有qq瀏覽器的廣告,這個(gè)可以通過代碼去掉衬横,也拿出來分享下吧:
//去掉QQ瀏覽器廣告
private void removeTbsAd() {
getWindow().getDecorView().addOnLayoutChangeListener
((v, left, top, right, bottom, oldLeft, oldTop, oldRight, oldBottom) -> {
ArrayList<View> outView = new ArrayList<>();
View decorView = getWindow().getDecorView();
decorView.findViewsWithText(outView, "相關(guān)視頻", View.FIND_VIEWS_WITH_TEXT);
decorView.findViewsWithText(outView, "QQ瀏覽器", View.FIND_VIEWS_WITH_TEXT);
if (outView.size() > 0) {
outView.get(0).setVisibility(View.GONE);
}
});
}