Flutter:platform channel

Dwyane

发布于 2019-05-31 10:15:12

1.2K0

发布于 2019-05-31 10:15:12

文章被收录于专栏：技术总结技术总结

Flutter使用了一个灵活的系统，允许您调用特定平台的API，无论在Android上的Java或Kotlin代码中，还是iOS上的ObjectiveC或Swift代码中均可用。

参考文献：Writing custom platform-specific code

Flutter与原生之间的通信依赖灵活的消息传递方式：

应用的Flutter部分通过平台通道（platform channel）将消息发送到其应用程序的所在的宿主（iOS或Android）应用（原生应用）。
宿主监听平台通道，并接收该消息。然后它会调用该平台的API，并将响应发送回客户端，即应用程序的Flutter部分。

平台通道

使用平台通道在Flutter(client)和原生(host)之间传递消息，如下图所示：

image.png

当在Flutter中调用原生方法时，调用信息通过平台通道传递到原生，原生收到调用信息后方可执行指定的操作，如需返回数据，则原生会将数据再通过平台通道传递给Flutter。值得注意的是消息传递是异步的，这确保了用户界面在消息传递时不会被挂起。

在客户端，MethodChannel API 可以发送与方法调用相对应的消息。在宿主平台上，MethodChannel 在Android API 和 FlutterMethodChannel在 iOS API可以接收方法调用并返回结果。这些类可以帮助我们用很少的代码就能开发平台插件。

注意: 如果需要，方法调用(消息传递)可以是反向的，即宿主作为客户端调用Dart中实现的API。 quick_actions插件就是一个具体的例子。

创建一个新的应用程序项目首先创建一个新的应用程序:

在终端中运行：flutter create systemversion 默认情况下，模板支持使用Java编写Android代码，或使用Objective-C编写iOS代码。要使用Kotlin或Swift，请使用-i和/或-a标志:

在终端中运行: flutter create -i swift -a kotlin systemversion

Flutter端代码

首先，我们构建通道。我们使用MethodChannel调用一个方法来返回系统版本。

通道的客户端和宿主通过通道构造函数中传递的通道名称进行连接。单个应用中使用的所有通道名称必须是唯一的; 我们建议在通道名称前加一个唯一的“域名前缀”，例如samples.flutter.io/systemVersion。

import 'dart:async';

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

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  // This widget is the root of your application.
  @override
  State<StatefulWidget> createState() {
    // TODO: implement createState
    return MyAppState();
  }
}

class MyAppState extends State<MyApp> {

static const platform = const MethodChannel('samples.flutter.io/systemVersion');
 // Get battery level.
  String _systemVersion = 'Unknown system version.';

// 我们调用通道上的方法，指定通过字符串标识符调用方法getSystemVersion。 
// 该调用可能失败(平台不支持平台API，例如在模拟器中运行时)，
// 所以我们将invokeMethod调用包装在try-catch语句中
  Future<Null> _getSystemVersion() async {
    String systemVersion;
    try {
      final String result = await platform.invokeMethod('systemVersion');
      systemVersion = 'iOS当前系统 $result.';
    } on PlatformException catch (e) {
      systemVersion = "Failed to get system version: '${e.message}'.";
    }
    // 在setState中来更新用户界面状态systemVersion
    setState(() {
      _systemVersion = systemVersion;
    });
  }

// 我们在build创建包含一个小字体显示当前系统systemVersion
// 和一个用于刷新值的按钮的用户界面。
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
        title: 'Flutter Demo',
        theme: ThemeData(
          primarySwatch: Colors.blue,
        ),
        home: Scaffold(
          appBar: AppBar(title: Text("platform channel：与原生交互"),),
          body: Center(
              
              child: new Column(
                children: <Widget>[
                  RaisedButton(
                onPressed: (){_getSystemVersion();},
                child: Text('show current systemVersion'),
              ),
              Text(_systemVersion),
                ],
              )
          ),
        )
    );
  }
}

iOS端代码

我们接着之前"获取当前系统版本"插件的示例，来完成iOS端API的实现。以下步骤使用Objective-C

首先打开Xcode中Flutter应用程序的iOS部分:

启动 Xcode
选择 File > Open…
定位到您 Flutter app目录, 然后选择里面的 iOS文件夹，点击 OK
确保Xcode项目的构建没有错误。
选择 Runner > Runner ，打开AppDelegate.m

接下来，在application didFinishLaunchingWithOptions:方法内部创建一个FlutterMethodChannel，并添加一个处理方法。确保与在Flutter客户端使用的通道名称相同。

// ----------  AppDelegate.m  ----------
#include "AppDelegate.h"
#include "GeneratedPluginRegistrant.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [GeneratedPluginRegistrant registerWithRegistry:self];
    FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;
    FlutterMethodChannel* systemVersionChannel = [FlutterMethodChannel
                                            methodChannelWithName:@"samples.flutter.io/systemVersion"
                                            binaryMessenger:controller];
    
    [systemVersionChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
        if ([@"systemVersion" isEqualToString:call.method]) {
            result([self getSystemVersion]); // 回调数据
        } else {
            result(FlutterMethodNotImplemented);
        }
    }];
  // Override point for customization after application launch.
  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

- (NSString *)getSystemVersion {
    UIDevice* device = UIDevice.currentDevice;
    NSLog(@"systemVersion==%@", device.systemVersion);
     return device.systemVersion;
}

@end

效果如下：

image.png