现有Flutter项目适配鸿蒙:探索跨平台开发的无限可能

引言

本文结合实际代码讲述如何改造现有 Flutter 项目,适配鸿蒙平台。

通过模块化,鸿蒙壳工程,结合 FVM 管理多版本 Flutter SDK,保持原 Flutter 代码纯净,最小化修改,完成鸿蒙化的适配示例。

准备工作

1. 安装 FVM

安装 FVM,更多安装方式参考 fvm 官方文档

curl -fsSL https://fvm.app/install.sh | bash

2.使用 FVM 安装 Flutter SDK

分别安装官方的Flutter版本(我这里用的比较旧,版本为 3.3.10),以及鸿蒙社区的 3.22.0 版本

提示:安装鸿蒙定制版本的 Flutter SDK,建议使用 git clone 命令行(我一开始直接 download zip,出现下载不全的现象)

现有 Flutter 工程架构

完成准备工作后,调整现有 Flutter 的工程结构,简化后大致如下:

.
├── apps  #该目录用于存放各端应用壳工程 (示例如下)
│   ├── app  #对应Android、IOS、Windows等原Flutter框架支持的平台
│   └── app_ohos  #对应HarmonyOS平台
│
├── modules  #该目录用于存放各业务模块 (示例如下)
│   ├── home_module  #首页
│   ├── trade_module  #交易结算
│   └── memeber_module  #会员管理
│
├── common  # 该目录用于存放公共库 (示例如下)
│   ├── network 
│   ├── tools  
│   └── widgets  
│
└── README.md

如上所示, /apps/app 为我们现有的 Flutter 壳工程目录,modulescommon目录是我们项目开发中封装的业务模块库及公共组件库。(当然,不一定要放在同一目录下,这里也为方便大家观察学习)

壳工程解耦,将统一布局三方库依赖放在下层模块中

例如,在home_module模块中添加外部三方库,封装后再提供给壳工程使用。

/modules/home_module/pubspec.yaml 中添加几个典型的三方库作为示例

name: home_module
description: home_module
version: 0.0.1
homepage:

environment:
  sdk: '>=2.18.6 <3.0.0'
  flutter: ">=1.17.0"

dependencies:
  flutter:
    sdk: flutter
  flutter_bloc: ^7.3.0  // 演示纯 Dart 实现的三方状态管理库
  dio: ^4.0.6           // 演示纯 Dart 实现的三方网络库
  fluttertoast: 8.1.2   // 演示依赖系统底层实现的三方库(需要鸿蒙化适配)

封装组件 HomePage 提供给壳工程,用于显示主页

image.png

App 壳工程

/apps/app/pubspec.yaml 中对各个业务模块及公共组件库进行依赖项添加

dependencies:
  flutter:
    sdk: flutter
  cupertino_icons: ^1.0.6
  home_module:
    path: '../../module/home_module'
  ... 省略其他  

通过依赖 home_module 显示封装的首页组件

image.png

点击运行,效果如下:

image.png
flutter_app.gif

鸿蒙壳工程

首先,我们需要在 /apps 目录下创建一个鸿蒙壳工程

+ 第一步,使用 FVM 将 Flutter 版本切换到鸿蒙化的版本

fvm use custom_3.22.0

+ 第二步,进入 /apps 目录,使用命令行创建 app_ohos 项目

fvm flutter create --template app --platforms ohos --org com.rex.flutter app_ohos
image.png

+ 添加依赖项

dependencies:
  flutter:
    sdk: flutter
  cupertino_icons: ^1.0.6
  home_module:
    path: '../../module/home_module'
  ... 省略其他  

+ 三方库鸿蒙化适配

通过 dependency_overrides 来替换鸿蒙化的三方库,以组件内用到的 fluttertoast 为例

dependency_overrides:
  fluttertoast:
    git:
      url: "https://gitee.com/openharmony-sig/flutter_fluttertoast.git"
      ref: "master"

app_ohos/pubsec.yaml 中的 dependency_overrides, 仅添加需要鸿蒙化的三方库
如何判断三方库是否需要鸿蒙化,简而言之,如果三方库由纯 Dart 实现,则不需要单独适配,直接使用;如果三方库依赖系统底层实现,则需要鸿蒙化适配。
三方库的适配情况,可以查询 Gitee/Github,或者查阅表格 Flutter三方库适配计划

+ 运行调试

用 Deveco 打开apps/app_ohos/ohos 目录。

在 Deveco 左上角 打开 File -> Project Structure..., 点击 Siging Configs, 勾选 Automatically generate signature, 对鸿蒙项目签名。

在 ohos_app 目录下,使用 fvm flutter run,或者点击运行按钮,运行flutter项目。

PS1:注意添加应用权限

image.png

PS2:没有真机的同学可以使用模拟器运行

image.png

运行效果如下:

flutter_app_ohos.gif

总结:

  1. 通过 FVM 管理多个 Flutter SDK 版本,仅在鸿蒙调测打包时,切换到 ohos-flutter SDK
  2. 通过 apps 壳工程,将鸿蒙化适配的代码,尽量在 app_ohos 项目中完成。通过 pub 包管理的 dependency_overrides 配置,逐个替换鸿蒙化的三方库
  3. Flutter 项目进行模块化、组件化、插件化拆分,职责分离,平台抽象,不同平台组合打包,有效解决平台不一致问题

DEMO 示例已上传: https://github.com/liyufengrex/flutter_ohos

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,039评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,426评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,417评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,868评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,892评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,692评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,416评论 3 419
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,326评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,782评论 1 316
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,957评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,102评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,790评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,442评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,996评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,113评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,332评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,044评论 2 355

推荐阅读更多精彩内容