Flutter 三方库「flutter_custom_tabs」的鸿蒙化适配指南
开发工具: 华为云码道
本文配套仓库(预定地址): oh-flutter/flutter_custom_tabs
flutter_custom_tabs 提供统一的网页打开接口,OHOS 端调用系统链接能力打开浏览器,并可优先尝试匹配的 App Linking 应用。本文以 flutter_custom_tabs 2.6.0 为例,介绍源码准备、OHOS 工程配置、ArkTS 实现和 example 真机运行。
Android 使用 Custom Tabs,iOS 使用 SFSafariViewController,Web 使用浏览器标签页;OHOS 当前提供系统浏览器或 App Linking 跳转。配套仓库地址统一规划为 oh-flutter/flutter_custom_tabs;尚未创建或同步时,先使用本地源码。本文依据本地 2.6.0 适配工作区,当前 HEAD 为 79bbf78738b47f951a3016916a9f517d69a98e1b,OHOS 相关实现还包含未提交内容,该 HEAD 不能单独还原本文代码。
截图标注:操作步骤与截图命令真机运行图(从左到右):演示入口/标准 API 打开/轻量 API 打开。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。
执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。
mkdir -p blog-assets/flutter_custom_tabs
演示入口: 启动 Demo,等待“准备就绪”。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-entry.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-entry.jpeg ./blog-assets/flutter_custom_tabs/entry.jpeg
标准 API 打开: 点击“标准 API 打开”,等待系统浏览器显示本地 127.0.0.1:43824 页面。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-standard-browser.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-standard-browser.jpeg ./blog-assets/flutter_custom_tabs/standard-browser.jpeg
轻量 API 打开: 返回 Demo 后点击“轻量 API 打开”,再次截取浏览器中“页面打开成功”的中文演示页。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-lite-browser.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-lite-browser.jpeg ./blog-assets/flutter_custom_tabs/lite-browser.jpeg
一、插件简介与适配目标
flutter_custom_tabs 在不同平台提供网页打开能力。OHOS 端通过前台 UIAbilityContext.openLink 交给系统处理 HTTP/HTTPS 地址,保留标准与轻量 Dart API。
例如,帮助文档、活动页面和服务链接可以从 Flutter 页面跳转到浏览器;已建立 App Linking 关联的链接,也可以优先交给对应应用。
Future 在系统接受打开请求后完成,不代表网页已经加载完毕。OHOS 当前不创建 Android Custom Tabs 那样的可定制浏览器会话,工具栏、预热和程序化关闭有明确限制。
二、环境准备
环境搭建参考社区文档:Flutter OH 开发环境搭建,完成 Flutter OH SDK 安装、环境变量和 DevEco Studio 配置。
完成后,在宿主机终端执行以下命令,确认当前选中的是支持 OHOS 的 Flutter 工具链,并能发现目标设备:
flutter --version
flutter doctor -v
hdc list targets
工程使用的工具链和 SDK 配置如下:
| 项目 | 版本或配置 | 用途 |
|---|---|---|
| Flutter OHOS SDK | 3.44.9+ohos-0.0.1-canary1 | Flutter 编译与 OHOS 平台工具链 |
| Flutter 分支 | oh-3.44.9-dev | CPF-Flutter 对应开发分支 |
| Dart SDK | 3.12.2 | Dart 语言与包管理环境 |
| HarmonyOS 开发套件 | 7.0.0(API 26) | 开发套件版本及对应的 API 级别 |
compileSdkVersion | 26.0.0 | 编译时使用的 SDK API |
targetSdkVersion | 26.0.0 | 应用面向的行为版本 |
compatibleSdkVersion | 5.1.0(18) | 当前工程声明的最低兼容版本 |
| 插件版本 | 2.6.0 | pubspec.yaml 中的包版本 |
| 原生语言 | ArkTS | HarmonyOS 插件实现 |
| 插件产物 | HAR | 被应用 entry 模块依赖 |
2.1 开发套件版本与工程中的 SDK 版本配置
7.0.0(API 26) 和 26.0.0 涉及 HarmonyOS 开发套件版本(API 版本)及其底座 OpenHarmony 的版本号体系。在本文工程中,相关版本的含义与配置方式如下:
7.0.0(API 26)表示 HarmonyOS 开发套件版本为7.0.0,对应 API 26。26.0.0是本文 HarmonyOS 应用工程中compileSdkVersion和targetSdkVersion的属性值。5.1.0(18)是本文工程中compatibleSdkVersion的属性值,声明最低兼容 API 18。
对应的 product 配置为:
{
"name": "default",
"compatibleSdkVersion": "5.1.0(18)",
"compileSdkVersion": "26.0.0",
"targetSdkVersion": "26.0.0",
"runtimeOS": "HarmonyOS"
}
这组配置使用 API 26 SDK 编译,并以 API 26 为目标版本,最低兼容 API 18。系统需要存在可处理 HTTP/HTTPS 的浏览器或 App Linking 应用。OHOS 不支持工具栏定制、部分标签页和程序化关闭;兼容空操作返回成功不表示这些能力已实现。
三、从源码仓库开始准备适配工程
3.1 将上游源码同步到 AtomGit
适配已有第三方插件时,先从 Pub 包信息或项目 README 确认上游地址、包名、版本和许可证。同步仓库时保留源码、许可证和提交历史,方便后续跟踪上游更新。
在 AtomGit 网页的新建仓库流程中,找到从已有仓库导入的入口,填写上游 Git 地址,选择自己有写权限的组织或个人空间,设置目标仓库名称后执行导入。完成后检查目标分支、pubspec.yaml、LICENSE 和提交历史是否完整,并记录适配起点的提交号。如果上游本身托管在 AtomGit,也可以通过 Fork 获得自己的工作仓库。
上游源码为 https://github.com/droibit/flutter_custom_tabs,本文基于 2.6.0。配套仓库预定为 flutter_custom_tabs。仓库创建并同步适配代码后,再执行下面的拉取命令;尚未同步时使用本地副本。需要提交修改时,使用自己有写权限的仓库或 Fork。
3.2 将代码拉取到宿主机
在安装了 Flutter OH 和 DevEco Studio 的开发电脑上打开终端,进入准备存放项目的目录,执行:
git clone https://atomgit.com/oh-flutter/flutter_custom_tabs.git
cd flutter_custom_tabs
pwd
ls
git remote -v
git status --short --branch
git rev-parse HEAD
git clone 会创建 flutter_custom_tabs/ 仓库目录。目标 Dart 包位于 flutter_custom_tabs/;以下章节中,“插件根目录”指该包目录,其中应能看到 pubspec.yaml、lib/ 和 example/。Git 仓库名和 Dart 包名均为 flutter_custom_tabs。
需要使用与本文相同的代码版本时,先将适配工作区整理、提交并同步到配套仓库,再将下方占位符替换为实际适配提交号。在没有未提交修改的仓库中执行:
git switch --detach <适配提交号>
适配其他插件时,使用该插件对应版本的 tag 或 commit 作为分支起点。

图 1:在宿主机终端输入 AtomGit 仓库拉取命令。
3.3 在仓库根目录创建适配分支
接着在 flutter_custom_tabs/ 根目录创建分支。分支名统一使用 feat/ohos_库名称_版本号,库名称取 flutter_custom_tabs/pubspec.yaml 的 name,版本号取此次适配的基线版本。本例为:
git switch -c feat/ohos_flutter_custom_tabs_2.6.0
git branch --show-current
如果该分支已存在,使用 git switch feat/ohos_flutter_custom_tabs_2.6.0 切换即可。

图 2:在 flutter_custom_tabs 仓库根目录输入适配分支创建命令。
3.4 自动补全 OHOS 适配结构
分支在 Git 仓库根目录创建;随后执行 cd flutter_custom_tabs 进入插件包根目录,再执行结构补全。以下命令适用于尚无 ohos/ 目录的既有 Flutter 平台插件:
flutter create --template=plugin --platforms=ohos --project-name flutter_custom_tabs .
git status --short
git diff -- pubspec.yaml lib example
--template=plugin指定插件模板。--platforms=ohos指定需要补全的平台。--project-name flutter_custom_tabs使用 Dart 包名,避免当前目录重命名后生成错误的包名。- 最后的
.表示在当前插件目录补全工程,不是另建一层flutter_custom_tabs/。
该命令生成 OHOS 平台脚手架,业务逻辑需要在 ArkTS 中实现。生成后通过 diff 检查 pubspec.yaml、lib/ 和 example/ 的变化,保留已有 API、其他平台注册项及依赖配置。不同 Flutter OH 版本生成的模板可能略有差异。
如果生成后 example/ohos/ 仍不存在,进入已有示例应用补全平台:
cd example
flutter create --platforms=ohos .
cd ..
本地适配工作区已经包含 ohos/ 和 example/ohos/,直接运行示例时可以跳过结构补全。新建插件则使用 flutter create --org com.nutpi --template=plugin --platforms=ohos flutter_custom_tabs;已有插件使用上面的 . 在当前目录补全。
图 3 待补。执行目录:
flutter_custom_tabs/flutter_custom_tabs/(插件包根目录)。flutter create --template=plugin --platforms=ohos --project-name flutter_custom_tabs .只输入命令并截图,保留末尾的点。现有工程已经适配,不必为截图重新生成;按 Ctrl+C 清除未执行命令。
图 3:在插件根目录输入 OHOS 结构补全命令。
3.5 适配后的项目目录
适配后的关键目录如下:
flutter_custom_tabs/flutter_custom_tabs/
├── lib/
│ ├── flutter_custom_tabs.dart
│ └── src/
│ ├── launcher.dart
│ └── lite/
│ └── launcher_lite.dart
├── ohos/
│ ├── src/
│ │ └── main/
│ │ ├── ets/
│ │ │ └── components/
│ │ │ └── plugin/
│ │ │ └── FlutterCustomTabsPlugin.ets
│ │ └── module.json5
│ ├── index.ets
│ └── oh-package.json5
├── example/
│ ├── lib/
│ │ └── main.dart
│ └── ohos/
│ ├── entry/
│ │ └── src/
│ │ └── main/
│ │ └── module.json5
│ └── build-profile.json5
├── pubspec.yaml
└── test/
项目根目录如下,其中包含 ohos/、example/ 及实际保留的说明文件;交付文档清单见第六节:

图 4:适配后的 flutter_custom_tabs 插件包目录。
| 文件 | 主要职责 |
|---|---|
lib/flutter_custom_tabs.dart | 提供业务公开 API |
lib/src/launcher.dart | 实现平台协议或数据模型 |
lib/src/lite/launcher_lite.dart | 实现平台协议或数据模型 |
ohos/src/main/ets/components/plugin/FlutterCustomTabsPlugin.ets | 注册通道并实现 OHOS 原生能力 |
ohos/src/main/module.json5 | 声明 HAR 模块和权限 |
example/lib/main.dart | 演示接口调用与结果显示 |
四、Dart 接口与通道分析
OHOS 实现需要遵循 Dart 层已有的方法、参数和回调约定。先阅读 lib/flutter_custom_tabs.dart、lib/src/launcher.dart、lib/src/lite/launcher_lite.dart,再在 ohos/src/main/ets/components/plugin/FlutterCustomTabsPlugin.ets 中实现对应的原生调用。适配其他已有平台的插件时,也应保留其公开接口和其他平台实现。
本例的对应关系如下:
| Dart 入口或模型 | 通道协议 | OHOS 实现 | 应保持的行为 |
|---|---|---|---|
launchUrl(...) | launch | openLink | HTTP/HTTPS;可 prefersDeepLink |
轻量 launchUrl(...) | 同一 launch | 同一 OHOS 实现 | 跨平台外观选项在 OHOS 忽略 |
closeCustomTabs() | closeAllIfPossible | 空操作 | 不会关闭系统浏览器 |
| warmup / mayLaunch / invalidate | 同名通道方法 | 空结果 | 不会创建可用浏览器会话 |
原生端需要保持方法名、参数键和返回类型一致,不能只保留方法名称而改变业务语义。
4.1 跨端架构与调用时序
Flutter 侧通过 MethodChannel('plugins.flutter.droibit.github.io/custom_tabs') 调用 OHOS 实现。本插件使用一次性的异步调用,不提供持续事件流。
4.1.1 一次完整打开网页的时序
4.2 参数与会话模型
| 参数或返回 | OHOS 含义 |
|---|---|
Uri url | 只接受 http/https |
prefersDeepLink | 先 appLinkingOnly,再回退系统处理 |
| CustomTabsOptions / SafariViewControllerOptions | 保留跨平台 API,不改变 OHOS 浏览器外观 |
| 空 PlatformSession | 兼容返回;非真实浏览器会话 |
非法 Scheme 在 Dart _requireWebUrl 中抛 ArgumentError;原生也检查协议,调用方应区分参数错误与 LAUNCH_ERROR。
4.3 公开 API 与平台接口
标准 API 与轻量 API 最终都调用 CustomTabsPlatform。主包保留 Android、iOS、Web 的独立实现依赖,OHOS 使用平台接口默认 MethodChannel。标准入口如下:
Future<void> launchUrl(
Uri url, {
bool prefersDeepLink = false,
CustomTabsOptions? customTabsOptions,
SafariViewControllerOptions? safariVCOptions,
}) {
return CustomTabsPlatform.instance.launch(
_requireWebUrl(url),
prefersDeepLink: prefersDeepLink,
customTabsOptions: customTabsOptions,
safariVCOptions: safariVCOptions,
);
}
4.4 Dart 通道协议分析
4.4.1 通道名称必须两端完全一致
const methodChannel = MethodChannel('plugins.flutter.droibit.github.io/custom_tabs');
通道名称属于跨语言协议。Dart 和 ArkTS 任何一端拼写不一致,都会出现“方法未实现”或“调用找不到插件”等问题。
4.4.2 序列化系统浏览器请求
以下方法来自仓库 flutter_custom_tabs_platform_interface/lib/src/method_channel_custom_tabs.dart:
Future<void> launch(
String urlString, {
bool prefersDeepLink = false,
PlatformOptions? customTabsOptions,
PlatformOptions? safariVCOptions,
}) {
final args = <String, dynamic>{
'url': urlString,
'prefersDeepLink': prefersDeepLink,
'customTabsOptions': <String, dynamic>{},
'safariVCOptions': <String, dynamic>{},
};
return _channel.invokeMethod('launch', args);
}
默认通道只传 URL 与 prefersDeepLink,并发送空的平台外观选项;不能据此宣称 OHOS 已实现 Android 工具栏配置。
4.4.3 关闭与会话兼容接口
Future<void> closeCustomTabs() {
return CustomTabsPlatform.instance.closeAllIfPossible();
}
warmupCustomTabs 收到空结果时构造无 ID 的 CustomTabsSession;mayLaunch 返回空的预热会话。OHOS 的 closeAllIfPossible、warmup、mayLaunch、invalidate 都直接成功返回 null。
五、补全 OHOS 原生实现与工程配置
5.1 在 FlutterCustomTabsPlugin.ets 中实现原生能力
业务层沿用已有 API,原生侧在 FlutterCustomTabsPlugin 中接入 UIAbilityContext.openLink,通过 Flutter 通道回传结果。
下面列出类中的主要成员和方法,完整文件还包含 getUniqueClassName() 等插件接口;各段均为核心摘录,需要结合完整类使用。
原生插件位于:
ohos/src/main/ets/components/plugin/FlutterCustomTabsPlugin.ets
5.1.1 引入 Flutter 和 HarmonyOS 能力
import {
AbilityAware,
AbilityPluginBinding,
FlutterPlugin,
FlutterPluginBinding,
MethodCall,
MethodCallHandler,
MethodChannel,
MethodResult,
} from '@ohos/flutter_ohos';
import { BusinessError } from '@kit.BasicServicesKit';
FlutterPlugin 负责接入 Flutter Engine 生命周期,MethodChannel 接收 Dart 命令;系统能力由 UIAbilityContext.openLink 提供。错误和事件处理以对应方法实现为准。
5.1.2 连接 Flutter Engine 和宿主 Ability
private channel: MethodChannel | null = null;
private abilityBinding: AbilityPluginBinding | null = null;
onAttachedToEngine(binding: FlutterPluginBinding): void {
this.channel = new MethodChannel(binding.getBinaryMessenger(), CHANNEL_NAME);
this.channel.setMethodCallHandler(this);
}
onAttachedToAbility(binding: AbilityPluginBinding): void {
this.abilityBinding = binding;
}
onDetachedFromAbility(): void {
this.abilityBinding = null;
}
Engine 注册方法通道,AbilityAware 保存宿主引用用于 openLink。没有持续事件流,也没有“网页加载完成”回调。
5.1.3 打开 HTTP 或 HTTPS 地址
private launch(call: MethodCall, result: MethodResult): void {
const url = String(call.argument('url') ?? '');
const prefersDeepLink = call.argument('prefersDeepLink') === true;
if (!url.startsWith('http://') && !url.startsWith('https://')) {
result.error('LAUNCH_ERROR', 'The URL must use the http or https scheme.', null);
return;
}
const abilityBinding = this.abilityBinding;
if (abilityBinding === null) {
result.error('LAUNCH_ERROR', 'Launching a browser requires a foreground UIAbility.', null);
return;
}
const context = abilityBinding.getAbility().context;
const launchPromise = prefersDeepLink
? context.openLink(url, { appLinkingOnly: true })
.catch((_error: BusinessError) => context.openLink(url, { appLinkingOnly: false }))
: context.openLink(url, { appLinkingOnly: false });
launchPromise
.then(() => result.success(null))
.catch((error: BusinessError) => {
result.error('LAUNCH_ERROR', error.message, { code: error.code });
});
}
prefersDeepLink 为 true 时先尝试 appLinkingOnly: true,失败再尝试 false;无论是匹配应用还是浏览器,Future 只反映启动调用。
5.1.4 保留未实现能力的兼容返回
case 'closeAllIfPossible':
case 'warmup':
case 'mayLaunch':
case 'invalidate':
result.success(null);
break;
这是 onMethodCall 的 switch 分支摘录。兼容返回避免破坏跨平台调用,但不会关闭、预热、预取或管理真实浏览器会话。
5.1.5 处理 MethodChannel 命令
onMethodCall(call: MethodCall, result: MethodResult): void {
switch (call.method) {
case 'launch':
this.launch(call, result);
break;
case 'closeAllIfPossible':
case 'warmup':
case 'mayLaunch':
case 'invalidate':
result.success(null);
break;
default:
result.notImplemented();
break;
}
}
无前台 Ability、原生 URL 协议不合法或系统无法处理地址时返回 LAUNCH_ERROR。Dart 的 URL 校验可能更早抛出 ArgumentError。未知通道方法仍返回 notImplemented。
5.1.6 Engine 解绑时释放资源
onDetachedFromEngine(_binding: FlutterPluginBinding): void {
this.channel?.setMethodCallHandler(null);
this.channel = null;
}
Engine 解绑释放通道,Ability 解绑清空引用;不会关闭已经打开的系统浏览器。页面自建 HttpServer 等资源仍由页面负责。
5.2 声明插件和宿主权限
插件 HAR 不声明敏感权限。完整 Demo 的本机 HttpServer 使用宿主 INTERNET 声明,浏览器页面加载与应用内网络服务的权限需求需按宿主配置处理。
5.2.1 插件 HAR 的权限
插件 ohos/src/main/module.json5 的模块配置如下:
{
"module": {
"name": "flutter_custom_tabs",
"type": "har",
"deviceTypes": [
"default",
"tablet"
]
}
}
5.2.2 应用 entry 的权限
最终安装的是宿主应用。以下片段来自 example/ohos/entry/src/main/module.json5,合并时保留原有 Ability 等配置:
{
"module": {
"requestPermissions": [
{
"name": "ohos.permission.INTERNET"
}
]
}
}
权限声明与运行时授权需要分别处理;没有权限需求的功能不要套用其他插件的授权流程。
5.3 注册并导出插件
pubspec.yaml 通过以下配置声明 OHOS 插件类:
flutter:
plugin:
platforms:
ohos:
pluginClass: FlutterCustomTabsPlugin
插件的 ohos/index.ets 需要导出实现:
import FlutterCustomTabsPlugin from './src/main/ets/components/plugin/FlutterCustomTabsPlugin';
export default FlutterCustomTabsPlugin;
执行 flutter pub get 和构建后,Flutter 工具会为应用生成插件注册代码。通常不应手工编辑 GeneratedPluginRegistrant.ets,因为下次构建可能覆盖它。
注册异常的排查步骤见第九节 MissingPluginException。
5.4 检查 example 的 OHOS 应用结构
本例的 example/ohos/build-profile.json5 应在 products 中设置版本。下面是需核对的配置片段,请合并到现有工程;其中 signingConfig: "default" 需要与本机配置的签名名称一致,签名材料保留在本地。
{
"app": {
"products": [
{
"name": "default",
"signingConfig": "default",
"compatibleSdkVersion": "5.1.0(18)",
"runtimeOS": "HarmonyOS",
"compileSdkVersion": "26.0.0",
"targetSdkVersion": "26.0.0"
}
]
},
"modules": [
{
"name": "entry",
"srcPath": "./entry",
"targets": [
{
"name": "default",
"applyToProducts": [
"default"
]
}
]
}
]
}
配置后,在 DevEco Studio 中执行一次 Sync Project。如果 entry 模块正常识别,Project 视图中会出现 entry,并能打开 entry 模块的签名配置。
六、补全交付文件并提交适配分支
6.1 除代码外还要补全哪些文件
代码适配完成后,还需要整理安装说明、接口文档、版本记录和开源信息。接收仓库有专用模板时,按其格式填写:
| 文件 | 应写清楚的内容 |
|---|---|
README.OpenSource | 上游名称、源码地址、适配版本或提交、版权及许可证信息;按仓库模板列出第三方依赖 |
README.md | 原项目说明、OHOS 支持入口、配套 Demo 和文档链接;保留上游信息 |
README.OpenHarmony_CN.md | 简介、AtomGit 安装方式、版本对应关系、环境约束、权限、接口表、示例、已验证范围和遗留问题 |
README.OpenHarmony.md | 与中文说明对应的英文文档 |
CHANGELOG.OpenHarmony.md | OHOS 新增能力、适配版本、兼容限制与测试范围 |
LICENSE / NOTICE | 保留上游许可证;NOTICE 按许可证和原项目要求保留或补充 |
example/README.md | 依赖方式、运行目录、签名、操作步骤与效果图;覆盖标准与轻量打开、App Linking 回退、非法地址和返回应用 |
pubspec.yaml、ohos/oh-package.json5 | 核对包名、版本、插件注册、仓库地址、许可证和依赖 |
.gitignore | 忽略构建缓存及本机签名材料,不漏提交必要源码和配置 |
README.OpenSource 记录库本身的来源与版本。本例的包名为 flutter_custom_tabs,版本为 2.6.0,采用 Apache-2.0 许可证;Flutter 和 HarmonyOS SDK 版本写入环境说明。
主包和 example 当前通过 README.md/CHANGELOG.md 记录 OHOS 能力,专用 OpenHarmony 文档及 README.OpenSource 尚需补齐。README 的许可证简写与实际 LICENSE 不一致,本文以实际 Apache-2.0 LICENSE 为准。
6.2 提交前检查
提交前先完成第八节的插件、example 和真机测试,再从 Git 仓库根目录检查改动:
git branch --show-current
git diff --check
git status --short
git diff --stat
git diff
检查 diff 中的接口、平台注册和依赖变化,移除本机路径及签名信息,并使文档中的版本和分支与提交内容一致。
6.3 提交并推送到 AtomGit
文档和代码整理完成后,在 Git 仓库根目录暂存并提交。以下命令以第 6.1 节文档已经补全为前提,文件名按项目实际情况调整:
git add flutter_custom_tabs/lib flutter_custom_tabs/ohos flutter_custom_tabs/pubspec.yaml flutter_custom_tabs/example flutter_custom_tabs/test
git add flutter_custom_tabs/README.md flutter_custom_tabs/README.OpenSource flutter_custom_tabs/README.OpenHarmony_CN.md
git add flutter_custom_tabs/README.OpenHarmony.md flutter_custom_tabs/CHANGELOG.OpenHarmony.md
git diff --cached --check
git diff --cached --stat
git diff --cached
git commit -m "feat: add OHOS support for flutter_custom_tabs 2.6.0"
git remote -v
git branch --show-current
git push -u origin feat/ohos_flutter_custom_tabs_2.6.0
DevEco 可能向 example/ohos/build-profile.json5 写入本机签名配置,需要在提交前从暂存内容中移除。推送时,origin 应指向自己的 AtomGit 仓库,当前分支为 feat/ohos_flutter_custom_tabs_2.6.0。
推送后在 AtomGit 发起合并请求,说明上游来源和版本、OHOS 实现范围、依赖及权限、测试环境、操作结果、已知限制,并附 Demo 运行图。目标分支和评审流程以接收仓库要求为准。
七、使用插件包内 example 演示接入
插件包自带 example/,可以直接用来调试插件和体验系统浏览器跳转。
7.1 本地适配时使用路径依赖
当前 example/pubspec.yaml 的依赖是:
dependencies:
flutter:
sdk: flutter
flutter_custom_tabs:
path: ../
../ 相对于 example/pubspec.yaml 指向插件根目录,修改根目录插件后可直接联调。
7.2 通过 AtomGit 引入插件
业务应用通过 AtomGit 引入时,将 flutter_custom_tabs 的 path 配置替换为下面的 Git 依赖。仓库同步后,将 ref 替换为实际适配提交号:
dependencies:
flutter:
sdk: flutter
flutter_custom_tabs:
git:
url: https://atomgit.com/oh-flutter/flutter_custom_tabs.git
ref: <适配提交号>
path: flutter_custom_tabs
使用自己的适配版本时,先推送分支,再将 url 改为对应仓库,ref 改为 feat/ohos_flutter_custom_tabs_2.6.0。正式发布后可固定到 tag 或 commit。
从插件根目录执行:
cd example
flutter pub get
flutter pub deps
检查 example/pubspec.lock 中 flutter_custom_tabs 的来源为 git,并核对 url、ref 和 resolved-ref。同时检查没有 dependency_overrides 或 pubspec_overrides.yaml 将其覆盖回本地依赖,确认应用使用的是 Git 依赖。
7.3 调用接口实现系统浏览器跳转
下面的页面可用于插件包内的 example/lib/main.dart,是便于讲解的最小页面;仓库完整 Demo 的入口和布局可能不同,第八节截图与验收步骤以仓库完整 Demo 为准。
最小页面访问 flutter.dev,需要可用网络。仓库完整 Demo 使用手机本机 43824 端口提供网页,因此第八节截图无需依赖外网。
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:flutter_custom_tabs/flutter_custom_tabs.dart';
void main() {
runApp(const MaterialApp(home: DemoPage()));
}
class DemoPage extends StatefulWidget {
const DemoPage({super.key});
State<DemoPage> createState() => _DemoPageState();
}
class _DemoPageState extends State<DemoPage> {
String _status = '尚未操作';
bool _busy = false;
void _show(String value) {
if (mounted) setState(() => _status = value);
}
Future<void> _run(Future<String> Function() action) async {
if (_busy) return;
setState(() => _busy = true);
try {
_show(await action());
} catch (error) {
_show('调用失败:$error');
} finally {
if (mounted) setState(() => _busy = false);
}
}
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: const Text('打开网页')),
body: ListView(
padding: const EdgeInsets.all(16),
children: [
Text(_status),
const SizedBox(height: 16),
FilledButton(onPressed: _busy ? null : () => _run(() async {
await launchUrl(Uri.parse('https://flutter.dev'));
return '系统已接受打开请求';
}), child: const Text('标准 API 打开')),
FilledButton(onPressed: _busy ? null : () => _run(() async {
await launchUrl(Uri.parse('https://flutter.dev'), prefersDeepLink: true);
return '系统已接受打开请求';
}), child: const Text('优先 App Linking')),
],
),
);
}
}
7.4 页面退出时释放页面资源
异步回调先检查 mounted。最小示例只发起外部跳转;完整 Demo 在 dispose 中关闭本机 HttpServer。closeCustomTabs 在 OHOS 是空操作,不能将它当成关闭浏览器或销毁网页的保证。
八、验证、构建与鸿蒙设备运行效果
8.1 分别验证插件与 example
从插件仓库根目录执行:
flutter pub get
flutter analyze
flutter test
cd example
flutter pub get
flutter analyze
flutter test
主包测试检查标准/轻量入口、参数转换和会话调用;example 包含中文页面 Widget 测试及打开浏览器的集成入口。网页加载和 App Linking 目标匹配仍需独立检查,单次 launch 返回不能证明预热等空操作生效。Widget 测试应匹配实际保留的 Demo 页面;如果替换成第七节最小页面,也要相应调整原来的 UI 断言。
Dart 测试覆盖接口和页面逻辑,标准与轻量打开、App Linking 回退、非法地址和返回应用还需要在鸿蒙设备上验证。以上为 Dart 测试复现命令,本次未重新执行这些测试;本次已重新构建、安装并运行签名 Release HAP,具体真机采集范围见 8.5。
8.2 确认设备连接
hdc list targets
flutter devices
设备首次连接电脑时,需要在手机端确认调试授权。列表为空时,检查 USB 连接、调试模式和电脑授权。
8.3 配置签名
真机安装的 HAP 通常需要有效签名。推荐使用 DevEco Studio 为 entry 模块配置自动签名:
- 用 DevEco Studio 打开
example/ohos,不是仓库根目录; - 等待工程 Sync 成功,确认 Project 视图中存在
entry模块; - 打开 File > Project Structure > Signing Configs;
- 为
defaultproduct 选择或生成签名; - 确认设备、应用包名、证书和 Profile 匹配;
- 再回到终端执行 Flutter 构建或运行。
签名材料保存在本机,公开仓库中只保留构建所需的通用配置。
8.4 运行示例
以下命令在 example/ 目录执行,将 <device-id> 替换为设备列表中的实际 ID:
flutter run -d <device-id>
也可以先构建 HAP:
flutter build hap --debug
典型产物位于:
example/ohos/entry/build/default/outputs/default/
目录中通常包含已签名和未签名 HAP。真机安装应选择与当前设备匹配的已签名产物。
本次真机截图使用签名 Release HAP。在插件包的 example/ 目录完成签名配置后执行:
flutter build hap --release
hdc -t <device-id> install -r build/ohos/hap/entry-default-signed.hap
hdc -t <device-id> shell aa start -a EntryAbility -b com.github.droibit.flutter_custom_tabs_example
8.5 在设备上测试系统浏览器跳转
- 运行完整 Demo,等待“本地演示页正在启动”变为“准备就绪”。
- 点击“标准 API 打开”,确认浏览器显示手机本机 127.0.0.1:43824 的“页面打开成功”。
- 使用系统返回手势回到 Demo;若先返回浏览器首页,则从最近任务切回 Demo,再点击“轻量 API 打开”验证相同页面。
- 点击“优先使用 App Linking”,本机 HTTP 示例通常回退到浏览器;真实 App Linking 需使用已关联域名。
- 测试非法 Scheme 与没有可处理应用的路径,核对参数异常或 LAUNCH_ERROR。
- 返回应用并重复调用;不要把 closeCustomTabs 的成功空返回当成浏览器关闭验证。
页面初始提示来自 Demo 默认值,调用结果或事件到达后才反映系统状态。上述列表为完整验收步骤,本次实际采集范围如下。
8.6 鸿蒙设备运行效果
OHOS 实现提供系统浏览器跳转。以下为仓库完整 Demo 的三张真机运行截图,按实际状态记录。
截图标注:操作步骤与截图命令真机运行图(从左到右):演示入口/标准 API 打开/轻量 API 打开。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。
执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。
mkdir -p blog-assets/flutter_custom_tabs
演示入口: 启动 Demo,等待“准备就绪”。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-entry.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-entry.jpeg ./blog-assets/flutter_custom_tabs/entry.jpeg
标准 API 打开: 点击“标准 API 打开”,等待系统浏览器显示本地 127.0.0.1:43824 页面。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-standard-browser.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-standard-browser.jpeg ./blog-assets/flutter_custom_tabs/standard-browser.jpeg
轻量 API 打开: 返回 Demo 后点击“轻量 API 打开”,再次截取浏览器中“页面打开成功”的中文演示页。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/flutter_custom_tabs-lite-browser.jpeg
hdc -t <device-id> file recv /data/local/tmp/flutter_custom_tabs-lite-browser.jpeg ./blog-assets/flutter_custom_tabs/lite-browser.jpeg
| 演示入口 | 标准打开 | 轻量打开 |
|---|---|---|
| 三个入口 | 本机网页 | 轻量 API 的实际结果 |
系统需要存在可处理 HTTP/HTTPS 的浏览器或 App Linking 应用。OHOS 不支持工具栏定制、部分标签页和程序化关闭;兼容空操作返回成功不表示这些能力已实现。
九、FAQ:适配过程与使用问题
9.1 Missing SDK components
典型错误如下:
Missing SDK components. SDK path: ...,
missing components: toolchains,ets,js,native,previewer.
这个错误发生在 Hvigor 同步阶段。通常需要检查构建工具使用的 SDK 路径、组件是否完整,以及 Hvigor 与 SDK 的版本是否匹配。
处理顺序:
- 在 DevEco Studio SDK Manager 中确认 API 26 组件已经下载完整;
- 检查 Flutter 和 DevEco Studio 使用的 SDK 路径是否一致;
- 避免误用
/Applications/DevEco-Studio.app/Contents/sdk之类的不完整目录; - 确认 SDK 根目录下存在
toolchains、ets、js、native、previewer; - 执行
flutter config --ohos-sdk <正确路径>; - 重新执行
flutter doctor -v和 DevEco Studio Sync。
因为 Sync 和 Compile 首先读取 Mac 本地 SDK。手机 API 版本只在部署、安装和运行时参与兼容判断。即使完全不连接手机,本地 SDK 不完整时也会得到相同错误。
当前工程的 compatibleSdkVersion 是 API 18,因此 API 24 在安装版本门槛上是满足的;但功能是否可用还取决于目标系统能力、权限和运行环境,不能仅凭最低版本判断。
9.2 DevEco Studio 中看不到 entry 模块
插件的 ohos/ 目录是 HAR 模块,可安装应用的 entry 模块位于 example/ohos/entry。
请直接使用 DevEco Studio 打开:
flutter_custom_tabs/flutter_custom_tabs/example/ohos
如果仍看不到 entry,先解决 SDK Sync 错误,再检查 example/ohos/build-profile.json5 的 modules 是否包含 ./entry。同步失败时,Project Structure 无法正确解析模块,签名界面也可能不显示 entry。
9.3 无法手动签名
签名配置依附于可构建的应用模块和 product。只有 HAR 插件模块、工程 Sync 失败,或者打开了错误目录时,DevEco Studio 都可能无法提供 entry 签名入口。
建议先确认:
- 打开的是
example/ohos; - SDK 组件完整并且 Sync 成功;
entry的模块类型为entry;defaultproduct 和 target 已正确关联;- 当前账号、证书和调试设备状态有效。
9.4 调用成功但没有预期的浏览器样式
OHOS 通过系统 openLink 打开页面,不处理 CustomTabsOptions 和 SafariViewControllerOptions 的外观设置。先确认页面是否实际打开,再区分浏览器样式需求与跳转功能。
9.5 MissingPluginException
这通常表示 Dart 通道找不到已注册的原生插件。新增原生插件后需要重新构建应用。从仓库根目录执行:
cd example
flutter clean
flutter pub get
flutter run -d <device-id>
如果仍然出现,检查自动生成的插件注册文件中是否包含 FlutterCustomTabsPlugin,同时核对 pubspec.yaml、ohos/index.ets 和 oh-package.json5。
9.6 多次点击打开了多个页面
本插件没有合并打开请求的会话管理。页面应在一次 launch Future 等待期间禁用重复操作;但启动完成后系统如何复用浏览器标签页由浏览器决定。
9.7 编译成功但安装失败
常见原因包括:
- HAP 未签名或使用了错误的 Profile;
- 设备未加入调试设备列表;
- 包名与签名 Profile 不匹配;
- 安装包的
compatibleSdkVersion高于设备 API; - 手机上已经安装了使用不同证书签名的同包名应用。
根据安装错误码区分签名、版本和包名冲突,再处理对应配置。
9.8 flutter create 不认识 ohos,或包名不合法
先执行 flutter --version,确认使用的是 OHOS 版工具链,环境配置回到第二节的社区链接核对。包名报错时,确认当前目录包含目标插件的 pubspec.yaml,并显式传入 --project-name flutter_custom_tabs;本例 Dart 包名为 flutter_custom_tabs,多包仓库需先进入对应插件包目录。生成后检查 diff,再补充 ArkTS 业务实现。
9.9 AtomGit 依赖提示找不到分支或无权限
先检查 URL 是否指向已同步的目标仓库,再确认 feat/ohos_flutter_custom_tabs_2.6.0 已推送。仓库未创建、适配分支未推送或提交未同步时,应先完成同步;不能直接使用仅存在本地的提交号。私有仓库还需在本机配置 Git 认证。
9.10 改了本地 ArkTS,Demo 为什么没变化
先检查 example/pubspec.yaml:Git 依赖读取远程提交,不会自动读取本地插件改动。本地联调切回 path: ../;测试远程版本则先提交推送,再更新依赖并核对 pubspec.lock 的 resolved-ref。原生代码变动后停止应用并重新构建运行,不能只做 Dart 热重载。
9.11 closeCustomTabs 或 warmup 成功,却没有效果
OHOS 对 closeAllIfPossible、warmup、mayLaunch、invalidate 返回 null,属于兼容空操作。当前不能程序化关闭系统浏览器,也没有真实的预热或预取会话。
相关链接
更多推荐

所有评论(0)