web-view用于在元服务中嵌入网页内容,它作为一个容器,能够将网页内容直接集成到元服务的界面中,使得用户可以在不离开元服务的情况下浏览网页,为用户提供无缝的浏览体验。
获取安装
可以通过NPM方式,将JS SDK集成到工程。
安装方法
在目标路径下打开cmd命令窗口,并执行以下npm命令,获得对应的js文件。
npm install @atomicservice/ascf-web-sdk
使用方法
ES6
import has from '@atomicservice/ascf-web-sdk';
has.ascfweb.getEnv((res) => {
console.info('getEnv success', res);
}); umd
<script src="../dist/ascf-web-sdk.umd.js"></script>
<script>
has.ascfweb.getEnv((res) => {
console.info('getEnv success', res);
});
</script> 在命令行中看到打印成功的结果,则说明已成功安装sdk,可以开发使用web-view组件。
复制npm安装包里面的ascf-web-sdk.umd.js文件,放到项目的静态资源目录后,需要将上述示例中script的src引用的目录改为对应的路径。
UserAgent
使用web-view访问服务器,会在系统的UserAgent追加ASCF/Appid,用于判断是否运行在元服务ASCF框架。
示例:
双向通信说明:
web-view内嵌H5页面通过has.ascfweb.postMessage接口向元服务发送消息,元服务侧通过bindmessage属性绑定事件接收消息。
元服务通过WebViewContext.postMessage接口向web-view内嵌H5页面发消息,H5页面通过has.ascfweb.onMessage接口接收消息。
示例:
服务端H5页面集成完JS SDK后,可以直接调用has.ascfweb.postMessage接口。
发送实时消息需要给options属性添加{ mode: 'realtime' }配置。
index.html:
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PostMessage H5</title>
<script src="ascf-web-sdk.umd.js"></script>
</head>
<body>
<h1>H5 - has.ascfweb.postMessage</h1>
<button type="button" class="button" onclick="postMessage1();">H5 发字符串消息给元服务</button>
<button type="button" class="button" onclick="postMessage2();">H5 发对象类型消息给元服务</button>
</body>
<script type="text/javascript">
// 发送string类型消息
function postMessage1() {
has.ascfweb.postMessage({
data: 'H5 string to Js',
options: { mode: 'realtime' },
success: () => {
console.info('postMessage success');
},
fail: (err) => {
console.error('postMessage fail:', err.message);
},
complete: (res) => {
console.info('postMessage complete:', res);
}
});
}
// 发送对象类型消息
function postMessage2() {
has.ascfweb.postMessage({
data: { name: 'H5 object to Js' },
options: { mode: 'realtime' },
success: () => {
console.info('postMessage success');
},
fail: (err) => {
console.error('postMessage fail:', err.message);
},
complete: (res) => {
console.info('postMessage complete:', res);
}
});
}
</script>
</html> 通过web-view组件指定对应url加载服务端的H5页面,给bindmessage属性绑定接收消息的回调函数。
xxx.hxml:
<web-view src="{{ url }}" bindmessage="onWebviewMessage"></web-view> xxx.js:
Page({
data: {
url: 'http://www.example.com/example.html' // 此处仅为样例,请开发者更换为可用网络地址
},
onWebviewMessage(e) {
// 接收H5页面发过来的消息
console.info('onWebviewMessage:', e.detail);
}
}); 服务端H5页面集成完JS SDK后,可以直接调用has.ascfweb.onMessage接口。通过onMessage来接收消息。
index.html:
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>PostMessage H5</title>
<script src="ascf-web-sdk.umd.js"></script>
</head>
<body>
<h1>H5 - has.ascfweb.onMessage</h1>
</body>
<script type="text/javascript">
// 监听JS发过来的消息
has.ascfweb.onMessage((data) => {
console.info('onMessage H5收到来自元服务的消息:', data);
});
</script>
</html> 通过web-view组件指定对应url加载服务端的H5页面。
xxx.hxml:
<view class="menu-list">
<view class="web-view-class">
<web-view src="{{ url }}" bindmessage="onWebviewMessage" class="web-view-class"></web-view>
</view>
<button bindtap="sendString" type="primary">发送字符串</button>
<button bindtap="sendSimpleObject" type="primary">发送简单对象消息</button>
</view> xxx.css:
.web-view-class {
height: 400px;
}
.menu-list {
display: flex;
flex-direction: column;
align-items: flex-start;
gap: 12px;
padding: 16px;
} 使用has.createWebViewContext()方法获取web-view组件控制实例,通过实例的postMessage方法发送消息。
xxx.js:
Page({
data: {
url: 'http://www.example.com/example.html' // 此处仅为样例,请开发者更换为可用网络地址
},
sendString() {
// 发字符串消息给H5页面
const ctx = has.createWebViewContext();
ctx.postMessage({
data: 'Js string message to H5',
success: () => {
console.info('postMessage success');
},
fail: (err) => {
console.error('postMessage fail:', err);
},
complete: (res) => {
console.info('postMessage complete:', res);
}
});
},
sendSimpleObject() {
// 发对象消息给H5页面
const ctx = has.createWebViewContext();
ctx.postMessage({
data: {
msg: 'JS object message to H5',
version: '1.0'
},
success: () => {
console.info('postMessage success');
},
fail: (err) => {
console.error('postMessage fail:', err);
},
complete: (res) => {
console.info('postMessage complete:', res);
}
});
}
});