iOS & Android 接入 Flutter

一、引言

使用 flutter 从零开始开发 App 是一件轻松惬意的事情,但对于一些成熟的产品来说,完全摒弃原有 App 的历史沉淀,全面转向 Flutter 是不现实的。因此使用 Flutter 去统一 AndroidiOS 技术栈,把它作为已有原生App 的扩展能力,通过有序推进来提升移动终端的开发效率。 目前,想要在已有的原生 App 里嵌入一些 Flutter 页面主要有两种方案。一种是将原生工程作为 Flutter 工程的子工程,由 Flutter 进行统一管理,这种模式称为统一管理模式。另一种是将 Flutter 工程作为原生工程的子模块,维持原有的原生工程管理方式不变,这种模式被称为三端分离模式,三端模式如下图;

image.png

二、各端集成方式:

首先需要确保当前 Flutter 项目是 module 工程,假设我们的项目路径为 some/path/my_flutter;

(一)iOS 接入 Flutter

方案 A:

  1. Flutter 项目根目录下执行打包操作:
cd some/path/my_flutter
flutter build ios-framework --output=../flutter_framework

 Building with sound null safety 

Building frameworks for com.example.wallpaper in debug mode...
 ├─Copying Flutter.xcframework...                                  392ms
 ├─Building App.xcframework...                                     38.2s
 ├─Building plugins...                                             63.7s
 └─Moving to flutter_framework/Debug                               375ms
Building frameworks for com.example.wallpaper in profile mode...
 ├─Copying Flutter.xcframework...                                  416ms
 ├─Building App.xcframework...                                     81.8s
 ├─Building plugins...                                             71.1s
 └─Moving to flutter_framework/Profile                             335ms
Building frameworks for com.example.wallpaper in release mode...
 ├─Copying Flutter.xcframework...                                1,728ms
 ├─Building App.xcframework...                                     94.3s
 ├─Building plugins...                                             65.8s
 └─Moving to flutter_framework/Release                             317ms
Frameworks written to some/path/my_flutter/flutter_framework.

2.打包完成后,所有 framework 文件会保存到 flutter_framework 文件夹,文件目录如下:

some/path/my_flutter/
└── flutter_framework/
    ├── Debug/
    │   ├── Flutter.xcframework
    │   ├── App.xcframework
    │   ├── FlutterPluginRegistrant.xcframework (only if you have plugins with iOS platform code)
    │   └── example_plugin.xcframework (each plugin is a separate framework)
    ├── Profile/
    │   ├── Flutter.xcframework
    │   ├── App.xcframework
    │   ├── FlutterPluginRegistrant.xcframework
    │   └── example_plugin.xcframework
    └── Release/
        ├── Flutter.xcframework
        ├── App.xcframework
        ├── FlutterPluginRegistrant.xcframework
        └── example_plugin.xcframework

3. 可以直接将编译产物中的所有 framework 拖到项目中就可以使用了,这边就不赘述了,这里主要讲解远端 pod 依赖的模式;

其实只有 Releaseframework 是需要上传到远程的,所以我们将 Release 文件夹下的所有文件上传到专门存储 frameworkgitlab 仓库里;

4.在 spec 仓库中创建一个 Flutter-wallpaper.podspec 文件,并放到相对应的版本文件夹下,文件内容如下:

Pod::Spec.new do |s|
  s.name             = 'Flutter-wallpaper'
  s.version          = '1.0.11'
  s.summary          = 'flutter 壁纸组件'

  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
  s.homepage         = 'https://xxx/xxx/ios_sdk/iOS_frameworks'

  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'xxx@xxx.com' => 'xxx@xxx.com' }
  s.source           = { :git => 'git@xxx/xxx/ios_sdk/iOS_frameworks.git'}

  s.ios.deployment_target = '9.0'

  s.ios.vendored_frameworks = 'flutter-lib/wallpaper/1.0.11/App.xcframework',
'flutter-lib/wallpaper/1.0.11/FMDB.xcframework',
'flutter-lib/wallpaper/1.0.11/Flutter.xcframework',
'flutter-lib/wallpaper/1.0.11/FlutterPluginRegistrant.xcframework',
'flutter-lib/wallpaper/1.0.11/Reachability.xcframework',
'flutter-lib/wallpaper/1.0.11/Toast.xcframework',
'flutter-lib/wallpaper/1.0.11/connectivity.xcframework',
'flutter-lib/wallpaper/1.0.11/device_info.xcframework',
'flutter-lib/wallpaper/1.0.11/fluttertoast.xcframework',
'flutter-lib/wallpaper/1.0.11/image_gallery_saver.xcframework',
'flutter-lib/wallpaper/1.0.11/package_info_plus.xcframework',
'flutter-lib/wallpaper/1.0.11/path_provider.xcframework',
'flutter-lib/wallpaper/1.0.11/sqflite.xcframework',
'flutter-lib/wallpaper/1.0.11/vibration.xcframework'

end

5.上面步骤都完成后,我们就可以通过 pod 来引用 flutter 模块了,在 Podfile 文件里面添加上 flutter 模块的版本描述:

pod 'Flutter-wallpaper', '1.0.11'

6.展示 FlutterViewController :

FlutterEngine *flutterEngine = [[FlutterEngine alloc] initWithName:@"io.flutter" project:nil];
[flutterEngine runWithEntrypoint:nil];
// 该方法要放到 runWithEntrypoint 之后
[GeneratedPluginRegistrant registerWithRegistry:self.flutterEngine];
FlutterViewController *flutterViewController = [[FlutterViewController alloc] initWithEngine:self.flutterEngine nibName:nil bundle:nil];
[self.navigationController pushViewController:flutterViewController animated:YES]

(二)android 接入 Flutter

集成方案:

方案 A (Google推荐的打包AAR方式):

  1. flutter 项目根目录下执行打包操作:
<pre>cd some/path/my_flutter
flutter build aar

2.打包完成后,命令行会输出如下集成步骤,帮助集成 flutter 模块;

Building without sound null safety
For more information see https://dart.dev/null-safety/unsound-null-safety

Running Gradle task 'assembleAarDebug'...                               
Running Gradle task 'assembleAarDebug'... Done                     42.3s
✓ Built build/host/outputs/repo.
Running Gradle task 'assembleAarProfile'...                             
Running Gradle task 'assembleAarProfile'... Done                   70.8s
✓ Built build/host/outputs/repo.
Running Gradle task 'assembleAarRelease'...                             
Running Gradle task 'assembleAarRelease'... Done                   82.0s
✓ Built build/host/outputs/repo.

Consuming the Module
  1\. Open <host>/app/build.gradle
  2\. Ensure you have the repositories configured, otherwise add them:

      String storageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
      repositories {
        maven {
            url '/Users/yoser/Desktop/work/Business/wallpaper/build/host/outputs/repo'
        }
        maven {
            url "$storageUrl/download.flutter.io"
        }
      }

  3\. Make the host app depend on the Flutter module:

    dependencies {
      debugImplementation 'com.example.wallpaper:flutter_debug:1.0'
      profileImplementation 'com.example.wallpaper:flutter_profile:1.0'
      releaseImplementation 'com.example.wallpaper:flutter_release:1.0'
    }

  4\. Add the `profile` build type:

    android {
      buildTypes {
        profile {
          initWith debug
        }
      }
    }

To learn more, visit https://flutter.dev/go/build-aar

主要分为三个步骤:

(1)app/build.gradle 文件中添加仓库索引

(2)app/build.gradle 文件中添加库依赖;

(3)通过 profile 来控制打包所使用的依赖包;

打包完成后的文件目录如下,其实就是一个本地的 maven 仓库,可以将该仓库发布到远程服务器上引入,下面为了方便,我采用的是本地仓库的方式;

build/host/outputs/repo
└── com
    └── example
        └── my_flutter
            ├── flutter_release
            │   ├── 1.0
            │   │   ├── flutter_release-1.0.aar
            │   │   ├── flutter_release-1.0.aar.md5
            │   │   ├── flutter_release-1.0.aar.sha1
            │   │   ├── flutter_release-1.0.pom
            │   │   ├── flutter_release-1.0.pom.md5
            │   │   └── flutter_release-1.0.pom.sha1
            │   ├── maven-metadata.xml
            │   ├── maven-metadata.xml.md5
            │   └── maven-metadata.xml.sha1
            ├── flutter_profile
            │   ├── ...
            └── flutter_debug
                └── ...

3.由于我使用的是最新的项目,所以仓库路径配置放在 settings.gradle 中设置:

String storageUrl = System.env.FLUTTER_STORAGE_BASE_URL ?: "https://storage.googleapis.com"
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()

        // s repository is going to shut down soon
        // 本地仓库路径
        maven {
            url '/Users/yoser/Desktop/work/Business/wallpaper/build/host/outputs/repo'
        }
        // flutter.so 和 flutter_embedding.jar 所在的远端仓库
        maven {
            url "$storageUrl/download.flutter.io"
        }
    }
}
rootProject.name = "FlutterDemo"
include ':app'

4.然后在 app/build.gradle 中添加 Flutter 库依赖;

dependencies {
    implementation 'com.example.wallpaper:flutter_debug:1.0'
}

因为用的是模拟器,而且没有配置 profile 去控制引用的包类型,所以直接用 debug 来运行代码,因为只有 debug 的库有包含 x86 架构,到这一步,flutter 已经集成到项目中;

展示页面

(1)添加 FlutterActivityAndroidManifest.xml 中:

<activity
  android:name="io.flutter.embedding.android.FlutterActivity"
  android:theme="@style/LaunchTheme"
  android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
  android:hardwareAccelerated="true"
  android:windowSoftInputMode="adjustResize"
  />

(2)普通跳转 FlutterActivity

myButton.setOnClickListener {
  startActivity(
    FlutterActivity.createDefaultIntent(this)
  )
}

(3)设置路由的方式跳转:

myButton.setOnClickListener {
  startActivity(
    FlutterActivity
      .withNewEngine()
      .initialRoute("/my_route")
      .build(this)
  )
}

(4)缓存 Flutter 引擎方式跳转:

class MyApplication : Application() {
  lateinit var flutterEngine : FlutterEngine
  override fun onCreate() {
    super.onCreate()
    // Instantiate a FlutterEngine.
    flutterEngine = FlutterEngine(this)
    // Configure an initial route.
    flutterEngine.navigationChannel.setInitialRoute("your/route/here");
    // Start executing Dart code to pre-warm the FlutterEngine.
    flutterEngine.dartExecutor.executeDartEntrypoint(
      DartExecutor.DartEntrypoint.createDefault()
    )
    // Cache the FlutterEngine to be used by FlutterActivity or FlutterFragment.
    FlutterEngineCache
      .getInstance()
      .put("my_engine_id", flutterEngine)
  }
}

myButton.setOnClickListener {
  startActivity(
    FlutterActivity
      .withCachedEngine("my_engine_id")
      .build(this)
  )
}

参考:

闲鱼 flutter 混合工程持续集成的最佳实践

Flutter官网

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

推荐阅读更多精彩内容