为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

时间:2023-03-09 04:28:32
为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

说起JSBridge,大家最熟悉的应该就是微信的WeixinJSBridge,通过它各个公众页面可以调用后台方法和微信进行交互,为用户提供相关功能。我们就来说说UWP下怎么样实现我们自己的JSBridge。

在win10之前,如果需要实现JSBridge,我们大概有两种方法:

1. window.external.notify

做过webview的小伙伴肯定都熟悉,html页面可以通过window.external.notify将消息发送出去,然后客户端使用WebView.ScriptNotify事件接收,但是两边都只能用字符串来交流,所以通常我们都会定义好消息格式(比如json)。现在在UWP中使用这种方法有个限制,就是你需要在.appxmanifest里把站点加到Content URIs中,告诉系统那些域名的js脚本是可以调用windows.external.notify方法的,当然如果是本地js就没有这个限制的,添加方法如下图。

为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

但是我们总会有些特殊需求,比如微信/淘宝应用怎么办?域名随时可能增加,总不能每次都更新manifest,然后更新商店吧!在8.1的时候我们还可以使用WebView.AllowedScriptNotifyUris在应用中动态添加信任站点,但是win10中这个接口已经废弃了,如果你的应用并不需要频繁/动态更改信任站点,这个方法还是可用的。

后台处理完结果之后,可以通过WebView.InvokeScript/InvokeScriptAsync方法调用当前页面中的js方法:

第一个参数是js方法名,第二个参数是调用这个方法需要的参数。

需要注意的是这个方法很容易出错,一定要注意异常捕获:(, 而且生成的异常基本都是一些0xXXXXX的code。

     public sealed partial class MainPage : Page
{
BridgeObject.Bridge _bridge = new BridgeObject.Bridge(); public MainPage()
{
this.InitializeComponent(); this.wv.ScriptNotify += Wv_ScriptNotify; this.Loaded += MainPage_Loaded;
} private async void Wv_ScriptNotify(object sender, NotifyEventArgs e)
{
await (new MessageDialog(e.Value)).ShowAsync(); //返回结果给html页面
await this.wv.InvokeScriptAsync("recieve", new[] { "hehe, 我是个结果"});
} private void MainPage_Loaded(object sender, RoutedEventArgs e)
{
//我们事先写好了一个本地html页面用来做测试
this.wv.Navigate(new Uri("ms-appx-web:///assets/html/index.html", UriKind.RelativeOrAbsolute));
}
}

html代码:

 <!DOCTYPE html>

 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title> <script> //通知后台
function func1()
{ window.external.notify("this is a message"); } //这个方法用来接收后台的结果
function recieve(value)
{
output.textContent = value;
} </script>
</head>
<body>
<div style="margin-top:100px">
<button id="fun1Btn" onclick="func1();">Call method 1</button>
<div id="output"></div>
</div>
</body>
</html>

为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

2. Url

是的,你没有看错,我们也可以通过url实现JSBridge,这也是我们在放弃上一种方法之后的一个备选方案,因为手淘就有之前说到的问题,站点可能不是固定的,而更新应用明显不是个明智的选择。具体就是每次html页面需要调用后台code的时候,都发起一次页面跳转,当然跳转的url符合一定的规则,并可以加上参数,然后我们用WebView.NavigationStarting事件截获这次跳转,并Cancel调这次跳转,这样一个看似可行的方案出炉啦,还是热乎的呢!!

代码其实很简单,就是解析url参数,然后再通过WebView.InvokeScript/InvokeScriptAsync方法返回结果给页面(这个方法不针对站点)。

         private void Wv_NavigationStarting(WebView sender, WebViewNavigationStartingEventArgs args)
{
if(args.Uri.OriginalString.StartsWith("http://our/jsbridge/url/pattern"))
{
//是一次jsbridge调用,取消本次跳转
args.Cancel = true; //这里具体解析url的参数
}
}

仔细想想。。好像也没什么不对,够动态,够简单。。。但现实总是残酷的,实际使用过程中突然发现,WebView的Url有最大长度限制,而且这个值比Android和IOS都要小很多,导致很多参数被截断了,最后只好放弃了。

就在上面两种方案都不能完美适应所有需求的时候,另外一种bulingbuling的方法出现在我们眼前:WebView.AddWebAllowedObject,这个方法是win10中新添加的方法,允许我们把Windows Runtime对象直接传递给JS调用!

下面是这个方法的定义:

public void AddWebAllowedObject(string name, object pObject)

name是对象在js中对应的全局变量名,通过这个方法传入到html页面中的对象都是挂在js的window对象上的,pObject就是要传入的对象。

首先新建一个Windows Runtime Component工程,添加一个新的类Bridge,我们之后就把这个传给也main,看看这个类有什么特殊的。

     //这个attribute是必须的,有了他我们的对象才能传递给WebView
[AllowForWeb]
public sealed class Bridge
{
/// <summary>
/// 提示一条消息
/// </summary>
/// <param name="msg"></param>
public void showMessage(string msg)
{
new MessageDialog(msg).ShowAsync();
} }

一切的魔法都在AllowForWebAttribute这个特性上,有了它,我们的对象就可以传递给webview,但是这里有一点一定要万分小心,必须在NavigationStarting调用AddWebAllowedObject方法才可以!(我不会告诉你,我在DomLoaded事件里折腾了好久。。。)

     public sealed partial class MainPage : Page
{
BridgeObject.Bridge _bridge = new BridgeObject.Bridge(); public MainPage()
{
this.InitializeComponent(); this.wv.NavigationStarting += Wv_NavigationStarting; this.Loaded += MainPage_Loaded;
} private void MainPage_Loaded(object sender, RoutedEventArgs e)
{
//我们事先写好了一个本地html页面用来做测试
this.wv.Navigate(new Uri("ms-appx-web:///assets/html/index.html", UriKind.RelativeOrAbsolute));
} private void Wv_NavigationStarting(WebView sender, WebViewNavigationStartingEventArgs args)
{
//OURBRIDGEOBJ这个是我们的对象插入到页面之后对象的变量名,这是一个全局变量,也就是window.OURBRIDGEOBJ
this.wv.AddWebAllowedObject("OURBRIDGEOBJ", _bridge);
}
}

现在是见证奇迹的时候了,来看看在js中怎么调用这个对象?(请忽略我这水平不怎么样的html code。。。)

 <!DOCTYPE html>

 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title> <script> function func1() {
// 首先判断我们对象是否正确插入
if (window.OURBRIDGEOBJ) {
//调用的我们消息函数
window.OURBRIDGEOBJ.showMessage("呵呵呵,我是个message");
}
}
</script>
</head>
<body>
<div style="margin-top:100px">
<button id="fun1Btn" onclick="func1();">Call method 1</button>
</div>
</body>
</html>

代码都很直接,唯一需要说明的就是一定要注意js中调用方法时首字母都是小写(即使你在后台定义的首字母大写!当然这应该也是为了符合js的使用习惯),来看看结果。

为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

当然如果它只有这点本事的话,并不会让人很激动,毕竟我们以前也可以做到。

继续之前,想想win10之前如果要通过jsbridge调用后台代码实现一个异步操作会怎么实现呢?

1). 首先我们的js调用和WebView.InvokeScript是分开,所以通常我们要为每一次js调用生成一个id

2). 后台完成操作之后,通过InvokeScript方法返回结果时,需要把本次调用id传回去,告诉页面这个哪次调用的结果

3). 然后js再根据这个id回调继续之前的操作。

但是现在我们可以抛弃那些繁琐的步骤了,我们的Windows Runtime Component支持异步(IAsyncAction/IAsyncOperation<T>),而js又支持Promise,结合在一起,你懂的!

先给我们的类添加一个简单的异步方法。

     //这个attribute是必须的,有了他我们的对象才能传递给WebView
[AllowForWeb]
public sealed class Bridge
{
/// <summary>
/// 提示一条消息
/// </summary>
/// <param name="msg"></param>
public void showMessage(string msg)
{
new MessageDialog(msg).ShowAsync();
} public Windows.Foundation.IAsyncOperation<int> giveMeAnObject(int num)
{
return Task.Run(async () =>
{
//延迟3秒钟,模拟异步任务:)
await Task.Delay(); return ++num;
}).AsAsyncOperation();
}
}

接下来我们在js端,用promise.then来等待结果。

 <!DOCTYPE html>

 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title> <script> function func1() {
// 首先判断我们对象是否正确插入
if (window.OURBRIDGEOBJ) {
//调用的我们消息函数
window.OURBRIDGEOBJ.showMessage("呵呵呵,我是个message");
}
} function func2() {
if (window.OURBRIDGEOBJ) { //对于js来说winrt的异步操作都会对应到promise上
var result = window.OURBRIDGEOBJ.giveMeAnObject(12); // 等待结果
result.then(function (nextNum) {
// nextNum就是IAsyncOperation<int>的真正返回值
output.textContent = nextNum;
}); }
}
</script>
</head>
<body>
<div style="margin-top:100px">
<button id="fun1Btn" onclick="func1();">Call method 1</button>
<button id="fun2Btn" onclick="func2();">Call method 2</button>
<div id="output" />
</div>
</body>
</html>

运行起来,等待3秒之后,结果出来了!

为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

另外这里再补充下评论中小伙伴关于事件的调用方法,其实事件的使用很简单,唯一需要注意的是c#的事件名称,到js里全都变成了小写的,下面是代码。

首先为我们的Bridge类添加一个事件和触发事件的公开方法(方便调试)。

     //这个attribute是必须的,有了他我们的对象才能传递给WebView
[AllowForWeb]
public sealed class Bridge
{
private IBridgeMethods _methods = null; public event EventHandler<int> SomethingChanged; public void FireEvent()
{
SomethingChanged?.Invoke(this, );
} /// <summary>
/// 提示一条消息
/// </summary>
/// <param name="msg"></param>
public void ShowMessage(string msg)
{
_methods?.ShowMessage(msg);
} public IAsyncOperation<int> giveMeAnObject(int num)
{
return _methods?.GiveMmeAnObject(num);
} /// <summary>
/// 初始化个方法的实现
/// </summary>
/// <param name="obj"></param>
public void Init(IBridgeMethods obj)
{
_methods = obj;
}
}

然后在js中添加listener,这里是要用js的标准方法!

 <!DOCTYPE html>

 <html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title> <script> function func1() {
// 首先判断我们对象是否正确插入
if (window.OURBRIDGEOBJ) {
//调用的我们消息函数
window.OURBRIDGEOBJ.showMessage("呵呵呵,我是个message");
}
} function func2() {
if (window.OURBRIDGEOBJ) { //对于js来说winrt的异步操作都会对应到promise上
var result = window.OURBRIDGEOBJ.giveMeAnObject(12); // 等待结果
result.then(function (nextNum) {
// nextNum就是IAsyncOperation<int>的真正返回值
output.textContent = nextNum;
}); }
} function bindEvent() {
if (window.OURBRIDGEOBJ) {
//注意事件名称!!!
window.OURBRIDGEOBJ.addEventListener("somethingchanged", function (value) {
output.textContent = "我是个事件回调: value="+value;
});
}
}
</script>
</head>
<body>
<div style="margin-top:100px">
<button id="fun1Btn" onclick="func1();">Call method 1</button>
<button id="fun2Btn" onclick="func2();">Call method 2</button>
<button id="bindBtn" onclick="bindEvent();">Bind event</button>
<div id="output" />
</div> </body>
</html>

最后在窗口上添加一个触发按钮。

     public sealed partial class MainPage : Page
{
BridgeObject.Bridge _bridge = new BridgeObject.Bridge(); public MainPage()
{
this.InitializeComponent(); this.wv.NavigationStarting += Wv_NavigationStarting; this.Loaded += MainPage_Loaded;
} private void MainPage_Loaded(object sender, RoutedEventArgs e)
{
//我们事先写好了一个本地html页面用来做测试
this.wv.Navigate(new Uri("ms-appx-web:///assets/html/index.html", UriKind.RelativeOrAbsolute));
} private void Wv_NavigationStarting(WebView sender, WebViewNavigationStartingEventArgs args)
{
//OURBRIDGEOBJ这个是我们的对象插入到页面之后对象的变量名,这是一个全局变量,也就是window.OURBRIDGEOBJ
this.wv.AddWebAllowedObject("OURBRIDGEOBJ", _bridge);
} private void Button_Click(object sender, RoutedEventArgs e)
{
// 触发自定义事件
_bridge.FireEvent();
}
}

结果如下。

为自己搭建一个鹊桥 -- Native Page与Web View之间的JSBridge实现方式

最后如果你觉得写component限制太多的话(继承都不让用。。),可以使用接口定义方法,然后在类库中实现这些方法也是一个不错的方案,下面是一个比较简单的实现供参考。

我们的jsbridge接口,包含我们准备提供的方法。

     /// <summary>
/// 用来定义JSBridge中实现的方法
/// </summary>
public interface IBridgeMethods
{
IAsyncOperation<int> GiveMmeAnObject(int num);
void ShowMessage(string message);
}

修改我们的Bridge类,所有的方法都通过上面的接口来提供。

    //这个attribute是必须的,有了他我们的对象才能传递给WebView
[AllowForWeb]
public sealed class Bridge
{
private IBridgeMethods _methods = null; /// <summary>
/// 提示一条消息
/// </summary>
/// <param name="msg"></param>
public void ShowMessage(string msg)
{
_methods?.ShowMessage(msg);
} public IAsyncOperation<int> giveMeAnObject(int num)
{
return _methods?.GiveMmeAnObject(num);
} /// <summary>
/// 初始化个方法的实现
/// </summary>
/// <param name="obj"></param>
public void Init(IBridgeMethods obj)
{
_methods = obj;
}
}