Web仓颉封装（beta特性）

简介

Web仓颉封装提供了Web组件控制，Cookie管理和历史信息列表的能力。开发者可通过提供的能力控制Web组件的行为，查询网页访问历史记录，设置Cookie信息。当前开放的Web仓颉接口仅支持standard设备。

系统架构

图 1 Web仓颉架构图

如架构图所示：

接口层：

• Web组件控制器：面向开发者提供的Web组件控制器的API能力。提供控制Web组件各种行为，如加载页面，页面导航，页面刷新。
• Cookie管理：面向开发者提供的用于Cookie管理的API能力。提供控制Web组件中Cookie的各种行为的能力。如获取Cookie，设置Cookie，删除Cookie。Cookie以字符串的形式提供，如"name=value"。其中name为Cookie的名称，value为Cookie的值。
• 历史信息列表：面向开发者提供的历史信息列表的API能力。历史信息列表为网页的历史记录项的列表，开发者可获取指定索引处的历史记录项。历史记录项包含历史页面图标、url地址、原始url地址和标题信息。

框架层：

• Web组件控制器封装：基于底层webview基础能力封装，提供WebviewController类实现对Web组件的控制能力。
• Cookie管理封装：基于底层webview基础能力封装，提供WebCookieManager类实现对Cookie的管理能力。
• 历史信息列表封装：基于底层webview基础能力封装，提供BackForwardList类实现历史信息列表的查询能力。

架构图中的依赖部件引入说明：

• web_webview：Web仓颉封装依赖其提供的webview基础功能。
• multimedia_cangjie_wrapper：提供使用媒体资源的能力。历史信息列表依赖其中的PixelMap以获取历史信息中的图标信息。
• arkui_cangjie_wrapper：提供仓颉UI组件接口及基础类型。Web组件控制器依赖其中对基础类型的定义和解析能力。
• cangjie_ark_interop：负责提供仓颉注解类定义和BusinessException异常类定义。Web仓颉封装依赖此部件用于对API进行标注，及在错误分支向用户抛出异常。
• hiviewdfx_cangjie_wrapper：负责提供日志接口。Web仓颉封装依赖此部件用于在关键路径处打印日志。

目录

base/web/arkweb_cangjie_wrapper
├── figures                                 # 存放README中的架构图
├── kit                                     # 仓颉ArkWeb的kit化代码
│   └── ArkWeb
├── ohos                                    # 仓颉方舟Web接口实现
│   └── web
│       └── webview
│           ├── back_forward_list.cj        # 历史信息列表
│           ├── web_cookie_manager.cj       # Cookie管理
│           └── webview_controller.cj       # Web组件控制器
└── test                                    # 仓颉方舟Web测试用例
    └── webview                             # 仓颉方舟Web测试用例

使用说明

Web仓颉接口提供了以下功能接口，开发者可以根据诉求使用：

• BackForwardList：历史信息列表。相关示例请参见获取历史记录。
• WebCookieManager：Cookie管理。相关示例请参见Cookie管理。
• WebviewController：Web组件控制器。相关示例请参见使用Web组件加载页面。

方舟Web相关API请参见Web仓颉API文档，相关指导请参见方舟Web开发指南。

约束

与ArkTS提供的API能力相比，暂不支持以下功能：

• AdsBlockManager：广告过滤配置。
• BackForwardCacheOptions：前进后退缓存配置。
• BackForwardCacheSupportedFeatures：前进后退缓存特性配置。
• GeolocationPermissions：地理位置权限配置。
• JsMessageExt：执行JavaScript脚本的结果。
• MediaSourceInfo：媒体源信息配置。
• NativeMediaPlayerSurfaceInfo：应用接管媒体播放时渲染信息。
• PdfData：生成的PDF输出数据。
• ProxyConfig：网络代理配置。
• ProxyController：网络代理控制器。
• WebDataBase：数据库管理。
• WebDownloadDelegate：下载任务状态事件。
• WebDownloadItem：下载任务。
• WebDownloadManager：下载任务管理。
• WebHttpBodyStream：HTTP请求体。
• WebMessageExt：前端与应用通信数据对象。
• WebResourceHandler：资源加载控制。
• WebSchemeHandler：指定Scheme的请求拦截器。
• WebSchemeHandlerRequest：通过拦截器拦截到的请求。
• WebSchemeHandlerResponse：为拦截到的请求创建自定义响应。
• WebStorageOrigin：Web组件存储操作接口。
• NativeMediaPlayerBridge：托管网页媒体播放器桥接接口。
• NativeMediaPlayerHandler：托管网页媒体播放器的事件接口。
• WebMessagePort：网页前端与应用的消息端口。

参与贡献

欢迎广大开发者贡献代码、文档等，具体的贡献流程和方式请参见参与贡献。

相关仓

web_webview

arkcompiler_cangjie_ark_interop

arkui_arkui_cangjie_wrapper

multimedia_multimedia_cangjie_wrapper

hiviewdfx_hiviewdfx_cangjie_wrapper