插件开发:iOS端API实现

本节我们接着之前”获取电池电量”插件的示例,来完成iOS端API的实现。以下步骤使用Objective-C,如果您更喜欢Swift,可以直接跳到后面Swift部分。

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

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

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

  1. #import <Flutter/Flutter.h>
  2. @implementation AppDelegate
  3. - (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
  4. FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;
  5. FlutterMethodChannel* batteryChannel = [FlutterMethodChannel
  6. methodChannelWithName:@"samples.flutter.io/battery"
  7. binaryMessenger:controller];
  8. [batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
  9. // TODO
  10. }];
  11. return [super application:application didFinishLaunchingWithOptions:launchOptions];
  12. }

接下来,我们添加Objective-C代码,使用iOS电池API来获取电池电量,这和原生是相同的。

AppDelegate类中添加以下新的方法:

  1. - (int)getBatteryLevel {
  2. UIDevice* device = UIDevice.currentDevice;
  3. device.batteryMonitoringEnabled = YES;
  4. if (device.batteryState == UIDeviceBatteryStateUnknown) {
  5. return -1;
  6. } else {
  7. return (int)(device.batteryLevel * 100);
  8. }
  9. }

最后,我们完成之前添加的setMethodCallHandler方法。我们需要处理的平台方法名为getBatteryLevel,所以我们在call参数中需要先判断是否为getBatteryLevel。 这个平台方法的实现只需调用我们在前一步中编写的iOS代码,并使用result参数返回成功或错误的响应。如果调用了未定义的API,我们也会通知返回:

  1. [batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
  2. if ([@"getBatteryLevel" isEqualToString:call.method]) {
  3. int batteryLevel = [self getBatteryLevel];
  4. if (batteryLevel == -1) {
  5. result([FlutterError errorWithCode:@"UNAVAILABLE"
  6. message:@"Battery info unavailable"
  7. details:nil]);
  8. } else {
  9. result(@(batteryLevel));
  10. }
  11. } else {
  12. result(FlutterMethodNotImplemented);
  13. }
  14. }];

现在可以在iOS上运行该应用程序了,如果使用的是iOS模拟器,请注意,它不支持电池API,因此应用程序将显示“电池信息不可用”。

使用Swift实现iOS API

以下步骤与上面使用Objective-C相似,首先打开Xcode中Flutter应用程序的iOS部分:

  1. 启动 Xcode
  2. 选择 ‘File > Open…’
  3. 定位到您 Flutter app目录, 然后选择里面的 ios文件夹,点击 OK
  4. 确保Xcode项目的构建没有错误。
  5. 选择 Runner > Runner ,然后打开AppDelegate.swift

接下来,覆盖application方法并创建一个FlutterMethodChannel绑定通道名称samples.flutter.io/battery

  1. @UIApplicationMain
  2. @objc class AppDelegate: FlutterAppDelegate {
  3. override func application(
  4. _ application: UIApplication,
  5. didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
  6. GeneratedPluginRegistrant.register(with: self);
  7. let controller : FlutterViewController = window?.rootViewController as! FlutterViewController;
  8. let batteryChannel = FlutterMethodChannel.init(name: "samples.flutter.io/battery",
  9. binaryMessenger: controller);
  10. batteryChannel.setMethodCallHandler({
  11. (call: FlutterMethodCall, result: FlutterResult) -> Void in
  12. // Handle battery messages.
  13. });
  14. return super.application(application, didFinishLaunchingWithOptions: launchOptions);
  15. }
  16. }

接下来,我们添加Swift代码,使用iOS电池API来获取电池电量,这和原生开发是相同的。

将以下新方法添加到AppDelegate.swift底部:

  1. private func receiveBatteryLevel(result: FlutterResult) {
  2. let device = UIDevice.current;
  3. device.isBatteryMonitoringEnabled = true;
  4. if (device.batteryState == UIDeviceBatteryState.unknown) {
  5. result(FlutterError.init(code: "UNAVAILABLE",
  6. message: "Battery info unavailable",
  7. details: nil));
  8. } else {
  9. result(Int(device.batteryLevel * 100));
  10. }
  11. }

最后,我们完成之前添加的setMethodCallHandler方法。我们需要处理的平台方法名为getBatteryLevel,所以我们在call参数中需要先判断是否为getBatteryLevel。 这个平台方法的实现只需调用我们在前一步中编写的iOS代码,并使用result参数返回成功或错误的响应。如果调用了未定义的API,我们也会通知返回:

  1. batteryChannel.setMethodCallHandler({
  2. (call: FlutterMethodCall, result: FlutterResult) -> Void in
  3. if ("getBatteryLevel" == call.method) {
  4. receiveBatteryLevel(result: result);
  5. } else {
  6. result(FlutterMethodNotImplemented);
  7. }
  8. });

现在可以在iOS上运行应用程序,如果使用的是iOS模拟器,请注意,它不支持电池API,因此应用程序将显示“电池信息不可用”。