Flutter工程结构


一、工程目录

AndroidStudio创建一个Flutter项目,Flutter工程的目录结构和普通Android工程是不同的,它是Google的跨平台UI框架,包含android和ios目录。

AndroidStudio创建Flutter工程目录
目录结构

android目录,android子工程,和普通android工程类似,包含app目录,gradle目录和gradle配置。
ios目录,ios子工程。
lib目录,dart源文件。
pubspec.yaml文件,Flutter配置文件,添加dart包packages依赖和包名。

Flutter工程android目录结构

二、android工程

1,顶级构建settings.gradle文件,包含构建模块,app主模块,动态include插件模块。

include ':app'
//android工程目录的父目录,即example目录
def flutterProjectRoot = rootProject.projectDir.parentFile.toPath()
//读取flutter工程根目录下.flutter-plugin文件
def plugins = new Properties()
def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins')
if (pluginsFile.exists()) {
    pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) }
}
//遍历.flutter-plugin中每项插件,include引入每项插件模块
plugins.each { name, path ->
    def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile()
    include ":$name"
    project(":$name").projectDir = pluginDirectory
}

普通Flutter工程(非Flutter插件工程),不存在.flutter-plugins文件,可以只关注include :app引入,忽略settings.gradle文件其他内容。
2,顶级构建build.gradle文件,和普通android工程顶层build.gradle基本一致,配置仓储库位置。

####不同之处
rootProject.buildDir = '../build'
subprojects {
    project.buildDir = "${rootProject.buildDir}/${project.name}"
}
subprojects {
    project.evaluationDependsOn(':app')
}

rootProject是android工程目录,设置build目录是当前的父目录,即Flutter工程目录,因此,android工程的build产物在Flutter工程build目录下。

android工程build产物目录

android子模块,每一个subprojects,子模块build的输出目录,在Flutter工程的build目录中,创建子模块name的输出目录,例如,app主模块。
如果新建mylibrary模块,将输出mylibrary的build目录。

subprojects子模块build输出路径

3,模块级构建build.gradle文件,app主模块。

def localProperties = new Properties()
def localPropertiesFile = rootProject.file('local.properties')
if (localPropertiesFile.exists()) {
    localPropertiesFile.withReader('UTF-8') { reader ->
        localProperties.load(reader)
    }
}
def flutterRoot = localProperties.getProperty('flutter.sdk')
if (flutterRoot == null) {
    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
}
def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
if (flutterVersionCode == null) {
    flutterVersionCode = '1'
}
def flutterVersionName = localProperties.getProperty('flutter.versionName')
if (flutterVersionName == null) {
    flutterVersionName = '1.0'
}
apply plugin: 'com.android.application'
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"

读取android目录,local.properties文件,该文件包括android sdk路径,flutter sdk路径,flutter版本,如果未配置flutter sdk路径,抛出Flutter SDK not found异常。
普通工程local.properties文件只包含android sdk路径。
apply plugin,app主模块是一个application。
apply from,引入flutter.sdk路径下的gradle文件flutter.gradle,flutterRoot是flutter sdk路径。
先执行flutter.gradle内容,加入一些打包时的Flutter任务插件。

# local.properties文件
sdk.dir=/Users/xxx/Library/Android/sdk,//android sdk路径
flutter.sdk=/Users/xxx/Documents/flutter,//flutter sdk路径
flutter.buildMode=debug
flutter.versionName=1.0.0
flutter.versionCode=1

三、插件工程

AndroidStudio创建一个Flutter插件工程。

AndroidStudio创建Flutter插件工程目录

插件工程提供了dart访问原生系统的功能,包括dart接口和原生api,dart接口在lib目录,定义一个_channel.invokeMethod(),访问原生方法。
原生api在android目录,定义一个实现MethodCallHandler接口类。
example目录,是一个完整的Flutter工程,测试插件。
测试插件的Flutter工程exmple目录android子工程,顶层构建settings.gradle文件,和普通Futter工程android目录的构建文件相同。

include ':app'
//android工程根目录的父目录,即flutter工程根目录
def flutterProjectRoot = rootProject.projectDir.parentFile.toPath()

//读取flutter工程根目录下.flutter-plugin文件
def plugins = new Properties()
def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins')
if (pluginsFile.exists()) {
    pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) }
}
//遍历.flutter-plugin中每项插件,include引入每项插件模块
plugins.each { name, path ->
    def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile()
    include ":$name"
    project(":$name").projectDir = pluginDirectory
}

flutterProjectRoot目录,android目录的父目录,即example目录,查找.flutter-plugins文件,保存插件name和路径,include对应name模块,每一个模块,代表一个android插件原生api。

.flutter-plugins文件

.flutter-plugins文件内容,key是插件name,value是路径。

在插件工程,example测试目录下的android主模块,引入example外层插件工程目录android插件模块,(和example平级)。
example目录下lib的dart代码,调用插件dart接口,(lib和example平级),提供的方法,获取原生功能。


任重而道远

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容