Flutter笔记--Android工程中集成Flutter工程

前言

• 随着Flutter release版本的发布，Flutter的使用也提上日程，但是对于已有项目来说，直接使用Flutter重写不太现实，所以需要在现有native项目中集成Flutter

集成步骤

• flutter环境的搭建以及flutter项目的创建就不再赘述了，网上也有许多非常详细的教程（这里给个传送门）

1. 首先打开需要集成flutter的Android项目的Terminal面板，执行以下命令：

flutter create -t module flutter_yxj_user

• 其中flutter_yxj_user为你的flutter module 名

• 打开cmd切换到需要集成flutter的Android项目的同级目录执行以上命令也可以，另外AS最新版本[当前是3.2.1]中，注意需要最新版本才可以，用旧版本的无法利用该方法，只能使用命令行的方式，直接File->New->New Flutter Project->Flutter Module创建

2. 执行上述命令后会在需要集成flutter的Android项目的同级目录生成一个Flutter Module "your_flutter_module_name",可以看到项目中的.android文件夹中有一个include_flutter.groovy文件
   
   

   flutter_module_目录

3. 生成Module之后，在Android项目中的settings.gradle中添加如下配置代码，其中new File的参数就是include_flutter.groovy的路径，你可以写死，也可以动态配置，比如在local.properties文件中或和其它常量统一配置

//加入下面配置
setBinding(new Binding([gradle: this]))
evaluate(new File(
        "settingsDir.parentFile",  //这里是你的flutter module生成的目录dir,这里这样写代表需要集成flutter的Android项目的根目录，如果你的flutter module创建在其它目录，请在这里修改，如我这里的（"E://flutter_workspaces"）
        'flutter_yxj_user/.android/include_flutter.groovy' //这个是include_flutter.groovy文件的路径
))

4. 需要集成flutter的Android项目的app 的build.gradle文件中dependencies块中引入flutter project,同步一下即完成引入

 implementation project(':flutter')

5. 同步之后可以看到在Android项目的同级目录中出现了一个名为Flutter的mudule

6. 集成之后的项目结构如下：
   
   

   集成flutter的Android工程结构目录

7. 可以看到出现的Flutter的映射路径实际上就是上面我们生成的flutter module里面的.android目录中的Flutter。所以我们也可以猜测一下，添加的配置代码实际上就是在gradle的初始化阶段执行include_flutter.groovy文件中的代码，而这个文件代码的作用就是将刚刚生成的flutter module的的Flutter目录加载到项目中，建立一个映射关系。加载进来的和利用命令生成的目录是同一个。做一个小测试，在加载进来的Flutter目录下生成一个文件，在生成的目录下也会生成该文件更加证实了我们的猜想。

8. 对这部分感兴趣的同学也可以查看一下include_flutter.groovy文件中的代码

// Generated file. Do not edit.

//获取include_flutter.groovy文件的路径
def scriptFile = getClass().protectionDomain.codeSource.location.path
//获取flutter Project的根目录，也就是刚刚生成的flutter module的目录
def flutterProjectRoot = new File(scriptFile).parentFile.parentFile

//引入项目flutter，这里也可以看出我们在app 的build.gradle引入Flutter时是flutter而不是别的
gradle.include ':flutter'
//设置project flutter的projectDir为刚刚生成的flutter module的目录下的.android/Flutter目录
gradle.project(':flutter').projectDir = new File(flutterProjectRoot, '.android/Flutter')


def plugins = new Properties()
//拿到flutterProjectRoot目录下的.flutter-plugins文件，该文件存在于flutter插件module，也就是说你的flutter module中还存在Flutter Plugin项目，里面的内容类似于“flutter_plugin=E:\\flutter_workspaces\\hello_flutter\\flutter_plugin\\”
def pluginsFile = new File(flutterProjectRoot, '.flutter-plugins')
if (pluginsFile.exists()) {
    //如果该文件存在，读取property list到Properties plugins中，以key - value的形式，当前该文件是不存在的
    pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) }
}

//如果存在插件的话，引入
plugins.each { name, path ->
    def pluginDirectory = flutterProjectRoot.toPath().resolve(path).resolve('android').toFile()
    gradle.include ":$name"
    gradle.project(":$name").projectDir = pluginDirectory
}

//为项目的所有非flutter子module添加依赖，依赖flutter module
gradle.getGradle().projectsLoaded { g ->
    //为项目的根project添加生命周期监听，在gradle配置阶段之后执行
    g.rootProject.afterEvaluate { p ->
        //遍历所有的子 project（也就是module）
        p.subprojects { sp ->
            if (sp.name != 'flutter') {
                //如果该项目不是flutter module，添加依赖
                sp.evaluationDependsOn(':flutter')
            }
        }
    }
}

• 如果对于groovy语法不熟悉的同学，也可以查看笔者的gradle系列文章