You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

432 lines
26 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# 44 | 如何构建自己的Flutter混合开发框架
你好,我是陈航。
在上一篇文章中我从工程架构与工作模式两个层面与你介绍了设计Flutter混合框架需要关注的基本设计原则即确定分工边界。
在工程架构维度由于Flutter模块作为原生工程的一个业务依赖其运行环境是由原生工程提供的因此我们需要将它们各自抽象为对应技术栈的依赖管理方式以分层依赖的方式确定二者的边界。
而在工作模式维度考虑到Flutter模块开发是原生开发的上游因此我们只需要从其构建产物的过程入手抽象出开发过程中的关键节点和高频节点以命令行的形式进行统一管理。构建产物是Flutter模块的输出同时也是原生工程的输入一旦产物完成构建我们就可以接入原生开发的工作流了。
可以看到在Flutter混合框架中Flutter模块与原生工程是相互依存、互利共赢的关系
* Flutter跨平台开发效率高渲染性能和多端体验一致性好因此在分工上主要专注于实现应用层的独立业务页面的渲染闭环
* 而原生开发稳定性高精细化控制力强底层基础能力丰富因此在分工上主要专注于提供整体应用架构为Flutter模块提供稳定的运行环境及对应的基础能力支持。
那么在原生工程中为Flutter模块提供基础能力支撑的过程中面对跨技术栈的依赖管理我们该遵循何种原则呢对于Flutter模块及其依赖的原生插件们我们又该如何以标准的原生工程依赖形式进行组件封装呢
在今天的文章中,我就通过一个典型案例,与你讲述这两个问题的解决办法。
## 原生插件依赖管理原则
在前面[第26](https://time.geekbang.org/column/article/127601)和[31篇](https://time.geekbang.org/column/article/132818)文章里我与你讲述了为Flutter应用中的Dart代码提供原生能力支持的两种方式在原生工程中的Flutter应用入口注册原生代码宿主回调的轻量级方案以及使用插件工程进行独立拆分封装的工程化解耦方案。
无论使用哪种方式Flutter应用工程都为我们提供了一体化的标准解决方案能够在集成构建时自动管理原生代码宿主及其相应的原生依赖因此我们只需要在应用层使用pubspec.yaml文件去管理Dart的依赖。
但**对于混合工程而言,依赖关系的管理则会复杂一些**。这是因为与Flutter应用工程有着对原生组件简单清晰的单向依赖关系不同混合工程对原生组件的依赖关系是多向的Flutter模块工程会依赖原生组件而原生工程的组件之间也会互相依赖。
如果继续让Flutter的工具链接管原生组件的依赖关系那么整个工程就会陷入不稳定的状态之中。因此对于混合工程的原生依赖Flutter模块并不做介入完全交由原生工程进行统一管理。而Flutter模块工程对原生工程的依赖体现在依赖原生代码宿主提供的底层基础能力的原生插件上。
接下来我就以网络通信这一基础能力为例与你展开说明原生工程与Flutter模块工程之间应该如何管理依赖关系。
## 网络插件依赖管理实践
在第24篇文章“[HTTP网络编程与JSON解析](https://time.geekbang.org/column/article/121163)”中我与你介绍了在Flutter中我们可以通过HttpClient、http与dio这三种通信方式实现与服务端的数据交换。
但在混合工程中考虑到其他原生组件也需要使用网络通信能力所以通常是由原生工程来提供网络通信功能的。因为这样不仅可以在工程架构层面实现更合理的功能分治还可以统一整个App内数据交换的行为。比如在网络引擎中为接口请求增加通用参数或者是集中拦截错误等。
关于原生网络通信功能目前市面上有很多优秀的第三方开源SDK比如iOS的AFNetworking和Alamofire、Android的OkHttp和Retrofit等。考虑到AFNetworking和OkHttp在各自平台的社区活跃度相对最高因此我就以它俩为例与你演示混合工程的原生插件管理方法。
## 网络插件接口封装
要想搞清楚如何管理原生插件我们需要先使用方法通道来建立Dart层与原生代码宿主之间的联系。
原生工程为Flutter模块提供原生代码能力我们同样需要使用Flutter插件工程来进行封装。关于这部分内容我在第[31](https://time.geekbang.org/column/article/132818)和[39](https://time.geekbang.org/column/article/141164)篇文章中,已经分别为你演示了推送插件和数据上报插件的封装方法,你也可以再回过头来复习下相关内容。所以,今天我就不再与你过多介绍通用的流程和固定的代码声明部分了,而是重点与你讲述与接口相关的实现细节。
**首先我们来看看Dart代码部分。**
对于插件工程的Dart层代码而言由于它仅仅是原生工程的代码宿主代理所以这一层的接口设计比较简单只需要提供一个可以接收请求URL和参数并返回接口响应数据的方法doRequest即可
```
class FlutterPluginNetwork {
...
static Future<String> doRequest(url,params) async {
//使用方法通道调用原生接口doRequest传入URL和param两个参数
final String result = await _channel.invokeMethod('doRequest', {
"url": url,
"param": params,
});
return result;
}
}
```
Dart层接口封装搞定了我们再来看看**接管真实网络调用的Android和iOS代码宿主如何响应Dart层的接口调用**。
我刚刚与你提到过原生代码宿主提供的基础通信能力是基于AFNetworkingiOS和OkHttpAndroid做的封装所以为了在原生代码中使用它们我们**首先**需要分别在flutter\_plugin\_network.podspec和build.gradle文件中将工程对它们的依赖显式地声明出来
在flutter\_plugin\_network.podspec文件中声明工程对AFNetworking的依赖
```
Pod::Spec.new do |s|
...
s.dependency 'AFNetworking'
end
```
在build.gradle文件中声明工程对OkHttp的依赖
```
dependencies {
implementation "com.squareup.okhttp3:okhttp:4.2.0"
}
```
**然后**我们需要在原生接口FlutterPluginNetworkPlugin类中完成例行的初始化插件实例、绑定方法通道工作。
最后我们还需要在方法通道中取出对应的URL和query参数为doRequest分别提供AFNetworking和OkHttp的实现版本。
对于iOS的调用而言由于AFNetworking的网络调用对象是AFHTTPSessionManager类所以我们需要这个类进行实例化并定义其接口返回的序列化方式本例中为字符串。然后剩下的工作就是用它去发起网络请求使用方法通道通知Dart层执行结果了
```
@implementation FlutterPluginNetworkPlugin
...
//方法通道回调
- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
//响应doRequest方法调用
if ([@"doRequest" isEqualToString:call.method]) {
//取出query参数和URL
NSDictionary *arguments = call.arguments[@"param"];
NSString *url = call.arguments[@"url"];
[self doRequest:url withParams:arguments andResult:result];
} else {
//其他方法未实现
result(FlutterMethodNotImplemented);
}
}
//处理网络调用
- (void)doRequest:(NSString *)url withParams:(NSDictionary *)params andResult:(FlutterResult)result {
//初始化网络调用实例
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
//定义数据序列化方式为字符串
manager.responseSerializer = [AFHTTPResponseSerializer serializer];
NSMutableDictionary *newParams = [params mutableCopy];
//增加自定义参数
newParams[@"ppp"] = @"yyyy";
//发起网络调用
[manager GET:url parameters:params progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
//取出响应数据响应Dart调用
NSString *string = [[NSString alloc] initWithData:responseObject encoding:NSUTF8StringEncoding];
result(string);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
//通知Dart调用失败
result([FlutterError errorWithCode:@"Error" message:error.localizedDescription details:nil]);
}];
}
@end
```
Android的调用也类似OkHttp的网络调用对象是OkHttpClient类所以我们同样需要这个类进行实例化。OkHttp的默认序列化方式已经是字符串了所以我们什么都不用做只需要URL参数加工成OkHttp期望的格式然后就是用它去发起网络请求使用方法通道通知Dart层执行结果了
```
public class FlutterPluginNetworkPlugin implements MethodCallHandler {
...
@Override
//方法通道回调
public void onMethodCall(MethodCall call, Result result) {
//响应doRequest方法调用
if (call.method.equals("doRequest")) {
//取出query参数和URL
HashMap param = call.argument("param");
String url = call.argument("url");
doRequest(url,param,result);
} else {
//其他方法未实现
result.notImplemented();
}
}
//处理网络调用
void doRequest(String url, HashMap<String, String> param, final Result result) {
//初始化网络调用实例
OkHttpClient client = new OkHttpClient();
//加工URL及query参数
HttpUrl.Builder urlBuilder = HttpUrl.parse(url).newBuilder();
for (String key : param.keySet()) {
String value = param.get(key);
urlBuilder.addQueryParameter(key,value);
}
//加入自定义通用参数
urlBuilder.addQueryParameter("ppp", "yyyy");
String requestUrl = urlBuilder.build().toString();
//发起网络调用
final Request request = new Request.Builder().url(requestUrl).build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, final IOException e) {
//切换至主线程通知Dart调用失败
registrar.activity().runOnUiThread(new Runnable() {
@Override
public void run() {
result.error("Error", e.toString(), null);
}
});
}
@Override
public void onResponse(Call call, final Response response) throws IOException {
//取出响应数据
final String content = response.body().string();
//切换至主线程响应Dart调用
registrar.activity().runOnUiThread(new Runnable() {
@Override
public void run() {
result.success(content);
}
});
}
});
}
}
```
需要注意的是,**由于方法通道是非线程安全的所以原生代码与Flutter之间所有的接口调用必须发生在主线程。**而OktHtp在处理网络请求时由于涉及非主线程切换所以需要调用runOnUiThread方法以确保回调过程是在UI线程中执行的否则应用可能会出现奇怪的Bug甚至是Crash。
有些同学可能会比较好奇,**为什么doRequest的Android实现需要手动切回UI线程而iOS实现则不需要呢**这其实是因为doRequest的iOS实现背后依赖的AFNetworking已经在数据回调接口时为我们主动切换了UI线程所以我们自然不需要重复再做一次了。
在完成了原生接口封装之后Flutter工程所需的网络通信功能的接口实现就全部搞定了。
## Flutter模块工程依赖管理
通过上面这些步骤我们以插件的形式提供了原生网络功能的封装。接下来我们就需要在Flutter模块工程中使用这个插件并提供对应的构建产物封装提供给原生工程使用了。这部分内容主要包括以下3大部分
* 第一如何使用FlutterPluginNetworkPlugin插件也就是模块工程功能如何实现
* 第二模块工程的iOS构建产物应该如何封装也就是原生iOS工程如何管理Flutter模块工程的依赖
* 第三模块工程的Android构建产物应该如何封装也就是原生Android工程如何管理Flutter模块工程的依赖。
接下来,我们具体看看每部分应该如何实现。
## 模块工程功能实现
为了使用FlutterPluginNetworkPlugin插件实现与服务端的数据交换能力我们首先需要在pubspec.yaml文件中将工程对它的依赖显示地声明出来
```
flutter_plugin_network:
git:
url: https://github.com/cyndibaby905/44_flutter_plugin_network.git
```
然后我们还得在main.dart文件中为它提供一个触发入口。在下面的代码中我们在界面上展示了一个RaisedButton按钮并在其点击回调函数时使用FlutterPluginNetwork插件发起了一次网络接口调用并把网络返回的数据打印到了控制台上
```
RaisedButton(
child: Text("doRequest"),
//点击按钮发起网络请求,打印数据
onPressed:()=>FlutterPluginNetwork.doRequest("https://jsonplaceholder.typicode.com/posts", {'userId':'2'}).then((s)=>print('Result:$s')),
)
```
运行这段代码点击doRequest按钮观察控制台输出可以看到接口返回的数据信息能够被正常打印证明Flutter模块的功能表现是完全符合预期的。
![](https://static001.geekbang.org/resource/image/68/83/6855481fc112697ff2cc03fdcc185883.png)
图1 Flutter模块工程运行示例
## 构建产物应该如何封装?
我们都知道模块工程的Android构建产物是aariOS构建产物是Framework。而在第[28](https://time.geekbang.org/column/article/129754)和[42](https://time.geekbang.org/column/article/144156)篇文章中我与你介绍了不带插件依赖的模块工程构建产物的两种封装方案即手动封装方案与自动化封装方案。这两种封装方案最终都会输出同样的组织形式Android是aariOS则是带podspec的Framework封装组件
如果你已经不熟悉这两种封装方式的具体操作步骤了,可以再复习下这两篇文章的相关内容。接下来,我重点与你讲述的问题是:**如果我们的模块工程存在插件依赖,封装过程是否有区别呢?**
答案是,对于模块工程本身而言,这个过程没有区别;但对于模块工程的插件依赖来说,我们需要主动告诉原生工程,哪些依赖是需要它去管理的。
由于Flutter模块工程把所有原生的依赖都交给了原生工程去管理因此其构建产物并不会携带任何原生插件的封装实现所以我们需要遍历模块工程所使用的原生依赖组件们为它们逐一生成插件代码对应的原生组件封装。
在第18篇文章“[依赖管理第三方组件库在Flutter中要如何管理](https://time.geekbang.org/column/article/114180)”中我与你介绍了Flutter工程管理第三方依赖的实现机制其中.packages文件存储的是依赖的包名与系统缓存中的包文件路径。
类似的,插件依赖也有一个类似的文件进行统一管理,即**.flutter-plugins**。我们可以通过这个文件找到对应的插件名字本例中即为flutter\_plugin\_network及缓存路径
```
flutter_plugin_network=/Users/hangchen/Documents/flutter/.pub-cache/git/44_flutter_plugin_network-9b4472aa46cf20c318b088573a30bc32c6961777/
```
插件缓存本身也可以被视为一个Flutter模块工程所以我们可以采用与模块工程类似的办法为它生成对应的原生组件封装。
对于iOS而言这个过程相对简单些所以我们先来看看模块工程的iOS构建产物封装过程。
### iOS构建产物应该如何封装
在插件工程的ios目录下为我们提供了带podspec文件的源码组件podspec文件提供了组件的声明及其依赖因此我们可以把这个目录下的文件拷贝出来连同Flutter模块组件一起放到原生工程中的专用目录并写到Podfile文件里。
原生工程会识别出组件本身及其依赖,并按照声明的依赖关系依次遍历,自动安装:
```
#Podfile
target 'iOSDemo' do
pod 'Flutter', :path => 'Flutter'
pod 'flutter_plugin_network', :path => 'flutter_plugin_network'
end
```
然后我们就可以像使用不带插件依赖的模块工程一样把它引入到原生工程中为其设置入口在FlutterViewController中展示Flutter模块的页面了。
不过需要注意的是由于FlutterViewController并不感知这个过程因此不会主动初始化项目中的插件所以我们还需要在入口处手动将工程里所有的插件依次声明出来
```
//AppDelegate.m:
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
//初始化Flutter入口
FlutterViewController *vc = [[FlutterViewController alloc]init];
//初始化插件
[FlutterPluginNetworkPlugin registerWithRegistrar:[vc registrarForPlugin:@"FlutterPluginNetworkPlugin"]];
//设置路由标识符
[vc setInitialRoute:@"defaultRoute"];
self.window.rootViewController = vc;
[self.window makeKeyAndVisible];
return YES;
}
```
在Xcode中运行这段代码点击doRequest按钮可以看到接口返回的数据信息能够被正常打印证明我们已经可以在原生iOS工程中顺利的使用Flutter模块了。
![](https://static001.geekbang.org/resource/image/32/c8/329866c452354bd0524fc3de798b4fc8.png)
图2 原生iOS工程运行示例
我们再来看看模块工程的Android构建产物应该如何封装。
### Android构建产物应该如何封装
与iOS的插件工程组件在ios目录类似Android的插件工程组件在android目录。对于iOS的插件工程我们可以直接将源码组件提供给原生工程但对于Andriod的插件工程来说我们只能将aar组件提供给原生工程所以我们不仅需要像iOS操作步骤那样进入插件的组件目录还需要借助构建命令为插件工程生成aar
```
cd android
./gradlew flutter_plugin_network:assRel
```
命令执行完成之后aar就生成好了。aar位于android/build/outputs/aar目录下我们打开插件缓存对应的路径提取出对应的aar本例中为flutter\_plugin\_network-debug.aar就可以了。
我们把生成的插件aar连同Flutter模块aar一起放到原生工程的libs目录下最后在build.gradle文件里将它显式地声明出来就完成了插件工程的引入。
```
//build.gradle
dependencies {
...
implementation(name: 'flutter-debug', ext: 'aar')
implementation(name: 'flutter_plugin_network-debug', ext: 'aar')
implementation "com.squareup.okhttp3:okhttp:4.2.0"
...
}
```
然后我们就可以在原生工程中为其设置入口在FlutterView中展示Flutter页面愉快地使用Flutter模块带来的高效开发和高性能渲染能力了
```
//MainActivity.java
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
View FlutterView = Flutter.createView(this, getLifecycle(), "defaultRoute");
setContentView(FlutterView);
}
}
```
不过**需要注意的是**与iOS插件工程的podspec能够携带组件依赖不同Android插件工程的封装产物aar本身不携带任何配置信息。所以如果插件工程本身存在原生依赖像flutter\_plugin\_network依赖OkHttp这样我们是无法通过aar去告诉原生工程其所需的原生依赖的。
面对这种情况我们需要在原生工程中的build.gradle文件里手动地将插件工程的依赖即OkHttp显示地声明出来。
```
//build.gradle
dependencies {
...
implementation(name: 'flutter-debug', ext: 'aar')
implementation(name: 'flutter_plugin_network-debug', ext: 'aar')
implementation "com.squareup.okhttp3:okhttp:4.2.0"
...
}
```
**至此将模块工程及其插件依赖封装成原生组件的全部工作就完成了原生工程可以像使用一个普通的原生组件一样去使用Flutter模块组件的功能了。**
在Android Studio中运行这段代码并点击doRequest按钮可以看到我们可以在原生Android工程中正常使用Flutter封装的页面组件了。
![](https://static001.geekbang.org/resource/image/54/f3/543a78c6839639a28b2eb9246c0196f3.png)
图3 原生Android工程运行示例
当然考虑到手动封装模块工程及其构建产物的过程繁琐且容易出错我们可以把这些步骤抽象成命令行脚本并把它部署到Travis上。这样在Travis检测到代码变更之后就会自动将Flutter模块的构建产物封装成原生工程期望的组件格式了。
关于这部分内容,你可以参考我在[flutter\_module\_demo](https://github.com/cyndibaby905/44_flutter_module_demo)里的[generate\_aars.sh](https://github.com/cyndibaby905/44_flutter_module_demo/blob/master/generate_aars.sh)与[generate\_pods.sh](https://github.com/cyndibaby905/44_flutter_module_demo/blob/master/generate_pods.sh)实现。如果关于这部分内容有任何问题,都可以直接留言给我。
## 总结
好了关于Flutter混合开发框架的依赖管理部分我们就讲到这里。接下来我们一起总结下今天的主要内容吧。
Flutter模块工程的原生组件封装形式是aarAndroid和FrameworkPod。与纯Flutter应用工程能够自动管理插件的原生依赖不同这部分工作在模块工程中是完全交给原生工程去管理的。因此我们需要查找记录了插件名称及缓存路径映射关系的.flutter-plugins文件提取出每个插件所对应的原生组件封装集成到原生工程中。
从今天的分享可以看出对于有着插件依赖的Android组件封装来说由于aar本身并不携带任何配置信息因此其操作以手工为主我们不仅要执行构建命令依次生成插件对应的aar还需要将插件自身的原生依赖拷贝至原生工程其步骤相对iOS组件封装来说要繁琐一些。
为了解决这一问题,业界出现了一种名为[fat-aar](https://github.com/adwiv/android-fat-aar)的打包手段它能够将模块工程本身及其相关的插件依赖统一打包成一个大的aar从而省去了依赖遍历和依赖声明的过程实现了更好的功能自治性。但这种解决方案存在一些较为明显的不足
* 依赖冲突问题。如果原生工程与插件工程都引用了同样的原生依赖组件OkHttp则原生工程的组件引用其依赖时会产生合并冲突因此在发布时必须手动去掉原生工程的组件依赖。
* 嵌套依赖问题。fat-aar只会处理embedded关键字指向的这层一级依赖而不会处理再下一层的依赖。因此对于依赖关系复杂的插件支持我们仍需要手动处理依赖问题。
* Gradle版本限制问题。fat-aar方案对Gradle插件版本有限制且实现方式并不是官方设计考虑的点加之Gradle API变更较快所以存在后续难以维护的问题。
* 其他未知问题。fat-aar项目已经不再维护了最近一次更新还是2年前在实际项目中使用“年久失修”的项目存在较大的风险。
考虑到这些因素fat-aar并不是管理插件工程依赖的好的解决方案所以**我们最好还是得老老实实地去遍历插件依赖以持续交付的方式自动化生成aar。**
我把今天分享涉及知识点打包上传到了GitHub中你可以把[插件工程](https://github.com/cyndibaby905/44_flutter_plugin_network)、[Flutter模块工程](https://github.com/cyndibaby905/44_flutter_module_demo)、[原生Android](https://github.com/cyndibaby905/44_AndroidDemo)和[iOS工程](https://github.com/cyndibaby905/44_iOSDemo)下载下来查看其Travis持续交付配置文件的构建执行命令体会在混合框架中如何管理跨技术栈的组件依赖。
## 思考题
最后,我给你留一道思考题吧。
原生插件的开发是一个需要Dart层代码封装以及原生Android、iOS代码层实现的长链路过程。如果需要支持的基础能力较多开发插件的过程就会变得繁琐且容易出错。我们都知道Dart是不支持反射的但是原生代码可以。我们是否可以利用原生的反射去实现插件定义的标准化呢
提示在Dart层调用不存在的接口或未实现的接口可以通过noSuchMethod方法进行统一处理。
```
class FlutterPluginDemo {
//方法通道
static const MethodChannel _channel =
const MethodChannel('flutter_plugin_demo');
//当调用不存在接口时Dart会交由该方法进行统一处理
@override
Future<dynamic> noSuchMethod(Invocation invocation) {
//从字符串Symbol("methodName")中取出方法名
String methodName = invocation.memberName.toString().substring(8, string.length - 2);
//参数
dynamic args = invocation.positionalArguments;
print('methodName:$methodName');
print('args:$args');
return methodTemplate(methodName, args);
}
//某未实现的方法
Future<dynamic> someMethodNotImplemented();
//某未实现的带参数方法
Future<dynamic> someMethodNotImplementedWithParameter(param);
}
```
欢迎你在评论区给我留言分享你的观点,我会在下一篇文章中等待你!感谢你的收听,也欢迎你把这篇文章分享给更多的朋友一起阅读。