1. 插件介绍
webview_flutter 是一个功能强大的 flutter 插件,提供了 webview 小部件,允许开发者在 flutter 应用中嵌入网页内容。该插件支持多种平台,包括 ios、android、web 和鸿蒙(api 12+)。
核心功能
- 在 flutter 应用中无缝嵌入网页内容
- 支持网络资源、本地文件和 flutter 资源加载
- 提供完整的网页导航控制(前进、后退、刷新)
- 支持 javascript 执行和双向通信
- 提供网页加载进度监听和导航决策控制
- 支持自定义用户代理、背景颜色和缩放控制
鸿蒙平台支持
在鸿蒙平台上,webview_flutter 插件基于鸿蒙的 webview api(api 12+)实现,提供与其他平台一致的功能体验。支持鸿蒙 api 12 及以上版本。
2. 依赖引入
由于这是一个针对鸿蒙平台的自定义修改版本,需要通过 git 形式引入依赖。
配置步骤
- 在项目的
pubspec.yaml文件中,添加以下依赖配置:
dependencies:
webview_flutter:
git:
url: "https://gitcode.com/openharmony-tpc/flutter_packages.git"
path: "packages/webview_flutter"
- 执行以下命令获取依赖:
flutter pub get
3. 鸿蒙平台特殊配置
3.1 权限配置
- 添加网络权限:在
entry/src/main/module.json5文件中添加网络权限声明:
"requestpermissions": [
{
"name": "ohos.permission.internet",
"reason": "$string:network_reason",
"usedscene": {
"abilities": ["entryability"],
"when": "inuse"
}
}
]
- 添加权限描述:在
entry/src/main/resources/base/element/string.json文件中添加权限描述:
{
"string": [
{
"name": "network_reason",
"value": "使用网络访问网页内容"
}
]
}
3.2 应用级别配置
由于 webview 可能需要系统级权限,需要将应用级别设置为 system_basic,否则在安装 hap 包时可能会报错。具体配置方法请参考华为官方文档。
4. api 调用与使用示例
4.1 创建 webviewcontroller
webviewcontroller 是控制 webview 行为的核心类,用于加载内容、控制导航和执行 javascript 等操作。
import 'package:flutter/material.dart';
import 'package:webview_flutter/webview_flutter.dart';
class webviewexample extends statefulwidget {
const webviewexample({key? key}) : super(key: key);
@override
state<webviewexample> createstate() => _webviewexamplestate();
}
class _webviewexamplestate extends state<webviewexample> {
late final webviewcontroller _controller;
@override
void initstate() {
super.initstate();
// 创建 webviewcontroller
_controller = webviewcontroller()
..setjavascriptmode(javascriptmode.unrestricted) // 启用 javascript
..setbackgroundcolor(const color(0x00000000)) // 设置透明背景
..setnavigationdelegate( // 设置导航委托
navigationdelegate(
onprogress: (int progress) {
// 更新加载进度
debugprint('webview is loading (progress : $progress%)');
},
onpagestarted: (string url) {
debugprint('page started loading: $url');
},
onpagefinished: (string url) {
debugprint('page finished loading: $url');
},
onwebresourceerror: (webresourceerror error) {
debugprint('\n\n====\nerror: $error\n====\n\n');
},
onnavigationrequest: (navigationrequest request) {
// 控制导航决策
if (request.url.startswith('https://www.youtube.com/')) {
debugprint('blocking navigation to ${request.url}');
return navigationdecision.prevent;
}
debugprint('allowing navigation to ${request.url}');
return navigationdecision.navigate;
},
),
)
..loadrequest(uri.parse('https://flutter.dev')); // 加载初始 url
}
// ...
}
4.2 创建 webviewwidget
webviewwidget 用于在 flutter 界面中显示 webview 内容,需要传入之前创建的 webviewcontroller。
@override
widget build(buildcontext context) {
return scaffold(
appbar: appbar(
title: const text('flutter webview 示例'),
// 添加导航控制按钮
actions: [
navigationcontrols(_controller),
],
),
body: webviewwidget(controller: _controller), // 显示 webview
);
}
4.3 实现导航控制
class navigationcontrols extends statelesswidget {
const navigationcontrols(this._webviewcontroller, {key? key}) : super(key: key);
final webviewcontroller _webviewcontroller;
@override
widget build(buildcontext context) {
return row(
children: <widget>[
iconbutton(
icon: const icon(icons.arrow_back_ios),
onpressed: () async {
if (await _webviewcontroller.cangoback()) {
await _webviewcontroller.goback();
} else {
if (context.mounted) {
scaffoldmessenger.of(context).showsnackbar(
const snackbar(content: text('no back history item')),
);
}
}
},
),
iconbutton(
icon: const icon(icons.arrow_forward_ios),
onpressed: () async {
if (await _webviewcontroller.cangoforward()) {
await _webviewcontroller.goforward();
} else {
if (context.mounted) {
scaffoldmessenger.of(context).showsnackbar(
const snackbar(content: text('no forward history item')),
);
}
}
},
),
iconbutton(
icon: const icon(icons.replay),
onpressed: () => _webviewcontroller.reload(),
),
],
);
}
}
4.4 执行 javascript
// 执行 javascript 代码
_controller.runjavascript('alert("hello from flutter!");');
// 执行 javascript 代码并获取返回结果
final result = await _controller.runjavascriptreturningresult(
'document.body.innertext.length'
);
debugprint('body text length: $result');
4.5 监听 javascript 消息
// 添加 javascript 通道
_controller.addjavascriptchannel(
'toaster',
onmessagereceived: (javascriptmessage message) {
scaffoldmessenger.of(context).showsnackbar(
snackbar(content: text(message.message)),
);
},
);
// 在网页中发送消息到 flutter
// window.toaster.postmessage('hello from javascript!');
4.6 加载不同类型的内容
// 加载网络资源
_controller.loadrequest(uri.parse('https://flutter.dev'));
// 加载本地文件
_controller.loadfile('/path/to/local/file.html');
// 加载 flutter 资源
_controller.loadflutterasset('assets/html/index.html');
// 加载 html 字符串
_controller.loadhtmlstring('''
<html>
<body>
<h1>hello, world!</h1>
<p>this is html content loaded from a string.</p>
</body>
</html>
''', baseurl: uri.parse('https://example.com'));
5. 注意事项
5.1 权限配置
确保正确配置网络权限,否则 webview 将无法加载网络资源。同时,注意应用级别的设置,避免安装时出现权限错误。
5.2 鸿蒙平台兼容性
- 支持鸿蒙 api 12 及以上版本
- 要求 flutter 版本:3.7.12-ohos-1.1.1 及以上
- 要求鸿蒙 sdk 版本:5.0.0(12) 及以上
5.3 性能优化
- 避免在 webview 中加载过于复杂的网页内容
- 合理使用 javascript 通道,避免频繁的双向通信
- 在不需要时及时释放 webview 资源
5.4 安全性考虑
- 谨慎处理来自网页的 javascript 消息
- 对加载的网页内容进行适当的安全验证
- 考虑使用内容安全策略 (csp) 保护应用
6. 总结
webview_flutter 是一个功能强大的 flutter 插件,为开发者提供了在 flutter 应用中嵌入网页内容的能力。在鸿蒙平台上,该插件提供了与其他平台一致的功能体验,支持网络资源加载、javascript 执行、导航控制等核心功能。
使用该插件的关键步骤包括:
- 通过 git 形式引入自定义修改版本的依赖
- 配置网络权限和应用级别
- 创建 webviewcontroller 并配置导航委托
- 使用 webviewwidget 在界面中显示 webview
- 实现导航控制和 javascript 交互
webview_flutter 插件为鸿蒙平台上的 flutter 应用提供了强大的网页嵌入能力,使开发者能够轻松构建混合内容应用,结合原生应用的性能优势和网页内容的灵活性。
无论是构建需要嵌入外部网页的应用,还是需要实现复杂网页交互的功能,webview_flutter 都是鸿蒙平台上 flutter 开发者的理想选择。
到此这篇关于在鸿蒙上使用webview_flutter包的文章就介绍到这了,更多相关鸿蒙使用webview_flutter包内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论