HarmonyOS第一课06：使用ArkWeb构建页面

文章索引

ArkWeb简介

1.概念介绍

Web组件用于在应用程序中显示Web页面内容，为开发者提供页面加载、页面交互、页面调试等能力。可以用于实现移动端的混合式开发(Hybrid App):

页面加载：Web组件提供基础的前端页面加载的能力，包括加载网络页面、本地页面、HTML格式文本数据。
页面交互：Web组件提供丰富的页面交互的方式，包括：设置前端页面深色模式，新窗口中加载页面，位置权限管理，Cookie管理，应用侧使用前端页面JavaScript等能力。
页面调试：Web组件支持使用Devtools工具调试前端页面。

2.ArkWeb API参考

ArkWeb涉及到的API主要有以下两个：
1、Web组件：提供具有网页显示能力的一种组件。

Web(options: { src: ResourceStr, controller: WebviewController | WebController, renderMode? : RenderMode, incognitoMode? : boolean})

1	Web(options: { src: ResourceStr, controller: WebviewController \| WebController, renderMode? : RenderMode, incognitoMode? : boolean})

2、Webview：提供web控制能力的相关接口。例如控制Web组件加载的内容，控制Web内容后退前进，以及异步执行JavaScript脚本等能力。

页面加载与显示

1.加载网络页面

开发者可以在Web组件创建时，指定默认加载的网络页面。在默认页面加载完成后，如果开发者需要变更此Web组件显示的网络页面，可以通过调用loadUrl()接口加载指定的网页。

页面加载过程中，若涉及网络资源获取，需要配置ohos.permission.INTERNET网络访问权限。

# module.json5中配置
"requestPermissions": [
  {
    "name": "ohos.permission.INTERNET"
  }
]

# module.json5中配置

"requestPermissions": [

{

"name": "ohos.permission.INTERNET"

}

]

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  webviewController: webview.WebviewController = new webview.WebviewController()

  build() {
    Column(){
      Button('loadUrl')
        .onClick(() => {
          try{
            this.webviewController.loadUrl('www.itcan.cn')
          } catch(error){
            let e: BusinessError = error as BusinessError
            console.error(`ErrorCode: ${e.code}, message: ${e.message}`)
          }
        })

      // 组件创建时，加载www.baidu.com
      Web({
        src: "www.baidu.com",
        controller: this.webviewController
      })
    }
    .width('100%')
    .height('100%')
  }
}

import { webview } from '@kit.ArkWeb';

import { BusinessError } from '@kit.BasicServicesKit';

@Entry

@Component

struct Index {

webviewController: webview.WebviewController = new webview.WebviewController()

build() {

Column(){

Button('loadUrl')

.onClick(() => {

try{

this.webviewController.loadUrl('www.itcan.cn')

} catch(error){

let e: BusinessError = error as BusinessError

console.error(`ErrorCode: ${e.code}, message: ${e.message}`)

}

})

// 组件创建时，加载www.baidu.com

Web({

src: "www.baidu.com",

controller: this.webviewController

})

}

.width('100%')

.height('100%')

}

2.加载本地页面

将本地页面文件放在应用的rawfile目录下，开发者可以在Web组件创建的时候指定默认加载的本地页面，并且加载完成后可通过调用loadUrl()接口变更当前Web组件的页面。

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  webviewController: webview.WebviewController = new webview.WebviewController()

  build() {
    Column(){
      Button('loadUrl')
        .onClick(() => {
          try{
            this.webviewController.loadUrl($rawfile('second.html'))
          } catch(error){
            let e: BusinessError = error as BusinessError
            console.error(`ErrorCode: ${e.code}, message: ${e.message}`)
          }
        })

      // 组件创建时，通过$rawfile加载本地文件index.html
      Web({
        src: $rawfile('index.html'),
        controller: this.webviewController
      })
    }
    .width('100%')
    .height('100%')
  }
}

import { webview } from '@kit.ArkWeb';

import { BusinessError } from '@kit.BasicServicesKit';

@Entry

@Component

struct Index {

webviewController: webview.WebviewController = new webview.WebviewController()

build() {

Column(){

Button('loadUrl')

.onClick(() => {

try{

this.webviewController.loadUrl($rawfile('second.html'))

} catch(error){

let e: BusinessError = error as BusinessError

console.error(`ErrorCode: ${e.code}, message: ${e.message}`)

}

})

// 组件创建时，通过$rawfile加载本地文件index.html

Web({

src: $rawfile('index.html'),

controller: this.webviewController

})

}

.width('100%')

.height('100%')

}

3.加载HTML格式数据

Web组件可以通过loadData()接口实现加载HTML格式的文本数据。当开发者不需要加载整个页面，只需要显示一些页面片段时，可通过此功能来快速加载页面。

import { webview } from '@kit.ArkWeb';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  webviewController: webview.WebviewController = new webview.WebviewController()

  build() {
    Column(){
      Button('loadUrl')
        .onClick(() => {
          try{
            this.webviewController.loadData(
              "<html><body>加载HTML格式的文本数据</body></html>",
              "text/html",
              "UTF-8"
            )
          } catch(error){
            let e: BusinessError = error as BusinessError
            console.error(`ErrorCode: ${e.code}, message: ${e.message}`)
          }
        })

      // 组件创建时，通过$rawfile加载本地文件index.html
      Web({
        src: $rawfile('index.html'),
        controller: this.webviewController
      })
    }
    .width('100%')
    .height('100%')
  }
}

import { webview } from '@kit.ArkWeb';

import { BusinessError } from '@kit.BasicServicesKit';

@Entry

@Component

struct Index {

webviewController: webview.WebviewController = new webview.WebviewController()

build() {

Column(){

Button('loadUrl')

.onClick(() => {

try{

this.webviewController.loadData(

"<html><body>加载HTML格式的文本数据</body></html>",

"text/html",

"UTF-8"

)

} catch(error){

let e: BusinessError = error as BusinessError

console.error(`ErrorCode: ${e.code}, message: ${e.message}`)

}

})

// 组件创建时，通过$rawfile加载本地文件index.html

Web({

src: $rawfile('index.html'),

controller: this.webviewController

})

}

.width('100%')

.height('100%')

}

4.动态创建Web组件

支持命令式创建Web组件，这种方式创建的组件不会立即挂载到组件树，即不会对用户呈现（组件状态为Hidden和InActive），开发者可以在后续使用中按需动态挂载。后台启动的Web实例不建议超过200个。

// 载体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;
    }
  });
}

// 载体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;

}

});

}

// 创建NodeController
// pages/common.ets
import { webview } from '@kit.ArkWeb';
import { NodeController, BuilderNode, Size, FrameNode, UIContext } from '@kit.ArkUI';

// @Builder中为动态组件的具体组件内容
// Data为入参封装类
class Data{
  url: string = "https://www.example.com";
  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);
}

// 创建NodeController

// pages/common.ets

import { webview } from '@kit.ArkWeb';

import { NodeController, BuilderNode, Size, FrameNode, UIContext } from '@kit.ArkUI';

// @Builder中为动态组件的具体组件内容

// Data为入参封装类

class Data{

url: string = "https://www.example.com";

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);

}

// 使用NodeController的Page页
// Pages/Index.ets
import { getNWeb } from "./common"
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        // NodeContainer用于与NodeController节点绑定，rebuild会触发makeNode
        // Page页通过NodeContainer接口绑定NodeController，实现动态组件页面显示
        NodeContainer(getNWeb("https://www.example.com"))
          .height("90%")
          .width("100%")
      }
      .width('100%')
    }
    .height('100%')
  }
}

// 使用NodeController的Page页

// Pages/Index.ets

import { getNWeb } from "./common"

@Entry

@Component

struct Index {

build() {

Row() {

Column() {

// NodeContainer用于与NodeController节点绑定，rebuild会触发makeNode

// Page页通过NodeContainer接口绑定NodeController，实现动态组件页面显示

NodeContainer(getNWeb("https://www.example.com"))

.height("90%")

.width("100%")

}

.width('100%')

}

.height('100%')

}