Android端与Flutter混合开发项目集成

96
aimaile
2019.04.21 12:50* 字数 727

在Flutter的应用场景中,有时候一个APP只有部分页面是由Flutter实现的,比如:我们常用的闲鱼App,它宝贝详情页面是由Flutter实现的,这种开发模式被称为混合开发。

混合开发的一些其他应用场景:部分页面嵌套在原生页面中、或者部分模块采用flutter页面等。

将Flutter集成到现有的Android应用中需要如下几个主要步骤:
1、首先,创建Flutter module;
2、为已存在的Android应用添加Flutter module依赖;
3、在Java中调用Flutter module;
4、编写Dart代码;

1、创建Flutter module

在做混合开发之前我们首先需要创建一个Flutter module,如果在老项目做就无需创建新的了。

假如你的原有本地项目是这样的目录:xxx/hybrid/FlutterNative项目:
$ cd xxx/hybrid/
$ flutter create -t module flutter_app
上面代码会切换到你的Android/iOS项目的上一级目录,并创建一个flutter模块:
//flutter_app/
.android
.gitignore
.idea
.ios
.metadata
.packages
build
flutter_module_android.iml
flutter_module.iml
lib
pubspec.lock
pubspec.yaml
README.md
test

上面是flutter_app中的文件结构,你会发现它里面包含.android与.ios,这两个文件夹是隐藏文件,也是这个flutter_app宿主工程:

.android         -flutter_app的Android宿主工程;
.ios             -flutter_app的iOS宿主工程;
lib              -flutter_app的Dart部分的代码;
pubspec.yaml     -flutter_module的项目依赖配置文件;
因为宿主工程的存在,我们这个flutter_app在不加额外的配置的情况下是可以独立运行的,通过安装了Flutter
与Dart插件的AndroidStudio打开这个flutter_app项目,通过运行按钮是可以直接运行它的。

构建flutter aar(非必须)

如果你需要的话,可以通过如下命令来构建flutter aar:
$ cd .android/
$ ./gradlew flutter:assembleDebug
这会在.android/Flutter/build/outputs/aar/中生成一个flutter-debug.aar归档文件。

2、为原生Android应用添加Flutter module依赖

接下来我们需要配置我们Android项目的Flutter module依赖,打开新创建的或者维护的老项目Android项目的settings.gradle添加如下代码:

include ':app'                                     // 已存在module的内容
setBinding(new Binding([gradle: this]))                              
evaluate(new File(                                                
  settingsDir.parentFile,                                             
  'myflutter/.android/include_flutter.groovy'    
  //'{xxxxx你的flutter module目录}/.android/include_flutter.groovy'           
))                                                                     
setBinding与evaluate允许Flutter模块包括它自己在内的任何Flutter插件,
在settings.gradle中以类似: :flutter、package_info、:video_player的方式存在;

app/build.gradle中添加flutter依赖

dependencies {
  implementation project(':flutter')
}

在Java中调用Flutter module,至此,我们已经为我们的Android项目添加了Flutter所必须的依赖,接下来我们来看如何在Java中调用Flutter模块:
在Java中调用Flutter模块有两种方式:
1.使用Flutter.createView API的方式
2.使用FlutterFragment 的方式

#使用Flutter.createView API的方式
#HybridAndroid/app/src/main/java/some/package/MainActivity.java
fab.setOnClickListener(new View.OnClickListener() {
  @Override
  public void onClick(View view) {
    View flutterView = Flutter.createView(
      MainActivity.this,
      getLifecycle(),
      "route1"
    );
    FrameLayout.LayoutParams layout = new FrameLayout.LayoutParams(500, 900);
    layout.leftMargin = 200;
    layout.topMargin = 200;
    addContentView(flutterView, layout);
  }
});


#使用FlutterFragment 的方式
#可以创建一个FlutterFragment来自己处理生命周期:
// HybridAndroid/app/src/main/java/some/package/SomeActivity.java
fab.setOnClickListener(new View.OnClickListener() {
  @Override
  public void onClick(View view) {
    FragmentTransaction tx = getSupportFragmentManager().beginTransaction();
    tx.replace(R.id.someContainer, Flutter.createFragment("routeApp1"));
    tx.commit();
  }
});

上面我们使用字符串“routeApp1”来告诉Dart代码在Flutter视图中显示哪个小部件。 Flutter模块项目的lib/main.dart文件需要通过window.defaultRouteName来获取Native指定要显示的路由名,以确定要创建哪个窗口小部件并传递给FlutterApp:

import 'dart:ui';
import 'package:flutter/material.dart';

void main() => runApp(_widgetForRoute(window.defaultRouteName));

Widget _widgetForRoute(String route) {
  switch (route) {
    case 'routeApp1':
      return Widget1(...);//页面1
    case 'routeApp1':
      return Widget2(...);//页面2
    default:
      return Center(
        child: Text('Unknown view: $route', textDirection: TextDirection.ltr),
      );
  }
}

干货来了

调用Flutter module时传递数据,在上文中,我们无论是通过Flutter.createView的方式还是通过Flutter.createFragment的方式,都允许我们在加载Flutter module时传递一个String类型的initialRoute参数,从参数名字它是用作路由名的,但是既然Flutter给我们开了这个口子,那我们是不是可以搞点事情啊(自定义一些协议让flutter干一些其他操作),传递点我们想传的其他参数呢,比如:

#原生app端
FragmentTransaction tx = getSupportFragmentManager().beginTransaction();
                tx.replace(R.id.someContainer, Flutter.createFragment("{name:'devio',dataList:['11','22',''33]}"));
                tx.commit();

然后在Flutter module通过如下方式获取:

#flutter端
import 'dart:ui';//要使用window对象必须引入

String initParams = window.defaultRouteName;
//序列化成Dart obj 

注意事项

moudle中的build.gradle中修改最小sdk版本minSdkVersion 16,flutter最小支持16.
并且设置jdk版本

compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

最后编写Dart代码,放飞flutter无限可能,下一章将会揭开Flutter与原生Android程序通讯的神秘面纱。

flutter
Gupao