如何再Flutter中嵌入Native组件(使用AndroidView嵌入地图)Flutter

/ / 2015-10-25
引言 在漫长的从Native向Flutter过渡的混合工程时期, 要想平滑地过渡,在Flutter中使用Native中较完善的控件会是一个很好的选择。本文希望向大家介绍AndroidView的使用方式以及在此基础之上拓展的双端嵌入Native组件的解决方案。 1. 使用教程 1.1. DemoRun...

引言

 

在漫长的从Native向Flutter过渡的混合工程时期,要想平滑地过渡,在Flutter中使用Native中较完善的控件会是一个很好的选择。本文希望向大家介绍AndroidView的使用方式以及在此基础之上拓展的双端嵌入Native组件的解决方案。

1. 使用教程

1.1. DemoRun

 

嵌入地图这一场景可能在很多App中都会存在,但是现在的地图SDK都没有提供Flutter的库,而自己开发一套地图显然不太现实。这种场景下,使用混合栈的形式是一个比较好的选择。我们可以直接在Native的绘图树中嵌入一个Map,但是这个方案嵌入的View并不在Flutter的绘图树中,是一种比较暴力且不优雅的方式,使用起来也很费劲。

这时候,使用Flutter官方提供的控件AndroidView就是一种比较优雅的解决方案了。这里做了一个简单的嵌入高德地图的demo,就让我们跟着这个应用场景,看一下AndroidView的使用方式和实现原理。

1.2. AndroidView使用方式

 

AndroidView的使用方式和MethodChannel类似,比较简单,主要分为三个步骤:

第一步:在dart代码的相应位置使用AndroidView,使用时需要传入一个 viewType,这个String将用于唯一标识该Widget,用于和Native的View建立关联。

第二步:在native侧添加代码,写一个PlatformViewFactory,PlatformViewFactory的主要任务是,在 create()方法中创建一个View并把它传给Flutter(这个说法并不准确,但是我们姑且可以这么理解,后续会进行解释)。

第三步:使用 registerViewFactory()方法注册刚刚写好的PlatformViewFactory,该方法需要传入两个参数,第一个参数需要和之前在Flutter端写的 viewType对应,第二个参数是刚刚写好的的PlatformViewFactory。

配置高德地图的部分这里就省略不说了,官方有比较详细的文档,可以去高德开发者平台进行查阅。

以上便是使用AndroidView的所有操作,总体看起来还是比较简单的,但是真正要用起来,还是有两个无法忽视的问题:

  • View最终的显示尺寸由谁决定?

  • 触摸事件是如何处理的?

下面就让小闲鱼来给各位一一解答。

2. 原理讲解

 

想要解决上面的两个问题,首先必须得理解所谓"传View"的本质是什么?

2.1. 所谓"传View"的本质是什么?

 

 

要解决这个问题,自然避免不了的需要去阅读源码,从更深的层面去看这个传递的整个过程,可以整理出一张这样的流程图:

我们可以看到,Flutter最终拿到的是native层返回的一个textureId。根据native的知识ky h这个textureId是已经在native侧渲染好了的view的绘图数据对应的ID,通过这个ID可以直接在GPU中找到相应的绘图数据并使用,那么Flutter是如何去利用这个ID的呢?

在之前的深入了解Flutter界面开发中,也给大家介绍了Flutter的绘图流程。我这里也给大家再简单整理一下

Flutter的Framework层最后会递交给Engine层一个layerTree,在管线中会遍历layertree的每一个叶子节点,每一个叶子节点最终会调用Skia引擎完成界面元素的绘制,在遍历完成后,在调用glPresentRenderBuffer(IOS)或者glSwapBuffer(Android)按完成上屏操作。

Layer的种类有很多,而AndroidView则使用的是其中的TextureLayer。TextureLayer在之前的《Flutter外接纹理》中有更为详细的介绍,这里就不再赘述。TextureLayer在被遍历到时,会调用一个engine层的方法 SceneBuilder::addTexture() 将textureId作为参数传入。最终在绘制的时候,skia会直接在GPU中根据textureId找到相应的绘制数据,并将其绘制到屏幕上。

那么是不是谁拿到这个ID都可以进行这样的操作呢?答案当然是否定的,Texture数据存储在创建它的EGLContext对应的线程中,所以如果在别的线程进行操作是无法获取到对应的数据的。这里需要引入几个概念:

  • 显示屏对象(Display):提供合理的显示器的像素密度和大小的信息

  • Presentation:它给Android提供了在对应的上下文(Context)和显示屏对象(Display)上绘制的能力,通常用于双屏异显。

这里不展开讲解Presentation,我们只需要明白Flutter是通过Presentation实现了外接纹理,在创建Presentation时,传入FlutterView对应的Context和创建出来的一个虚拟显示屏对象,使得Flutter可以直接通过ID找到并使用Native创建出来的纹理数据。

2.2. View最终的显示尺寸由谁决定?

 

通过上面的流程大家应该都能想到,显示尺寸看起来像是由两部分决定的:AndroidView的大小,Android端View的大小。那么实际上到底是有谁来决定的呢,让我们来做一个实验? 直接新建一个Flutter工程,并把中间改成一个AndroidView


  1. //Flutter

  2. class _MyHomePageState extends State<MyHomePage> {

  3.  double size = 200.0;

  4.  

  5.  void _changeSize() {

  6.    setState(() {

  7.      size = 100.0;

  8.    });

  9.  }

  10.  

  11.  @override

  12.  Widget build(BuildContext context) {

  13.    return new Scaffold(

  14.      appBar: new AppBar(

  15.        title: new Text(widget.title),

  16.      ),

  17.      body: Container(

  18.        color: Color(0xff0000ff),

  19.        child: SizedBox(

  20.          width: size,

  21.          height: size,

  22.          child: AndroidView(

  23.            viewType: 'testView',

  24.          ),

  25.        ),

  26.      ),

  27.      floatingActionButton: new FloatingActionButton(

  28.        onPressed: _changeSize,

  29.        child: new Icon(Icons.add),

  30.      ),

  31.    );

  32.  }

  33. }

在Android端也要加上对应的代码,为了更好地看出裁切效果,这里使用ImageView


  1. //Android

  2. @Override

  3. public PlatformView create(final Context context, int i, Object o) {

  4.    final ImageView imageView = new ImageView(context);

  5.    imageView.setLayoutParams(new ViewGroup.LayoutParams(500,500));

  6.    imageView.setBackground(context.getResources().getDrawable(R.drawable.idle_fish));

  7.    return new PlatformView() {

  8.        @Override

  9.        public View getView() {

  10.            return imageView;

  11.        }

  12.  

  13.        @Override

  14.        public void dispose() {

  15.  

  16.        }

  17.    };

  18. }

    首先先看AndroidView,AndroidView对应的RenderObject是RenderAndroidView,而一个RenderObject的最终大小的确定是存在两种可能,一种是由父节点所指定,还有一种是在父节点指定的范围中根据自身情况确定大小。打开对应的源码,可以看到其中有个很重要的属性 sizedByParent=true,也就是说AndroidView的大小是由其父节点所决定的,我们可以使用Container、SizedBox等控件控制AndroidView的大小。

    AndroidView的绘图数据是Native层所提供的,那么当Native中渲染的View的实际像素大小大于AndroidView的大小时,会发生什么呢?通常情况下,这种情况的处理思路无非就两种选择,一种是裁切,另一种是缩放。Flutter保持了其一贯的做法,所有out of the bounds的Widget统一使用裁切的方式进行展示,上面所描述的情况就被当作是一种out of the bounds。

    当这个View的实际像素大小小于AndroidView的时候,会发现View并不会相应地变小(Container的背景色并没有显露出来),没有内容的地方会被白色填充。这其中的原因是SingleViewPresentation::onCreate中,会使用一个FrameLayout作为rootView。

2.3. 触摸事件如何传递

 

  1. Android的事件流大家应该都很熟悉了,自顶向下传递,自底向上处理或回流。Flutter同样是使用这一规则,但是其中AndroidView通过两个类来去处理手势:

    MotionEventsDispatcher:负责将事件封装成Native的事件并向Native传递;

     

    AndroidViewGestureRecognizer:负责识别出相应的手势,其中有两个属性:

    cachedEventsforwardedPointers,只有当PointerEvent的pointer属性在forwardedPointers中时才会去进行分发,否则会存在cacheEvents中。这里的实现主要是为了解决一些事件的冲突,比如滑动事件,可以通过gestureRecognizers来进行处理,这里可以参考官方注释。

    
    		
    1. /// For example, with the following setup vertical drags will not be dispatched to the Android view as the vertical drag gesture is claimed by the parent [GestureDetector].

    2. ///

    3. /// GestureDetector(

    4. ///   onVerticalDragStart: (DragStartDetails d) {},

    5. ///   child: AndroidView(

    6. ///     viewType: 'webview',

    7. ///     gestureRecognizers: <OneSequenceGestureRecognizer>[],

    8. ///   ),

    9. /// )

    10. ///

    11. /// To get the [AndroidView] to claim the vertical drag gestures we can pass a vertical drag gesture recognizer in [gestureRecognizers] e.g:

    12. ///

    13. /// GestureDetector(

    14. ///   onVerticalDragStart: (DragStartDetails d) {},

    15. ///   child: SizedBox(

    16. ///     width: 200.0,

    17. ///     height: 100.0,

    18. ///     child: AndroidView(

    19. ///       viewType: 'webview',

    20. ///       gestureRecognizers: <OneSequenceGestureRecognizer>[ new VerticalDragGestureRecognizer() ],

    21. ///     ),

    22. ///   ),

    23. /// )

    所以总结起来,这部分流程总结起来其实也很简单:事件最初从Native到Flutter这一阶段不在本文的讨论范围之内,Flutter按照自己的规则去处理事件,如果AndroidView赢得了事件,事件就会被封装成相应的Native端的事件并且通过方法通道传回Native,Native再根据自己的处理事件的规则去处理。

3. 总结

3.1. 方案局限性

 

  1. 往大里说:这套方案是Google为了解决开发者日益增长的业务需求与落后的生态环境之间的矛盾而产生的,这一矛盾是一个新生态必然需要去面对的主要矛盾。为了解决这一个问题,最简单的方式当然就是允许开发者使用老生态中已经非常成熟的控件。当然,这样是可以临时解决Flutter生态发展不全面的问题,但是使用这套方案不可避免的需要去编写双端代码(甚至现在iOS还没有对应的控件,当然之后肯定会更新),不能做到真正的跨端。

    往小里说:这套方案存在着性能上的缺陷,在AndroidView这个类的第三句注释中,官方就已经提到了这是一套比较昂贵的方案,避免在使用Flutter控件也能实现的情况下去使用它。如果之前有看过《Flutter外接纹理》这一文章的同学应该知道,Flutter实现外接纹理的方案中,数据从GPU->CPU->GPU的过程代价是比较大的,在大量使用的场景会造成明显的性能缺陷。

    我们通过一些手段绕过了中间CPU这一步,并且将这项技术在APP中落地,用于处理图片资源。

3.2. 实际应用

 

  1. 目前闲鱼从Native向Flutter的迁移工作遇到了Native的本地图片资源在Flutter侧无法访问的问题,在现在Flutter和Native必将长期共存的情况下,重新拷贝一份资源以Flutter的规则来存储当然可以,但是不可避免地增大了包体积,而且不好管理。

    面对这个问题,我们的解法便是借鉴了AndroidView使用Texture的思路并在将其优化。实现了Native和Flutter的图片资源归一化。除了用于加载位于Native资源目录下的本地图片之外,还可以利用Native的图片库来加载网络图片。
    我们这么去做的原因是我们在Native侧的图片库较为完善且经受过大量线上考验,现在这一阶段,我们不希望将过多精力投入到重复造轮子这件事上,而处理网络图片资源和处理本地图片资源的思路其实是大同小异的。所以我们选择将图片资源进行了统一整合,在与官方团队沟通完善后和大家同步,敬请关注我们的公众号。
     

1