Flutter 平臺(tái)特定的代碼

Flutter使用了一個(gè)靈活的系統(tǒng)，允許您調(diào)用特定平臺(tái)的API，無論在Android上的Java或Kotlin代碼中，還是iOS上的ObjectiveC或Swift代碼中均可用。

Flutter平臺(tái)特定的API支持不依賴于代碼生成，而是依賴于靈活的消息傳遞的方式：

• 應(yīng)用的Flutter部分通過平臺(tái)通道（platform channel）將消息發(fā)送到其應(yīng)用程序的所在的宿主（iOS或Android）。
• 宿主監(jiān)聽的平臺(tái)通道，并接收該消息。然后它會(huì)調(diào)用特定于該平臺(tái)的API（使用原生編程語言） - 并將響應(yīng)發(fā)送回客戶端，即應(yīng)用程序的Flutter部分。

框架概述: 平臺(tái)通道

使用平臺(tái)通道在客戶端（Flutter UI）和宿主（平臺(tái)）之間傳遞消息，如下圖所示：

消息和響應(yīng)是異步傳遞的，以確保用戶界面保持響應(yīng)(不會(huì)掛起)。

在客戶端，MethodChannel (API)可以發(fā)送與方法調(diào)用相對(duì)應(yīng)的消息。 在宿主平臺(tái)上，MethodChannel 在Android（(API) 和 FlutterMethodChannel iOS (API) 可以接收方法調(diào)用并返回結(jié)果。這些類允許您用很少的“腳手架”代碼開發(fā)平臺(tái)插件。

注意: 如果需要，方法調(diào)用也可以反向發(fā)送，宿主作為客戶端調(diào)用Dart中實(shí)現(xiàn)的API。 這個(gè)quick_actions插件就是一個(gè)具體的例子

平臺(tái)通道數(shù)據(jù)類型支持和解碼器

標(biāo)準(zhǔn)平臺(tái)通道使用標(biāo)準(zhǔn)消息編解碼器，以支持簡(jiǎn)單的類似JSON值的高效二進(jìn)制序列化，例如 booleans,numbers, Strings, byte buffers, List, Maps（請(qǐng)參閱StandardMessageCodec了解詳細(xì)信息）。 當(dāng)您發(fā)送和接收值時(shí)，這些值在消息中的序列化和反序列化會(huì)自動(dòng)進(jìn)行。

下表顯示了如何在宿主上接收Dart值，反之亦然：

示例: 使用平臺(tái)通道調(diào)用iOS和Android代碼

以下演示如何調(diào)用平臺(tái)特定的API來獲取和顯示當(dāng)前的電池電量。它通過一個(gè)平臺(tái)消息getBatteryLevel 調(diào)用Android BatteryManager API和iOS device.batteryLevel API。 。

該示例在應(yīng)用程序內(nèi)添加了特定于平臺(tái)的代碼。如果您想開發(fā)一個(gè)通用的平臺(tái)包，可以在其它應(yīng)用中也使用的話，你需要開發(fā)一個(gè)插件， 則項(xiàng)目創(chuàng)建步驟稍有不同（請(qǐng)參閱開發(fā) packages），但平臺(tái)通道代碼仍以相同方式編寫。

注意: 此示例的完整的可運(yùn)行源代碼位于：/examples/platform_channel/， 這個(gè)示例Android是用的Java, IOS用的是Objective-C，IOS Swift版本請(qǐng)參閱 /examples/platform_channel_swift/

Step 1: 創(chuàng)建一個(gè)新的應(yīng)用程序項(xiàng)目

首先創(chuàng)建一個(gè)新的應(yīng)用程序:

• 在終端運(yùn)行中：flutter create batterylevel

默認(rèn)情況下，模板支持使用Java編寫Android代碼，或使用Objective-C編寫iOS代碼。要使用Kotlin或Swift，請(qǐng)使用-i和/或-a標(biāo)志:

• 在終端中運(yùn)行: flutter create -i swift -a kotlin batterylevel

Step 2: 創(chuàng)建Flutter平臺(tái)客戶端

該應(yīng)用的State類擁有當(dāng)前的應(yīng)用狀態(tài)。我們需要延長(zhǎng)這一點(diǎn)以保持當(dāng)前的電量

首先，我們構(gòu)建通道。我們使用MethodChannel調(diào)用一個(gè)方法來返回電池電量。

通道的客戶端和宿主通過通道構(gòu)造函數(shù)中傳遞的通道名稱進(jìn)行連接。單個(gè)應(yīng)用中使用的所有通道名稱必須是唯一的; 我們建議在通道名稱前加一個(gè)唯一的“域名前綴”，例如samples.flutter.io/battery。

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
...
class _MyHomePageState extends State<MyHomePage> {
  static const platform = const MethodChannel('samples.flutter.io/battery');

  // Get battery level.
}

接下來，我們調(diào)用通道上的方法，指定通過字符串標(biāo)識(shí)符調(diào)用方法getBatteryLevel。 該調(diào)用可能失敗 - 例如，如果平臺(tái)不支持平臺(tái)API（例如在模擬器中運(yùn)行時(shí)），所以我們將invokeMethod調(diào)用包裝在try-catch語句中。

我們使用返回的結(jié)果，在setState中來更新用戶界面狀態(tài)batteryLevel。

  // Get battery level.
  String _batteryLevel = 'Unknown battery level.';

  Future<Null> _getBatteryLevel() async {
    String batteryLevel;
    try {
      final int result = await platform.invokeMethod('getBatteryLevel');
      batteryLevel = 'Battery level at $result % .';
    } on PlatformException catch (e) {
      batteryLevel = "Failed to get battery level: '${e.message}'.";
    }

    setState(() {
      _batteryLevel = batteryLevel;
    });
  }

最后，我們?cè)赽uild創(chuàng)建包含一個(gè)小字體顯示電池狀態(tài)和一個(gè)用于刷新值的按鈕的用戶界面。

@override
Widget build(BuildContext context) {
  return new Material(
    child: new Center(
      child: new Column(
        mainAxisAlignment: MainAxisAlignment.spaceEvenly,
        children: [
          new RaisedButton(
            child: new Text('Get Battery Level'),
            onPressed: _getBatteryLevel,
          ),
          new Text(_batteryLevel),
        ],
      ),
    ),
  );
}

Step 3a: 使用Java添加Android平臺(tái)特定的實(shí)現(xiàn)

注意: 以下步驟使用Java。如果您更喜歡Kotlin，請(qǐng)?zhí)讲襟E3b.

首先在Android Studio中打開您的Flutter應(yīng)用的Android部分：

1. 啟動(dòng) Android Studio
2. 選擇 ‘File > Open…’
3. 定位到您 Flutter app目錄, 然后選擇里面的 android文件夾，點(diǎn)擊 OK
4. 在java目錄下打開 MainActivity.java

接下來，在onCreate里創(chuàng)建MethodChannel并設(shè)置一個(gè)MethodCallHandler。確保使用與在Flutter客戶端使用的通道名稱相同。

import io.flutter.app.FlutterActivity;
import io.flutter.plugin.common.MethodCall;
import io.flutter.plugin.common.MethodChannel;
import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
import io.flutter.plugin.common.MethodChannel.Result;

public class MainActivity extends FlutterActivity {
    private static final String CHANNEL = "samples.flutter.io/battery";

    @Override
    public void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        new MethodChannel(getFlutterView(), CHANNEL).setMethodCallHandler(
                new MethodCallHandler() {
                    @Override
                    public void onMethodCall(MethodCall call, Result result) {
                        // TODO
                    }
                });
    }
}

接下來，我們添加Java代碼，使用Android電池API來獲取電池電量。此代碼與您在原生Android應(yīng)用中編寫的代碼完全相同。

首先，添加需要導(dǎo)入的依賴。

import android.content.ContextWrapper;
import android.content.Intent;
import android.content.IntentFilter;
import android.os.BatteryManager;
import android.os.Build.VERSION;
import android.os.Build.VERSION_CODES;
import android.os.Bundle;

然后，將下面的新方法添加到activity類中的，位于onCreate 方法下方：

private int getBatteryLevel() {
  int batteryLevel = -1;
  if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
    BatteryManager batteryManager = (BatteryManager) getSystemService(BATTERY_SERVICE);
    batteryLevel = batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY);
  } else {
    Intent intent = new ContextWrapper(getApplicationContext()).
        registerReceiver(null, new IntentFilter(Intent.ACTION_BATTERY_CHANGED));
    batteryLevel = (intent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1) * 100) /
        intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
  }

  return batteryLevel;
}

最后，我們完成之前添加的onMethodCall方法。我們需要處理平臺(tái)方法名為getBatteryLevel，所以我們?cè)赾all參數(shù)中進(jìn)行檢測(cè)是否為getBatteryLevel。 這個(gè)平臺(tái)方法的實(shí)現(xiàn)只需調(diào)用我們?cè)谇耙徊街芯帉懙腁ndroid代碼，并使用response參數(shù)返回成功和錯(cuò)誤情況的響應(yīng)。如果調(diào)用未知的方法，我們也會(huì)通知返回：

@Override
public void onMethodCall(MethodCall call, Result result) {
    if (call.method.equals("getBatteryLevel")) {
        int batteryLevel = getBatteryLevel();

        if (batteryLevel != -1) {
            result.success(batteryLevel);
        } else {
            result.error("UNAVAILABLE", "Battery level not available.", null);
        }
    } else {
        result.notImplemented();
    }
}               

您現(xiàn)就可以在Android上運(yùn)行該應(yīng)用程序。如果您使用的是Android模擬器，則可以通過工具欄中的...按鈕訪問Extended Controls面板中的電池電量

Step 3b: 使用Kotlin添加Android平臺(tái)特定的實(shí)現(xiàn)

注意: 以下步驟與步驟3a類似，只是使用Kotlin而不是Java。

此步驟假定您在step 1.中 使用該-a kotlin選項(xiàng)創(chuàng)建了項(xiàng)目

首先在Android Studio中打開您的Flutter應(yīng)用的Android部分

1. 啟動(dòng) Android Studio
2. 選擇 the menu item ‘File > Open…’
3. 定位到您 Flutter app目錄, 然后選擇里面的 android文件夾，點(diǎn)擊 OK
4. 在kotlin目錄中打開MainActivity.kt. (注意：如果您使用Android Studio 2.3進(jìn)行編輯，請(qǐng)注意’kotlin’文件夾將顯示為’java’。)

接下來，在onCreate里創(chuàng)建MethodChannel并設(shè)置一個(gè)MethodCallHandler。確保使用與在Flutter客戶端使用的通道名稱相同。

import android.os.Bundle
import io.flutter.app.FlutterActivity
import io.flutter.plugin.common.MethodChannel
import io.flutter.plugins.GeneratedPluginRegistrant

class MainActivity() : FlutterActivity() {
  private val CHANNEL = "samples.flutter.io/battery"

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    GeneratedPluginRegistrant.registerWith(this)

    MethodChannel(flutterView, CHANNEL).setMethodCallHandler { call, result ->
      // TODO
    }
  }
}

接下來，我們添加Kotlin代碼，使用Android電池API來獲取電池電量。此代碼與您在原生Android應(yīng)用中編寫的代碼完全相同。

首先，添加需要導(dǎo)入的依賴。

import android.content.Context
import android.content.ContextWrapper
import android.content.Intent
import android.content.IntentFilter
import android.os.BatteryManager
import android.os.Build.VERSION
import android.os.Build.VERSION_CODES

然后，將下面的新方法添加到activity類中的，位于onCreate 方法下方：

  private fun getBatteryLevel(): Int {
    val batteryLevel: Int
    if (VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
      val batteryManager = getSystemService(Context.BATTERY_SERVICE) as BatteryManager
      batteryLevel = batteryManager.getIntProperty(BatteryManager.BATTERY_PROPERTY_CAPACITY)
    } else {
      val intent = ContextWrapper(applicationContext).registerReceiver(null, IntentFilter(Intent.ACTION_BATTERY_CHANGED))
      batteryLevel = intent!!.getIntExtra(BatteryManager.EXTRA_LEVEL, -1) * 100 / intent.getIntExtra(BatteryManager.EXTRA_SCALE, -1)
    }

    return batteryLevel
  }

最后，我們完成之前添加的onMethodCall方法。我們需要處理平臺(tái)方法名為getBatteryLevel，所以我們?cè)赾all參數(shù)中進(jìn)行檢測(cè)是否為getBatteryLevel。 這個(gè)平臺(tái)方法的實(shí)現(xiàn)只需調(diào)用我們?cè)谇耙徊街芯帉懙腁ndroid代碼，并使用response參數(shù)返回成功和錯(cuò)誤情況的響應(yīng)。如果調(diào)用未知的方法，我們也會(huì)通知返回：

    MethodChannel(flutterView, CHANNEL).setMethodCallHandler { call, result ->
      if (call.method == "getBatteryLevel") {
        val batteryLevel = getBatteryLevel()

        if (batteryLevel != -1) {
          result.success(batteryLevel)
        } else {
          result.error("UNAVAILABLE", "Battery level not available.", null)
        }
      } else {
        result.notImplemented()
      }
    }

您現(xiàn)就可以在Android上運(yùn)行該應(yīng)用程序。如果您使用的是Android模擬器，則可以通過工具欄中的...按鈕訪問Extended Controls面板中的電池電量

Step 4a: 使用Objective-C添加iOS平臺(tái)特定的實(shí)現(xiàn)

注意: 以下步驟使用Objective-C。如果您喜歡Swift，請(qǐng)?zhí)讲襟E4b

首先打開Xcode中Flutter應(yīng)用程序的iOS部分:

1. 啟動(dòng) Xcode
2. 選擇 ‘File > Open…’
3. 定位到您 Flutter app目錄, 然后選擇里面的 iOS文件夾，點(diǎn)擊 OK
4. 確保Xcode項(xiàng)目的構(gòu)建沒有錯(cuò)誤。
5. 選擇 Runner > Runner ，打開`AppDelegate.m

接下來，在application didFinishLaunchingWithOptions:方法內(nèi)部創(chuàng)建一個(gè)FlutterMethodChannel，并添加一個(gè)處理方法。 確保與在Flutter客戶端使用的通道名稱相同。

#import <Flutter/Flutter.h>

@implementation AppDelegate
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
  FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;

  FlutterMethodChannel* batteryChannel = [FlutterMethodChannel
                                          methodChannelWithName:@"samples.flutter.io/battery"
                                          binaryMessenger:controller];

  [batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    // TODO
  }];

  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

接下來，我們添加ObjectiveC代碼，使用iOS電池API來獲取電池電量。此代碼與您在本機(jī)iOS應(yīng)用程序中編寫的代碼完全相同。

在AppDelegate類中添加以下新的方法：

- (int)getBatteryLevel {
  UIDevice* device = UIDevice.currentDevice;
  device.batteryMonitoringEnabled = YES;
  if (device.batteryState == UIDeviceBatteryStateUnknown) {
    return -1;
  } else {
    return (int)(device.batteryLevel * 100);
  }
}

最后，我們完成之前添加的setMethodCallHandler方法。我們需要處理的平臺(tái)方法名為getBatteryLevel，所以我們?cè)赾all參數(shù)中進(jìn)行檢測(cè)是否為getBatteryLevel。 這個(gè)平臺(tái)方法的實(shí)現(xiàn)只需調(diào)用我們?cè)谇耙徊街芯帉懙腎OS代碼，并使用response參數(shù)返回成功和錯(cuò)誤情況的響應(yīng)。如果調(diào)用未知的方法，我們也會(huì)通知返回：

[batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
  if ([@"getBatteryLevel" isEqualToString:call.method]) {
    int batteryLevel = [self getBatteryLevel];

    if (batteryLevel == -1) {
      result([FlutterError errorWithCode:@"UNAVAILABLE"
                                 message:@"Battery info unavailable"
                                 details:nil]);
    } else {
      result(@(batteryLevel));
    }
  } else {
    result(FlutterMethodNotImplemented);
  }
}];

您現(xiàn)在可以在iOS上運(yùn)行應(yīng)用程序。如果您使用的是iOS模擬器，請(qǐng)注意，它不支持電池API，因此應(yīng)用程序?qū)@示“電池信息不可用”。

Step 4b: 使用Swift添加一個(gè)iOS平臺(tái)的實(shí)現(xiàn)

注意: 以下步驟與步驟4a類似，只不過是使用Swift而不是Objective-C.

此步驟假定您在步驟1中 使用-i swift選項(xiàng)創(chuàng)建了項(xiàng)目。

首先打開Xcode中Flutter應(yīng)用程序的iOS部分:

1. 啟動(dòng) Xcode
2. 選擇 ‘File > Open…’
3. 定位到您 Flutter app目錄, 然后選擇里面的 ios文件夾，點(diǎn)擊 OK
4. 確保Xcode項(xiàng)目的構(gòu)建沒有錯(cuò)誤。
5. 選擇 Runner > Runner ，然后打開AppDelegate.swift

接下來，覆蓋application方法并創(chuàng)建一個(gè)FlutterMethodChannel綁定通道名稱samples.flutter.io/battery：

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    GeneratedPluginRegistrant.register(with: self);

    let controller : FlutterViewController = window?.rootViewController as! FlutterViewController;
    let batteryChannel = FlutterMethodChannel.init(name: "samples.flutter.io/battery",
                                                   binaryMessenger: controller);
    batteryChannel.setMethodCallHandler({
      (call: FlutterMethodCall, result: FlutterResult) -> Void in
      // Handle battery messages.
    });

    return super.application(application, didFinishLaunchingWithOptions: launchOptions);
  }
}

接下來，我們添加Swift代碼，使用iOS電池API來獲取電池電量。此代碼與您在本機(jī)iOS應(yīng)用程序中編寫的代碼完全相同。

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

private func receiveBatteryLevel(result: FlutterResult) {
  let device = UIDevice.current;
  device.isBatteryMonitoringEnabled = true;
  if (device.batteryState == UIDeviceBatteryState.unknown) {
    result(FlutterError.init(code: "UNAVAILABLE",
                             message: "Battery info unavailable",
                             details: nil));
  } else {
    result(Int(device.batteryLevel * 100));
  }
}

最后，我們完成之前添加的setMethodCallHandler方法。我們需要處理的平臺(tái)方法名為getBatteryLevel，所以我們?cè)赾all參數(shù)中進(jìn)行檢測(cè)是否為getBatteryLevel。 這個(gè)平臺(tái)方法的實(shí)現(xiàn)只需調(diào)用我們?cè)谇耙徊街芯帉懙腎OS代碼，并使用response參數(shù)返回成功和錯(cuò)誤情況的響應(yīng)。如果調(diào)用未知的方法，我們也會(huì)通知返回：

batteryChannel.setMethodCallHandler({
  (call: FlutterMethodCall, result: FlutterResult) -> Void in
  if ("getBatteryLevel" == call.method) {
    receiveBatteryLevel(result: result);
  } else {
    result(FlutterMethodNotImplemented);
  }
});

您現(xiàn)在可以在iOS上運(yùn)行應(yīng)用程序。如果您使用的是iOS模擬器，請(qǐng)注意，它不支持電池API，因此應(yīng)用程序?qū)@示“電池信息不可用”。

從UI代碼中分離平臺(tái)特定的代碼

如果您希望在多個(gè)Flutter應(yīng)用程序中使用特定于平臺(tái)的代碼，將代碼分離為位于主應(yīng)用程序之外的目錄中，做一個(gè)平臺(tái)插件會(huì)很有用。詳情請(qǐng)參閱開發(fā) packages 。

將平臺(tái)特定的代碼作為一個(gè)包發(fā)布

如果您希望與Flutter生態(tài)系統(tǒng)中的其他開發(fā)人員分享您的特定平臺(tái)的代碼，請(qǐng)參閱發(fā)[發(fā)布 packages](/developing-packages/#publish以了解詳細(xì)信息。

自定義平臺(tái)通道和編解碼器

除了上面提到的MethodChannel，你還可以使用BasicMessageChannel，它支持使用自定義消息編解碼器進(jìn)行基本的異步消息傳遞。 此外，您可以使用專門的BinaryCodec，StringCodec和 JSONMessageCodec類，或創(chuàng)建自己的編解碼器。