HarmonyOS:使用ArkWeb构建页面
一、简介
页面加载是Web组件的基本功能。根据页面加载数据来源可以分为三种常用场景,包括加载网络页面、加载本地页面、加载HTML格式的富文本数据。
页面加载过程中,若涉及网络资源获取,需要配置ohos.permission.INTERNET网络访问权限。
二、加载网络页面
开发者可以在Web组件创建时,指定默认加载的网络页面 。在默认页面加载完成后,如果开发者需要变更此Web组件显示的网络页面,可以通过调用loadUrl()接口加载指定的网页。Web组件的第一个参数变量src不能通过状态变量(例如:@State)动态更改地址,如需更改,请通过loadUrl()重新加载。
在下面的示例中,在Web组件加载完“https://www.baidu.com/”页面后,开发者可通过loadUrl接口将此Web组件显示页面变更为“https://www.baidu.com/xxx”。
提醒:
首先需要在products/default/src/main/module.json5文件中先配置好允许程序打开网络套接字,即申请权限ohos.permission.INTERNET。
"requestPermissions": [
{
"name": "ohos.permission.INTERNET",
"reason": "$string:apply_for_network"
}
],
{
"name": "apply_for_network",
"value": "允许应用使用网络"
}
示例代码
import { webview } from '@kit.ArkWeb'
import { BusinessError } from '@kit.BasicServicesKit';
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController()
build() {
Column() {
Button('loadUrl').onClick(() => {
try {
// 点击按钮时,通过loadUrl,跳转到 https://developer.huawei.com/consumer/cn/
this.controller.loadUrl('https://developer.huawei.com/consumer/cn/');
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`ErrorCode: ${e.code}, Message: ${e.message}`);
}
})
Web({
src: 'https://www.baidu.com/',
controller: this.controller
})
}
.height('100%')
.width('100%')
}
}
注意
如果希望看到效果,需要在真机或者模拟器上运行代码,Previewer暂不支持Web组件的预览效果。
三、加载本地页面
将本地页面文件放在应用的rawfile目录下,开发者可以在Web组件创建的时候指定默认加载的本地页面 ,并且加载完成后可通过调用loadUrl()接口变更当前Web组件的页面。
在下面的示例中展示加载本地页面文件的方法:
示例代码
import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { promptAction } from '@kit.ArkUI';
// 使用 ArkWeb构建页面 https://developer.huawei.com/consumer/cn/training/course/slightMooc/C101717497640610394
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController()
//加载网络页面
// private url: string = 'https://www.baidu.com/'
//加载本地页面
private url: Resource = $rawfile("testH.html")
build() {
Column() {
Row() {
Button('loadUrl').onClick(() => {
try {
// 点击按钮时,通过loadUrl,跳转到https://developer.huawei.com/consumer/cn/
// this.controller.loadUrl('https://developer.huawei.com/consumer/cn/');
if (this.controller.accessForward()) {
console.log("执行了 forward")
this.controller.forward()
} else {
console.log("执行了 loadUrl")
this.controller.loadUrl($rawfile("testH2.html"));
}
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`loadUrl ErrorCode: ${e.code}, Message: ${e.message}`);
}
}).margin({ right: 20 })
Button('返回').onClick(() => {
try {
if (this.controller.accessBackward()) {
this.controller.backward()
} else {
promptAction.showToast({ message: "已经是首页了" })
}
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`返回 ErrorCode: ${e.code}, Message: ${e.message}`);
}
})
}.margin({ top: 20 })
Web({
src: this.url,
controller: this.controller
})
}
.height('100%')
.width('100%')
}
}
将资源文件放置在应用的resources/rawfile目录下。
效果图
四、加载HTML格式的文本数据
Web组件可以通过loadData()接口实现加载HTML格式的文本数据。当开发者不需要加载整个页面,只需要显示一些页面片段时,可通过此功能来快速加载页面。
示例代码
import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';
import { promptAction } from '@kit.ArkUI';
// 使用 ArkWeb构建页面 https://developer.huawei.com/consumer/cn/training/course/slightMooc/C101717497640610394
@Entry
@Component
struct WebComponent {
controller: webview.WebviewController = new webview.WebviewController()
//加载网络页面
// private url: string = 'https://www.baidu.com/'
//加载本地页面
private url: Resource = $rawfile("testH.html")
build() {
Column() {
Row() {
Button('loadUrl').onClick(() => {
try {
if (this.controller.accessForward()) {
console.log("执行了 forward")
this.controller.forward()
} else {
console.log("执行了 loadUrl")
//加载网络页面
let tempUrl = "https://developer.huawei.com/consumer/cn/"
//加载本地页面
let tempUrlRes = $rawfile("testH2.html")
// this.controller.loadUrl(tempUrlRes);
// 点击按钮时,通过loadData,加载HTML格式的文本数据
this.controller.loadData(
"<html><body bgcolor=\"white\">Source:<pre>source</pre><p>加载HTML格式的文本数据</P></body></html>",
"text/html",
"UTF-8"
);
}
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`loadUrl ErrorCode: ${e.code}, Message: ${e.message}`);
}
}).margin({ right: 20 })
Button('返回').onClick(() => {
try {
if (this.controller.accessBackward()) {
this.controller.backward()
} else {
promptAction.showToast({ message: "已经是首页了" })
}
} catch (error) {
let e: BusinessError = error as BusinessError;
console.error(`返回 ErrorCode: ${e.code}, Message: ${e.message}`);
}
})
}.margin({ top: 20 })
Web({
src: this.url,
controller: this.controller
})
}
.height('100%')
.width('100%')
}
}
效果图
五、动态创建Web组件
支持命令式创建Web组件,这种方式创建的组件不会立即挂载到组件树,即不会对用户呈现(组件状态为Hidden和InActive),开发者可以在后续使用中按需动态挂载。后台启动的Web实例不建议超过200个。
import { createNWeb } from '../pages/web/CommonWeb'
// 载体Ability
// EntryAbility.ets
import { createNWeb } from "../pages/common"
onWindowStageCreate(windowStage: window.WindowStage): void {
windowStage.loadContent('pages/Index', (err, data) => {
// 创建Web动态组件(需传入UIContext),loadContent之后的任意时机均可创建
createNWeb("https://www.example.com", windowStage.getMainWindowSync().getUIContext());
if (err.code) {
return;
}
});
}
CommonWeb.ets代码
import { webview } from '@kit.ArkWeb'
import { NodeController, BuilderNode, Size, FrameNode, UIContext } from '@kit.ArkUI';
/*
动态创建Web组件 https://developer.huawei.com/consumer/cn/training/course/slightMooc/C101717497640610394
支持命令式创建Web组件,这种方式创建的组件不会立即挂载到组件树,即不会对用户呈现(组件状态为Hidden和InActive),
开发者可以在后续使用中按需动态挂载。后台启动的Web实例不建议超过200个。
*/
// @Builder中为动态组件的具体组件内容
// Data为入参封装类
class Data {
url: string = "https://developer.huawei.com/consumer/cn/";
controller: WebviewController = new webview.WebviewController();
}
@Builder
function WebBuilder(data: Data) {
Column() {
Web({ src: data.url, controller: data.controller })
.width("100%")
.height("100%")
}
}
let wrap = wrapBuilder<Data[]>(WebBuilder);
// 用于控制和反馈对应的NodeContainer上的节点的行为,需要与NodeContainer一起使用
export class myNodeController extends NodeController {
private rootnode: BuilderNode<Data[]> | null = null;
// 必须要重写的方法,用于构建节点数、返回节点挂载在对应NodeContainer中
// 在对应NodeContainer创建的时候调用、或者通过rebuild方法调用刷新
makeNode(uiContext: UIContext): FrameNode | null {
console.log(" uicontext is undefined : " + (uiContext === undefined));
if (this.rootnode != null) {
// 返回FrameNode节点
return this.rootnode.getFrameNode();
}
// 返回null控制动态组件脱离绑定节点
return null;
}
// 当布局大小发生变化时进行回调
aboutToResize(size: Size) {
console.log("aboutToResize width : " + size.width + " height : " + size.height)
}
// 当controller对应的NodeContainer在Appear的时候进行回调
aboutToAppear() {
console.log("aboutToAppear")
}
// 当controller对应的NodeContainer在Disappear的时候进行回调
aboutToDisappear() {
console.log("aboutToDisappear")
}
// 此函数为自定义函数,可作为初始化函数使用
// 通过UIContext初始化BuilderNode,再通过BuilderNode中的build接口初始化@Builder中的内容
initWeb(url: string, uiContext: UIContext, control: WebviewController) {
if (this.rootnode != null) {
return;
}
// 创建节点,需要uiContext
this.rootnode = new BuilderNode(uiContext)
// 创建动态Web组件
this.rootnode.build(wrap, { url: url, controller: control })
}
}
// 创建Map保存所需要的NodeController
let NodeMap: Map<string, myNodeController | undefined> = new Map();
// 创建Map保存所需要的WebViewController
let controllerMap: Map<string, WebviewController | undefined> = new Map();
// 初始化需要UIContext 需在Ability获取
export const createNWeb = (url: string, uiContext: UIContext) => {
// 创建NodeController
let baseNode = new myNodeController();
let controller = new webview.WebviewController();
// 初始化自定义Web组件
baseNode.initWeb(url, uiContext, controller);
controllerMap.set(url, controller)
NodeMap.set(url, baseNode);
}
// 自定义获取NodeController接口
export const getNWeb = (url: string): myNodeController | undefined => {
return NodeMap.get(url);
}
WebIndex.ets代码
// 使用NodeController的Page页
// WebIndex.ets
import { getNWeb } from "./CommonWeb"
@Entry
@Component
struct WebIndex {
build() {
Row() {
Column() {
// NodeContainer用于与NodeController节点绑定,rebuild会触发makeNode
// Page页通过NodeContainer接口绑定NodeController,实现动态组件页面显示
NodeContainer(getNWeb("https://developer.huawei.com/consumer/cn/develop/"))
.height("90%")
.width("100%")
}
.width('100%')
}
.height('100%')
}
}