learn-tech/专栏/Flutter核心技术与实战/29混合开发,该用何种方案管理导航栈?.md
2024-10-16 00:01:16 +08:00

16 KiB
Raw Blame History

                        因收到Google相关通知网站将会择期关闭。相关通知内容
                        
                        
                        29 混合开发,该用何种方案管理导航栈?
                        你好,我是陈航。

为了把Flutter引入到原生工程我们需要把Flutter工程改造为原生工程的一个组件依赖并以组件化的方式管理不同平台的Flutter构建产物即Android平台使用aar、iOS平台使用pod进行依赖管理。这样我们就可以在Android工程中通过FlutterViewiOS工程中通过FlutterViewController为Flutter搭建应用入口实现Flutter与原生的混合开发方式。

我在第26篇文章中提到FlutterView与FlutterViewController是初始化Flutter的地方也是应用的入口。可以看到以混合开发方式接入Flutter与开发一个纯Flutter应用在运行机制上并无任何区别只需要原生工程为它提供一个画板容器Android为FlutterViewiOS为FlutterViewControllerFlutter就可以自己管理页面导航栈从而实现多个复杂页面的渲染和切换。

关于纯Flutter应用的页面路由与导航我已经在第21篇文章中与你介绍过了。今天这篇文章我会为你讲述在混合开发中应该如何管理混合导航栈。

对于混合开发的应用而言通常我们只会将应用的部分模块修改成Flutter开发其他模块继续保留原生开发因此应用内除了Flutter的页面之外还会有原生Android、iOS的页面。在这种情况下Flutter页面有可能会需要跳转到原生页面而原生页面也可能会需要跳转到Flutter页面。这就涉及到了一个新的问题如何统一管理原生页面和Flutter页面跳转交互的混合导航栈。

接下来,我们就从这个问题入手,开始今天的学习吧。

混合导航栈

混合导航栈指的是原生页面和Flutter页面相互掺杂存在于用户视角的页面导航栈视图中。

以下图为例Flutter与原生Android、iOS各自实现了一套互不相同的页面映射机制即原生采用单容器单页面一个ViewController/Activity对应一个原生页面、Flutter采用单容器多页面一个ViewController/Activity对应多个Flutter页面的机制。Flutter在原生的导航栈之上又自建了一套Flutter导航栈这使得Flutter页面与原生页面之间涉及页面切换时我们需要处理跨引擎的页面切换。

图1 混合导航栈示意图

接下来我们就分别看看从原生页面跳转至Flutter页面以及从Flutter页面跳转至原生页面应该如何处理吧。

从原生页面跳转至Flutter页面

从原生页面跳转至Flutter页面实现起来比较简单。

因为Flutter本身依托于原生提供的容器iOS为FlutterViewControllerAndroid为Activity中的FlutterView所以我们通过初始化Flutter容器为其设置初始路由页面之后就可以以原生的方式跳转至Flutter页面了。

如下代码所示。对于iOS我们初始化一个FlutterViewController的实例为其设置初始化页面路由后将其加入原生的视图导航栈中完成跳转。

对于Android而言则需要多加一步。因为Flutter页面的入口并不是原生视图导航栈的最小单位Activity而是一个View即FlutterView所以我们还需要把这个View包装到Activity的contentView中。在Activity内部设置页面初始化路由之后在外部就可以采用打开一个普通的原生视图的方式打开Flutter页面了。

//iOS 跳转至Flutter页面 FlutterViewController *vc = [[FlutterViewController alloc] init]; [vc setInitialRoute:@"defaultPage"];//设置Flutter初始化路由页面 [self.navigationController pushViewController:vc animated:YES];//完成页面跳转

//Android 跳转至Flutter页面

//创建一个作为Flutter页面容器的Activity public class FlutterHomeActivity extends AppCompatActivity { protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //设置Flutter初始化路由页面 View FlutterView = Flutter.createView(this, getLifecycle(), "defaultRoute"); //传入路由标识符 setContentView(FlutterView);//用FlutterView替代Activity的ContentView } } //用FlutterPageActivity完成页面跳转 Intent intent = new Intent(MainActivity.this, FlutterHomeActivity.class); startActivity(intent);

从Flutter页面跳转至原生页面

从Flutter页面跳转至原生页面则会相对麻烦些我们需要考虑以下两种场景

从Flutter页面打开新的原生页面 从Flutter页面回退到旧的原生页面。

首先我们来看看Flutter如何打开原生页面。

Flutter并没有提供对原生页面操作的方法所以不可以直接调用。我们需要通过方法通道你可以再回顾下第26篇文章的相关内容在Flutter和原生两端各自初始化时提供Flutter操作原生页面的方法并注册方法通道在原生端收到Flutter的方法调用时打开新的原生页面。

接下来我们再看看如何从Flutter页面回退到原生页面。

因为Flutter容器本身属于原生导航栈的一部分所以当Flutter容器内的根页面即初始化路由页面需要返回时我们需要关闭Flutter容器从而实现Flutter根页面的关闭。同样Flutter并没有提供操作Flutter容器的方法因此我们依然需要通过方法通道在原生代码宿主为Flutter提供操作Flutter容器的方法在页面返回时关闭Flutter页面。

Flutter跳转至原生页面的两种场景如下图所示

图2 Flutter页面跳转至原生页面示意图

接下来我们一起看看这两个需要通过方法通道实现的方法即打开原生页面openNativePage与关闭Flutter页面closeFlutterPage在Android和iOS平台上分别如何实现。

注册方法通道最合适的地方是Flutter应用的入口即在FlutterViewControlleriOS端和Activity中的FlutterViewAndroid端这两个容器内部初始化Flutter页面前。为了将Flutter相关的行为封装到容器内部我们需要分别继承FlutterViewController和Activity在其viewDidLoad和onCreate初始化容器时注册openNativePage和closeFlutterPage这两个方法。

iOS端的实现代码如下所示

@interface FlutterHomeViewController : FlutterViewController @end

@implementation FlutterHomeViewController

  • (void)viewDidLoad { [super viewDidLoad]; //声明方法通道 FlutterMethodChannel* channel = [FlutterMethodChannel methodChannelWithName:@"samples.chenhang/navigation" binaryMessenger:self]; //注册方法回调 [channel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) { //如果方法名为打开新页面 if([call.method isEqualToString:@"openNativePage"]) { //初始化原生页面并打开 SomeOtherNativeViewController *vc = [[SomeOtherNativeViewController alloc] init]; [self.navigationController pushViewController:vc animated:YES]; result(@0); } //如果方法名为关闭Flutter页面 else if([call.method isEqualToString:@"closeFlutterPage"]) { //关闭自身(FlutterHomeViewController) [self.navigationController popViewControllerAnimated:YES]; result(@0); } else { result(FlutterMethodNotImplemented);//其他方法未实现 } }]; } @end

Android端的实现代码如下所示

//继承AppCompatActivity来作为Flutter的容器 public class FlutterHomeActivity extends AppCompatActivity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //初始化Flutter容器
FlutterView flutterView = Flutter.createView(this, getLifecycle(), "defaultPage"); //传入路由标识符 //注册方法通道 new MethodChannel(flutterView, "samples.chenhang/navigation").setMethodCallHandler( new MethodCallHandler() { @Override public void onMethodCall(MethodCall call, Result result) { //如果方法名为打开新页面 if(call.method.equals("openNativePage")) { //新建Intent打开原生页面 Intent intent = new Intent(FlutterHomeActivity.this, SomeNativePageActivity.class); startActivity(intent); result.success(0); } //如果方法名为关闭Flutter页面 else if(call.method.equals("closeFlutterPage")) { //销毁自身(Flutter容器) finish(); result.success(0); } else { //方法未实现 result.notImplemented(); } } }); //将flutterView替换成Activity的contentView setContentView(flutterView); } }

经过上面的方法注册我们就可以在Flutter层分别通过openNativePage和closeFlutterPage方法来实现Flutter页面与原生页面之间的切换了。

在下面的例子中Flutter容器的根视图DefaultPage包含有两个按钮

点击左上角的按钮后可以通过closeFlutterPage返回原生页面 点击中间的按钮后会打开一个新的Flutter页面PageA。PageA中也有一个按钮点击这个按钮之后会调用openNativePage来打开一个新的原生页面。

void main() => runApp(_widgetForRoute(window.defaultRouteName)); //获取方法通道 const platform = MethodChannel('samples.chenhang/navigation');

//根据路由标识符返回应用入口视图 Widget _widgetForRoute(String route) { switch (route) { default://返回默认视图 return MaterialApp(home:DefaultPage()); } }

class PageA extends StatelessWidget { ... @override Widget build(BuildContext context) { return Scaffold( body: RaisedButton( child: Text("Go PageB"), onPressed: ()=>platform.invokeMethod('openNativePage')//打开原生页面 )); } }

class DefaultPage extends StatelessWidget { ... @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( title: Text("DefaultPage Page"), leading: IconButton(icon:Icon(Icons.arrow_back), onPressed:() => platform.invokeMethod('closeFlutterPage')//关闭Flutter页面 )), body: RaisedButton( child: Text("Go PageA"), onPressed: ()=>Navigator.push(context, MaterialPageRoute(builder: (context) => PageA())),//打开Flutter页面 PageA )); } }

整个混合导航栈示例的代码流程,如下图所示。通过这张图,你就可以把这个示例的整个代码流程串起来了。

图3 混合导航栈示例

在我们的混合应用中RootViewController与MainActivity分别是iOS和Android应用的原生页面入口可以初始化为Flutter容器的FlutterHomeViewControlleriOS端与FlutterHomeActivityAndroid端

在为其设置初始路由页面DefaultPage之后就可以以原生的方式跳转至Flutter页面。但是Flutter并未提供接口来支持从Flutter的DefaultPage页面返回到原生页面因此我们需要利用方法通道来注册关闭Flutter容器的方法即closeFlutterPage让Flutter容器接收到这个方法调用时关闭自身。

在Flutter容器内部我们可以使用Flutter内部的页面路由机制通过Navigator.push方法完成从DefaultPage到PageA的页面跳转而当我们想从Flutter的PageA页面跳转到原生页面时因为涉及到跨引擎的页面路由所以我们仍然需要利用方法通道来注册打开原生页面的方法即openNativePage让 Flutter容器接收到这个方法调用时在原生代码宿主完成原生页面SomeOtherNativeViewControlleriOS端与SomeNativePageActivityAndroid端的初始化并最终完成页面跳转。

总结

好了,今天的分享就到这里。我们一起总结下今天的主要内容吧。

对于原生Android、iOS工程混编Flutter开发由于应用中会同时存在Android、iOS和Flutter页面所以我们需要妥善处理跨渲染引擎的页面跳转解决原生页面如何切换Flutter页面以及Flutter页面如何切换到原生页面的问题。

在原生页面切换到Flutter页面时我们通常会将Flutter容器封装成一个独立的ViewControlleriOS端或ActivityAndroid端在为其设置好Flutter容器的页面初始化路由即根视图原生的代码就可以按照打开一个普通的原生页面的方式来打开Flutter页面了。

而如果我们想在Flutter页面跳转到原生页面则需要同时处理好打开新的原生页面以及关闭自身回退到老的原生页面两种场景。在这两种场景下我们都需要利用方法通道来注册相应的处理方法从而在原生代码宿主实现新页面的打开和Flutter容器的关闭。

需要注意的是与纯Flutter应用不同原生应用混编Flutter由于涉及到原生页面与Flutter页面之间切换因此导航栈内可能会出现多个Flutter容器的情况即多个Flutter实例。

Flutter实例的初始化成本非常高昂每启动一个Flutter实例就会创建一套新的渲染机制即Flutter Engine以及底层的Isolate。而这些实例之间的内存是不互相共享的会带来较大的系统资源消耗。

因此我们在实际业务开发中应该尽量用Flutter去开发闭环的业务模块原生只需要能够跳转到Flutter模块剩下的业务都应该在Flutter内部完成而尽量避免Flutter页面又跳回到原生页面原生页面又启动新的Flutter实例的情况。

为了解决混编工程中Flutter多实例的问题业界有两种解决方案

以今日头条为代表的修改Flutter Engine源码使多FlutterView实例对应的多Flutter Engine能够在底层共享Isolate 以闲鱼为代表的共享FlutterView即由原生层驱动Flutter层渲染内容的方案。

坦白说,这两种方案各有不足:

前者涉及到修改Flutter源码不仅开发维护成本高而且增加了线程模型和内存回收出现异常的概率稳定性不可控。 后者涉及到跨渲染引擎的hack包括Flutter页面的新建、缓存和内存回收等机制因此在一些低端机或是处理页面切换动画时容易出现渲染Bug。 除此之外这两种方式均与Flutter的内部实现绑定较紧因此在处理Flutter SDK版本升级时往往需要耗费较大的适配成本。

综合来说目前这两种解决方案都不够完美。所以在Flutter官方支持多实例单引擎之前我们还是尽量在产品模块层面保证应用内不要出现多个Flutter容器实例吧。

我把今天分享所涉及到的知识点打包到了GitHubflutter_module_page、android_demo、iOS_demo你可以下载下来反复运行几次加深理解与记忆。

思考题

最后,我给你留两道思考题吧。

请在openNativePage方法的基础上增加页面id的功能可以支持在Flutter页面打开任意的原生页面。 混编工程中会出现两种页面过渡动画原生页面之间的切换动画、Flutter页面之间的切换动画。请你思考下如何能够确保这两种页面过渡动画在应用整体的效果是一致的。

欢迎你在评论区给我留言分享你的观点,我会在下一篇文章中等待你!感谢你的收听,也欢迎你把这篇文章分享给更多的朋友一起阅读。