Flutter 3.47 鸿蒙三方库适配实战:从 0 到 1 处理 flutter_appauth

OAuth 2.0 授权是登录体系的行业标准:应用拉起系统浏览器完成授权,再拿回调里的 code 换令牌。flutter_appauth 是对 AppAuth 原生 SDK 的封装,实现了完整的授权码流程。把它带到鸿蒙时,浏览器跳转与回调拦截是适配的核心。

本文以 flutter_appauth 12.1.0 为例,记录我如何保留原有 Dart API、补齐 Flutter OH 插件入口、在鸿蒙端接入真实系统能力,并在 HarmonyOS API 26 真机上完成构建、安装、启动和按钮调用验证。

适配仓库: oh-flutter/flutter_appauth

适配分支: feat/ohos_flutter_appauth_12.1.0

适配 TAG: 12.1.0-ohos.2

一、先看最终效果

图 1:HarmonyOS API 26 真机启动 Demo。页面显示 flutter_appauth 12.1.0。

图 2:点击“发起 OAuth 授权”后系统浏览器打开授权页,展示应用名、请求的 scope 与回调地址。

图 3:授权完成后自定义 scheme 深链回到应用,Dart 侧拿到 code 并完成 token 交换。

验证点实测结果证据
Flutter OH 3.47 工程构建通过entry-default-signed.hap
安装、启动通过图 1
authorize系统浏览器打开授权页图 2
深链回调Dart 收到已真实授权的 code图 3
完整链路discovery + PKCE + 浏览器 + 深链图 2/3

二、这个库原来是怎么工作的

flutter_appauth 的通道集中在平台接口包:

Dart FlutterAppAuth
  -> MethodChannel('crossingthestreams.io/flutter_appauth')
  -> Android AppAuth-Android / iOS AppAuth-iOS
  -> authorize / authorizeAndExchangeCode / token / endSession

四个方法覆盖授权码流程的完整生命周期:发起授权、授权并换码、刷新令牌、注销会话。模型的序列化在平台接口包中处理。

三、实际环境

Flutter 鸿蒙环境搭建不在本文重复展开,直接参考 Flutter OH 环境搭建指南。

组件版本
Flutter OH3.47.4-ohos-1.0.4
Dart3.13.3
DevEco Studio26.0.0 Release
HarmonyOS SDKAPI 26
测试设备华为畅享 90 Pro Max,HarmonyOS 7.0.0.105(API 26)
目标库flutter_appauth 12.1.0
flutter --version
hdc list targets

四、确认上游版本并同步到 AtomGit

上游包地址是 https://github.com/MaikuB/flutter_appauth,版本 12.1.0 使用 BSD 3-Clause(Copyright © 2019) License。适配前我在 AtomGit 目标组织中搜索了同名库,没有找到可以直接使用的 OHOS 实现。

仓库适配提交为 c943027,分支与 TAG 12.1.0-ohos.2 均指向该提交。

git clone https://atomgit.com/oh-flutter/flutter_appauth.git
cd flutter_appauth
git switch feat/ohos_flutter_appauth_12.1.0
git log --oneline -5

五、创建适配分支并检查工程结构

git switch -c feat/ohos_flutter_appauth_12.1.0

关键目录如下:

flutter_appauth/
├── lib/                                        # 原有 Dart API 和 MethodChannel
├── ohos/
│   ├── index.ets                               # OHOS 插件导出入口
│   └── src/main/ets/components/plugin/
│       └── FlutterAppAuthPlugin.ets                           # 通道实现
├── example/lib/main.dart                        # 真机验证 Demo
├── example/ohos/                                # Flutter OH 宿主工程
├── pubspec.yaml                                # 声明 ohos 平台
└── README.OpenHarmony_CN.md                    # 鸿蒙适配说明

pubspec.yaml 中的关键声明是:

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: FlutterAppAuthPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致,否则 Dart 端能编译,运行时却不会注册插件。

六、适配过程:注册通道并对齐语义

授权流程分四步,每一步都有平台要点:

// 1) 解析端点(兼容 camelCase 与 OIDC 的 snake_case)
const doc = await this.fetchDiscoveryDocument(`${issuer}/.well-known/openid-configuration`);
const authEndpoint = doc.get('authorization_endpoint');

// 2) 组装授权 URL(含 PKCE-S256)
params.push(`code_challenge=${this.sha256Base64Url(verifier)}`);
params.push('code_challenge_method=S256');

// 3) 拉起系统浏览器
await this.ability.context.startAbility({
  action: 'ohos.want.action.viewData',
  entities: ['entity.system.browsable'],
  uri: url,
});

// 4) 深链回调:宿主 EntryAbility.onNewWant 转发
onNewWant(want: Want): void {
  FlutterAppAuthPlugin.currentInstance?.handleCallbackUri(want.uri);
}
方法OpenHarmony 实现
authorize组装 URL → 系统浏览器 → 深链回调
authorizeAndExchangeCode授权 + POST tokenEndpoint
token支持 authorization_code / refresh_token
endSession拉起 end_session_endpoint

七、构建配置与签名

示例工程的目标 SDK 对齐到 26,与 @ohos/flutter_ohos 的最低要求一致:

{
  "name": "default",
  "compatibleSdkVersion": "26.0.0",
  "targetSdkVersion": "26.0.0",
  "runtimeOS": "HarmonyOS"
}

Demo 的 AppScope/app.json5 统一成 com.example.flutter_oh_demo,与 DevEco 调试签名对应。证书、p12、p7b 和密码没有提交到仓库,读者应在自己的 DevEco Studio 中生成调试签名。

八、通过 AtomGit 引入适配版

在另一个 Flutter OH 应用中使用时,建议锁定 TAG:

dependencies:
  flutter_appauth:
    git:
      url: https://atomgit.com/oh-flutter/flutter_appauth.git
      ref: 12.1.0-ohos.2
flutter pub get

然后在 pubspec.lock 检查 source: git、AtomGit 地址和 resolved-ref,确认没有解析到 pub.dev 的同名版本。

九、构建、安装和真机验证

cd example
flutter pub get
flutter analyze
flutter build hap --debug
hdc install -r build/ohos/hap/entry-default-signed.hap
hdc shell aa start -a EntryAbility -b com.example.flutter_oh_demo

构建输出为 ✓ Built build/ohos/hap/entry-default-signed.hap.,随后 hdc 报告安装成功并启动 Ability。真机上按本文的截图顺序逐一点击按钮完成验证。

十、适配结果和当前边界

OAuth 链路已完整打通。三个必须注意的坑:

  1. 自定义 scheme 不能带下划线。RFC 3986 只允许字母/数字/+/-/.,com.example.flutter_oh_demo://callback 会被浏览器当成相对路径导致 404。改成 com.example.flutterohdemo://callback 才正常。
  2. 回调要主动转发给插件:EntryAbility.onNewWant 里把 want.uri 交给 FlutterAppAuthPlugin.currentInstance.handleCallbackUri(),插件再用 resolve/reject 兑现挂起的 authorize Promise。
  3. discovery 文档字段是 snake_case,Dart 侧 map 用 camelCase,两端都要兼容。

十一、FAQ

Q1:授权流程走通的关键是什么?

  • 现象: 完整链路是 discovery → PKCE → 系统浏览器 → 自定义 scheme 深链回调 → token 交换。
  • 解决方法: module.json5 声明 scheme 与 host,深链回到应用后把 code 交给 token 端点。
  • 验证结果: 真机拿到授权 code,页面显示 授权返回:verify-by-hdc。

Q2:接入的关键配置是什么?

  • 现象: module.json5 的 skills 要声明回调 scheme 与 host。
  • 解决方法: 按上面配置。
  • 验证结果: 深链成功唤起应用。

Q3:redirectUrl 参数用法有坑吗?

  • 现象: scheme 的合法性是最大的坑,见上面的第 1 点。
  • 解决方法: 使用无下划线的 scheme。
  • 验证结果: 验证通过。

十二、总结

flutter_appauth 12.1.0 已完整接入鸿蒙的 OAuth 授权:discovery 解析端点、PKCE-S256、系统浏览器授权、自定义 scheme 深链回调、token 交换与登出。验证时走通了"浏览器授权 → 深链 → Dart 收到授权码"的完整链路。

十三、参考资料和仓库地址

欢迎加入CPF-Flutter 鸿蒙社区:https://atomgit.com/CPF-Flutter

Logo

开源鸿蒙跨平台开发社区汇聚开发者与厂商,共建“一次开发,多端部署”的开源生态,致力于降低跨端开发门槛,推动万物智联创新。

更多推荐