源码获取
说明
以下步骤在Mac系统上完成,其它系统可以参考下面的官方说明:
先附上官方的说明:Setting up the Engine development environment
由于Engine和Embedder本身依赖了很多第三方仓库(并且很多第三方代码托管在chromium.googlesource.com、fuchsia.googlesource.com、skia.googlesource.com等域名下,下载过程中需要开启git代理以及http、https代理服务。),所以不能像Framework层代码一样通过git clone获取。需要借助Chromium的depot_tools工具完成依赖的下载。
第一步下载depot_tools并将其加入环境变量
$ mkdir flutter_source
$ cd flutter_source
$ git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
#(换成自己的目录或在当前目录执行 export PATH=$PATH:`pwd`/depot_tools)
$ export PATH=/path/to/depot_tools:$PATH
第二步配置 .gclient 文件
depot_tools中提供了gclient工具,配置环境变量后更方便食用。
新建一个.gclient 文件(PS:最好新建一个文件夹比如engine,因为一般会在.gclient 文件所在的目录下载Engine/Embedder源码),内容如下:
solutions = [
{
"managed": False,
"name": "src/flutter", //指定仓库的存放位置
"url": "https://github.com//engine.git", //制定将要下载的仓库地址,最好fork一份到自己仓库
"custom_deps": {},
"deps_file": "DEPS", // 指定存放第三方依赖的文件名。
"safesync_url": "",
},
]
第三步下载flutter/engine源码及其依赖。
在.gclient 文件所在的目录执行
$ gclient sync
注: 该命令再输入后可能会一段时间内没有任何输出(网络原因),可以通过活动监视器查看网络状态(代理记得开),gclient在输出“Syncing project: 100%(106/106),done”,后还会启动cipd_client下载部分大文件(活动监视器种查看状态,搜索筛选‘cipd’可以看到),不要中断下载,下载时间根据网络情况大约几十分钟~几小时不等。
到这一步Flutter源码就下载完了(前提是设备已经有了Flutter开发环境,已经获取过Framework层的代码即 ‘git clone https://github.com/flutter/flutter.git’)
第四步 切换源码。
编译前的一个重要操作是将源码切换到 本地 Flutter SDK 的 engine version (一个 commit id) 对应的提交点,避免可能出现的报错。
- 检出对应版本 获取当前Flutter(SDK)版本的提交信息
# 查看本地 Flutter SDK 引擎版本, 这个文件中是包含对应的 commit id
# 当前使用的flutter目录
vim /src/flutter/bin/internal/engine.version
# 或者使用
cat /src/flutter/bin/internal/engine.version
会得到一个具体的commit_id
- 切换源码
# 切换到engine所在目录
cd engine/src/flutter
# 制定git版本和本地flutter sdk使用版本一致
git reset --hard
# engine版本切换,DEPS可能也会改变,后面两个参数表示将tag、refspecs等仓库信息一起同步
gclient sync -D --with_branch_heads --with_tags
Flutter Engine目录结构
以下是src/flutter中的部分目录和对应的简单说明
├── assets #资源读取
├── common #公共逻辑
├── flow #渲染管道相关逻辑
├── flutter_frontend_server #Dart构建相关逻辑
├── fml #消息循环相关逻辑
├── lib #Dart Runtime及渲染和Web相关逻辑
├── runtime #Dart Runtime相关逻辑
├── shell
├──platform
├──android #Android Embedder相关逻辑
├──common #Embedder公共逻辑
├── sky
├── testing #测试相关
├── third_party
Flutter源码编译
切换到engine/src目录下
$ cd engine/src
$ ./flutter/tools/gn --android --android-cpu arm --unoptimized
$ ninja -C out/android_debug_unopt -j 8
$ ./flutter/tools/gn --android-cpu arm --unoptimized
$ ninja -C out/host_debug_unopt -j 8
注意点:
- 因为depot_tools设置过环境变量,不要直接使用gn命令(会使用depot_toolsde gn工具)
- 因为Engine是由C++开发,编译后的机器码和平台强相关,注意自己需要用的是arm/arm64或其它,其中--android-cpu可以省略,默认就是arm格式,同时默认编译debug版本。
- 编译过程比较耗时,约30分钟左右,cpu可能满负荷()
编译完成会有两个产物:
├── out
│ ├── android_debug_unopt
│ └── host_debug_unopt
- host_debug_unopt 作用是构建flutter工程,生成Dart Kernel或特定平台的AOT文件,能在x86架构的PC设备上生成ARM架构的机器码,正是得益于这个目录产物。
- android_debug_unopt 将存放最终构建出Engine和Embedder产物,文件较多,其中重要的文件是libflutter.jar该文件包括了Engine(libflutter.so)和Embedder的构建产物。
此外还会生成一个独立的libflutter.so文件,其包含了符号表等调试信息,文件会比较大,可用于源码调试。