uni-app之web-view组件 postMessage 通信【跨端开发系列】

🔗 uniapp 跨端开发系列文章：🎀🎀🎀

uni-app 组成和跨端原理【跨端开发系列】
uni-app 各端差异注意事项【跨端开发系列】
uni-app 离线本地存储方案【跨端开发系列】
uni-app UI库、框架、组件选型指南【跨端开发系列】
uni-app 蓝牙开发【特别专题】
uni-app 导航栏开发指南【跨端开发系列】
uni-app 原生控件层级过高无法覆盖的解决方案【跨端开发系列】
uni-app 设置缓存过期时间【跨端开发系列】

一、介绍 🎯

uni-app 是一个使用 Vue.js 开发所有前端应用的框架，开发者编写一套代码，可发布到iOS、Android、Web（响应式）、以及各种小程序（微信/支付宝/百度/头条/飞书/QQ/快手/钉钉/淘宝）、快应用等多个平台。

uni-app在开发者数量、案例、跨端抹平度、扩展灵活性、性能体验、周边生态、学习成本、开发成本等8大关键指标上拥有更强的优势。

二、功能框架图 📋

从下面 uni-app 功能框架图可看出， uni-app 在跨平台的过程中，不牺牲平台特色，可优雅的调用平台专有能力，真正做到海纳百川、各取所长。

三、web-view 组件🧩

3.1 组件简介

web-view 是一个 web 浏览器组件，可以用来承载网页的容器，会自动铺满整个页面（nvue 使用需要手动指定宽高），功能类似于 html5 里的 iframe 元素。

各小程序平台，web-view 加载的 url 需要在后台配置域名白名单，包括内部再次 iframe 内嵌的其他 url 。

3.2 属性说明

属性名	类型	说明	平台差异说明
src	String	webview 指向网页的链接
allow	String	用于为 iframe 指定其特征策略	H5
sandbox	String	该属性对呈现在 iframe 框架中的内容启用一些额外的限制条件。	H5
fullscreen	Boolean	是否铺满整个页面，默认值：`true`。	H5 (HBuilder X 3.5.4+)
webview-styles	Object	webview 的样式	App-vue
update-title	Boolean	是否自动更新当前页面标题。默认值：`true`	App-vue (HBuilder X 3.3.8+)
@message	EventHandler	网页向应用 `postMessage` 时，会在特定时机（后退、组件销毁、分享）触发并收到消息。	H5 暂不支持（可以直接使用 window.postMessage）
@onPostMessage	EventHandler	网页向应用实时 `postMessage`	App-nvue
@load	EventHandler	网页加载成功时候触发此事件。	微信小程序、支付宝小程序、抖音小程序、QQ小程序
@error	EventHandler	网页加载失败的时候触发此事件。	微信小程序、支付宝小程序、抖音小程序、QQ小程序

属性 HarmonyOS Next 兼容性

名称	HarmonyOS Next 兼容性
src	HBuilderX 4.23
allow	x
sandbox	x
fullscreen	x
@message	HBuilderX 4.23

🎯注意

update-title 仅支持 App-vue 。小程序 恒为 true，H5、nvue 恒为 false

🪶src

来源	App	H5	微信小程序	支付宝小程序	百度小程序	抖音小程序、飞书小程序	QQ小程序	快应用	360小程序	快手小程序	京东小程序
网络	√	√	√	√	√	√	√	√	√	√	√
本地	√	√	x	x	x	x	x	x	x	x	x

🪶webview-styles

属性	类型	说明
progress	Object/Boolean	进度条样式。仅加载网络 HTML 时生效，设置为 `false` 时禁用进度条。
width	String	web-view 组件的宽度。
height	String	web-view 组件的高度。

🪶progress

属性	类型	默认值	说明
color	String	#00FF00	进度条颜色

3.3 代码示例

<template>
	<view>
		<web-view :webview-styles="webviewStyles" src="https://uniapp.dcloud.io/static/web-view.html"></web-view>
	</view>
</template>

<script>
	export default {
		data() {
			return {
				webviewStyles: {
					progress: {
						color: '#FF3333'
					}
				}
			}
		}
	}
</script>

<style>

</style>

🎯注意：

小程序 仅支持加载网络网页，🚫不支持 本地html。
补充说明：app-vue下 web-view 组件🚫不支持 自定义样式，而 v-show 的本质是改变组件的样式。即组件支持 v-if 而不是支持 v-show 。
小程序 端 web-view 组件一定有原生导航栏，下面一定是全屏的 web-view 组件， navigationStyle: custom 对 web-view 组件无效。
App 端使用 uni.web-view.js 的最低版为 uni.webview.1.5.4.js
App 平台同时支持 网络网页 和 本地网页 ，但本地网页及相关资源（js、css等文件）必须放在 uni-app 项目根目录 -> hybrid -> html 文件夹下或者 static 目录下，如下为一个加载本地网页的 uni-app 项目文件目录示例：
nvue web-view 必须指定样式宽高
App 网页向应用 postMessage 为实时消息
app-nvue web-view 默认没有大小，可以通过样式设置大小，如果想充满整个窗口，设置 flex: 1 即可，标题栏不会自动显示 web-view 页面中的 title 。如果想充满整个窗口且想要显示标题推荐使用 vue 页面的 web-view (默认充满屏幕不可控制大小), 想自定义 web-view 大小使用 nvue web-view 。

3.4 消息通信

宿主和 iframe 的通信我们都知道可以通过 postMessage 来实现，我在开发 “Mrcori 吾码界面设计引擎” 时有实战用到过。uniapp 也有这么一个方法，就是 uni.postMessage ，是不是很像呢。

通过 uni.postMessage(OBJECT) 网页向应用发送消息，在 <web-view> 的 message 事件回调 event.detail.data 中接收消息。

Tips

传递的消息信息，必须写在 data 对象中。
event.detail.data 中的数据，以数组的形式接收每次 post 的消息。（注：支付宝小程序除外，支付宝小程序中以对象形式接受

在 <web-view> 加载的 HTML 中，添加以下代码：

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1,minimum-scale=1,maximum-scale=1,user-scalable=no" />
    <title>网络网页</title>
    <style type="text/css">
      .btn {
        display: block;
        margin: 20px auto;
        padding: 5px;
        background-color: #007aff;
        border: 0;
        color: #ffffff;
        height: 40px;
        width: 200px;
      }

      .btn-red {
        background-color: #dd524d;
      }

      .btn-yellow {
        background-color: #f0ad4e;
      }

      .desc {
        padding: 10px;
        color: #999999;
      }

      .post-message-section {
        visibility: hidden;
      }
    </style>
  </head>
  <body>
    <p class="desc">web-view 组件加载网络 html 示例。点击下列按钮，跳转至其它页面。</p>
    <div class="btn-list">
      <button class="btn" type="button" data-action="navigateTo">navigateTo</button>
      <button class="btn" type="button" data-action="redirectTo">redirectTo</button>
      <button class="btn" type="button" data-action="navigateBack">navigateBack</button>
      <button class="btn" type="button" data-action="reLaunch">reLaunch</button>
      <button class="btn" type="button" data-action="switchTab">switchTab</button>
    </div>
    <div class="post-message-section">
      <p class="desc">网页向应用发送消息，注意：小程序端应用会在此页面后退时接收到消息。</p>
      <div class="btn-list">
        <button class="btn btn-red" type="button" id="postMessage">postMessage</button>
      </div>
    </div>
    <script type="text/javascript">
      var userAgent = navigator.userAgent;
      if (userAgent.indexOf('AlipayClient') > -1) {
        // 支付宝小程序的 JS-SDK 防止 404 需要动态加载，如果不需要兼容支付宝小程序，则无需引用此 JS 文件。
        document.writeln('<script src="https://appx/web-view.min.js"' + '>' + '<' + '/' + 'script>');
      } else if (/QQ/i.test(userAgent) && /miniProgram/i.test(userAgent)) {
        // QQ 小程序
        document.write(
          '<script type="text/javascript" src="https://qqq.gtimg.cn/miniprogram/webview_jssdk/qqjssdk-1.0.0.js"><\/script>'
        );
      } else if (/miniProgram/i.test(userAgent) && /micromessenger/i.test(userAgent)) {
        // 微信小程序 JS-SDK 如果不需要兼容微信小程序，则无需引用此 JS 文件。
        document.write('<script type="text/javascript" src="https://res.wx.qq.com/open/js/jweixin-1.4.0.js"><\/script>');
      } else if (/toutiaomicroapp/i.test(userAgent)) {
        // 头条小程序 JS-SDK 如果不需要兼容头条小程序，则无需引用此 JS 文件。
        document.write(
          '<script type="text/javascript" src="https://s3.pstatp.com/toutiao/tmajssdk/jssdk-1.0.1.js"><\/script>');
      } else if (/swan/i.test(userAgent)) {
        // 百度小程序 JS-SDK 如果不需要兼容百度小程序，则无需引用此 JS 文件。
        document.write(
          '<script type="text/javascript" src="https://b.bdstatic.com/searchbox/icms/searchbox/js/swan-2.0.18.js"><\/script>'
        );
      } else if (/quickapp/i.test(userAgent)) {
        // quickapp
        document.write('<script type="text/javascript" src="https://quickapp/jssdk.webview.min.js"><\/script>');
      }
      if (!/toutiaomicroapp/i.test(userAgent)) {
        document.querySelector('.post-message-section').style.visibility = 'visible';
      }
    </script>
    <!-- uni 的 SDK -->
    <!-- 需要把 uni.webview.1.5.6.js 下载到自己的服务器 -->
    <script type="text/javascript" src="https://gitcode.net/dcloud/uni-app/-/raw/dev/dist/uni.webview.1.5.6.js"></script>
    <script type="text/javascript">
      // 待触发 `UniAppJSBridgeReady` 事件后，即可调用 uni 的 API。
      document.addEventListener('UniAppJSBridgeReady', function() {
        uni.postMessage({
            data: {
                action: 'message'
            }
        });
        uni.getEnv(function(res) {
            console.log('当前环境：' + JSON.stringify(res));
        });

        document.querySelector('.btn-list').addEventListener('click', function(evt) {
          var target = evt.target;
          if (target.tagName === 'BUTTON') {
            var action = target.getAttribute('data-action');
            switch (action) {
              case 'switchTab':
                uni.switchTab({
                  url: '/pages/tabBar/API/API'
                });
                break;
              case 'reLaunch':
                uni.reLaunch({
                  url: '/pages/tabBar/component/component'
                });
                break;
              case 'navigateBack':
                uni.navigateBack({
                  delta: 1
                });
                break;
              default:
                uni[action]({
                  url: '/pages/component/button/button'
                });
                break;
            }
          }
        });
        document.getElementById('postMessage').addEventListener('click', function() {
          uni.postMessage({
            data: {
              action: 'message'
            }
          });
        });
      });
    </script>
  </body>
</html>

四、App端web-view的扩展💢

App 端的 webview 是非常强大的，可以更灵活的控制和拥有更丰富的API。

每个 vue 页面，其实都是一个webview，而 vue 页面里的 web-view 组件，其实是 webview 里的一个子 webview 。这个子 webview 被 append 到父 webview 上。

通过以下方法，可以获得这个 web-view 组件对应的 js 对象，然后参考HTML5+ API Reference，可以进一步重设这个 web-view 组件的样式，比如调整大小：

<template>
	<view>
		<web-view src="https://www.baidu.com"></web-view>
	</view>
</template>
<script>
var wv;//计划创建的webview
export default {
	onReady() {
		// #ifdef APP-PLUS
		var currentWebview = this.$scope.$getAppWebview() //此对象相当于html5plus里的plus.webview.currentWebview()。在uni-app里vue页面直接使用plus.webview.currentWebview()无效
		setTimeout(function() {
			wv = currentWebview.children()[0]
			wv.setStyle({top:150,height:300})
		}, 1000); //如果是页面初始化调用时，需要延时一下
		// #endif
	}
};
</script>

甚至可以不用 web-view 组件，直接 js 创建一个子 webview 来加载 html。比如不希望远程网页使用 plus 的API，不管是因为安全原因还是因为 back 监听冲突，可以使用如下代码：

<template>
	<view>
	</view>
</template>
<script>
var wv;//计划创建的webview
export default {
	onLoad() {
		// #ifdef APP-PLUS
		wv = plus.webview.create("","custom-webview",{
			plusrequire:"none", //禁止远程网页使用plus的API，有些使用mui制作的网页可能会监听plus.key，造成关闭页面混乱，可以通过这种方式禁止
      'uni-app': 'none', //不加载uni-app渲染层框架，避免样式冲突
			top:uni.getSystemInfoSync().statusBarHeight+44 //放置在titleNView下方。如果还想在webview上方加个地址栏的什么的，可以继续降低TOP值
		})
		wv.loadURL("https://www.baidu.com")
		var currentWebview = this.$scope.$getAppWebview(); //此对象相当于html5plus里的plus.webview.currentWebview()。在uni-app里vue页面直接使用plus.webview.currentWebview()无效
		currentWebview.append(wv);//一定要append到当前的页面里！！！才能跟随当前页面一起做动画，一起关闭
		setTimeout(function() {
			console.log(wv.getStyle())
		}, 1000);//如果是首页的onload调用时需要延时一下，二级页面无需延时，可直接获取
		// #endif
	}
};
</script>

如果想设置 web-view 组件可双指缩放，可参考如下代码：

export default {
	onReady() {
		// #ifdef APP-PLUS
		var currentWebview = this.$scope.$getAppWebview() //获取当前页面的webview对象
		setTimeout(function() {
			wv = currentWebview.children()[0]
			wv.setStyle({scalable:true})
		}, 1000); //如果是页面初始化调用时，需要延时一下
		// #endif
	}
};

4.1 web-view 组件的层级问题解决

web-view 组件在 App 和小程序中层级较高，如需要在vue页面中写代码为 web-view 组件覆盖内容，小程序端无解，只能由 web-view 的组件自己弹出 div 。App 端有如下若干方案：

比较简单的方式是 actionsheet 等原生弹出菜单（小程序也可以使用此方案）
使用 plus.nativeObj.view 。这里有一个底部图标菜单的示例，可参考底部图标菜单 imagemenu - DCloud 插件市场
使用原生子窗体subNvue
可以在 web-view 组件内嵌的网页中弹出 z-index 更高的 div 。如果是外部网页，可以在 vue中获得子 webview 对象后，通过 evalJS 为这个子 webview 注入一段 js，操作其弹出div层。

4.2 web-view 组件的浏览器内核说明

H5 端的 web-view 其实是被转为 iframe 运行，使用的是当前的浏览器
小程序的 web-view 使用的是小程序自带的浏览器内核，不同厂商不一样，详见
App 端，Android，默认使用的是 os 自带的浏览器内核，在设置-所有应用里，显示系统服务，可查看 Android System Webview 的版本。在Android5+，系统 webview 支持安装升级。
App 端，Android，支持在 manifest 中配置选用腾讯 X5 浏览器内核。使用 x5 内核需要一些注意事项！具体请参考详见
App 端，iOS，是分为 UIWebview 和 WKWebview 的，2.2.5+起默认为 WKWebview 。

注意事项

<web-view> 组件默认铺满全屏并且层级高于前端组件。App 端想调节大小或在其上覆盖内容需使用 plus 规范，H5 端可以改为直接使用 iframe。
<web-view> 组件所在窗口的标题，跟随页面的 <title> 值的变化而变化（不含H5端）。
App-vue 的 web-view 加载的html页面可以运行 plus 的 api ，但注意如果该页面调用了plus.key 的API监听了 back 按键（或使用 mui 的封装），会造成 back 监听冲突。需要该 html 页面移除对 back 的监听。或按照上面的示例代码禁止网页使用 plus 对象。app-nvue 页面的 web-view 组件不能运行 plus API。
uni.webview.js 最新版地址：https://gitcode.net/dcloud/uni-app/-/raw/dev/dist/uni.webview.1.5.6.js
小程序平台，个人类型与海外类型的小程序使用 web-view 组件，提交审核时注意微信等平台是否允许使用
小程序平台， src 指向的链接需登录小程序管理后台配置域名白名单。App 和 H5 无此限制。

4.3 UniAppJSBridgeReady 的使用

uni.webView.navigateTo 示例，注意 uni sdk 放到 body 下面

<!DOCTYPE html>
<html lang="zh-CN">
  <head>
    ...
  </head>
  <body>
    <noscript>
      <strong>Please enable JavaScript to continue.</strong>
    </noscript>
    <div id="app"></div>
    <!-- built files will be auto injected -->
  </body>
  <!-- uni 的 SDK -->
  <!-- 需要把 uni.webview.1.5.6.js 下载到自己的服务器 -->
  <script type="text/javascript" src="https://gitcode.net/dcloud/uni-app/-/raw/dev/dist/uni.webview.1.5.6.js"></script>
  <script>
    document.addEventListener('UniAppJSBridgeReady', function() {
      uni.webView.getEnv(function(res) {
        console.log('当前环境：' + JSON.stringify(res));
      });
      // uni.webView.navigateTo(...)
    });
  </script>
</html>

4.4 nvue webview 通信示例

<template>
	<view>
		<web-view ref="webview" class="webview" @onPostMessage="handlePostMessage"></web-view>
		<button class="button" @click="evalJs">evalJs(改变webview背景颜色)</button>
	</view>
</template>

<script>
	export default {
		data: {
		},
		methods: {
			// webview向外部发送消息
			handlePostMessage: function(data) {
				console.log("接收到消息：" + JSON.stringify(data.detail));
			},
			// 调用 webview 内部逻辑
			evalJs: function() {
				this.$refs.webview.evalJs("document.body.style.background ='#00FF00'");
			}
		}
	}
</script>

🔗 uniapp 跨端开发系列文章：🎀🎀🎀