使用平臺通道編寫平臺特定的代碼

譯者語:所謂“平臺特定”或“特定平臺”,平臺指的就是原生Android或IOS,本文主要講原生和Flutter之間如何通信、如何進行功能互調。

本指南介紹如何編寫自定義平臺特定的代碼。一些平臺特定的功能可通過現有軟件包獲得; 請參閱使用 packages

Flutter使用了一個靈活的系統,允許您調用特定平臺的API,無論在Android上的Java或Kotlin代碼中,還是iOS上的ObjectiveC或Swift代碼中均可用。

Flutter平臺特定的API支持不依賴于代碼生成,而是依賴于靈活的消息傳遞的方式:

  • 應用的Flutter部分通過平臺通道(platform channel)將消息發送到其應用程序的所在的宿主(iOS或Android)。

  • 宿主監聽的平臺通道,并接收該消息。然后它會調用特定于該平臺的API(使用原生編程語言) - 并將響應發送回客戶端,即應用程序的Flutter部分。

框架概述: 平臺通道 {#architecture}

使用平臺通道在客戶端(Flutter UI)和宿主(平臺)之間傳遞消息,如下圖所示:

Platform channels architecture

消息和響應是異步傳遞的,以確保用戶界面保持響應(不會掛起)。

在客戶端,MethodChannel (API)可以發送與方法調用相對應的消息。 在宿主平臺上,MethodChannel 在Android((API) 和 FlutterMethodChannel iOS (API) 可以接收方法調用并返回結果。這些類允許您用很少的“腳手架”代碼開發平臺插件。

注意: 如果需要,方法調用也可以反向發送,宿主作為客戶端調用Dart中實現的API。 這個quick_actions插件就是一個具體的例子

平臺通道數據類型支持和解碼器 {#codec}

標準平臺通道使用標準消息編解碼器,以支持簡單的類似JSON值的高效二進制序列化,例如 booleans,numbers, Strings, byte buffers, List, Maps(請參閱StandardMessageCodec了解詳細信息)。 當您發送和接收值時,這些值在消息中的序列化和反序列化會自動進行。

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

Dart Android iOS
null null nil (NSNull when nested)
bool java.lang.Boolean NSNumber numberWithBool:
int java.lang.Integer NSNumber numberWithInt:
int, if 32 bits not enough java.lang.Long NSNumber numberWithLong:
int, if 64 bits not enough java.math.BigInteger FlutterStandardBigInteger
double java.lang.Double NSNumber numberWithDouble:
String java.lang.String NSString
Uint8List byte[] FlutterStandardTypedData typedDataWithBytes:
Int32List int[] FlutterStandardTypedData typedDataWithInt32:
Int64List long[] FlutterStandardTypedData typedDataWithInt64:
Float64List double[] FlutterStandardTypedData typedDataWithFloat64:
List java.util.ArrayList NSArray
Map java.util.HashMap NSDictionary


示例: 使用平臺通道調用iOS和Android代碼 {#example}

以下演示如何調用平臺特定的API來獲取和顯示當前的電池電量。它通過一個平臺消息getBatteryLevel 調用Android BatteryManager API和iOS device.batteryLevel API。 。

該示例在應用程序內添加了特定于平臺的代碼。如果您想開發一個通用的平臺包,可以在其它應用中也使用的話,你需要開發一個插件, 則項目創建步驟稍有不同(請參閱開發 packages),但平臺通道代碼仍以相同方式編寫。

注意: 此示例的完整的可運行源代碼位于:/examples/platform_channel/, 這個示例Android是用的Java, IOS用的是Objective-C,IOS Swift版本請參閱 /examples/platform_channel_swift/

Step 1: 創建一個新的應用程序項目 {#example-project}

首先創建一個新的應用程序:

  • 在終端運行中:flutter create batterylevel

默認情況下,模板支持使用Java編寫Android代碼,或使用Objective-C編寫iOS代碼。要使用Kotlin或Swift,請使用-i和/或-a標志:

  • 在終端中運行: flutter create -i swift -a kotlin batterylevel

Step 2: 創建Flutter平臺客戶端 {#example-client}

該應用的State類擁有當前的應用狀態。我們需要延長這一點以保持當前的電量

首先,我們構建通道。我們使用MethodChannel調用一個方法來返回電池電量。

通道的客戶端和宿主通過通道構造函數中傳遞的通道名稱進行連接。單個應用中使用的所有通道名稱必須是唯一的; 我們建議在通道名稱前加一個唯一的“域名前綴”,例如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.
}

接下來,我們調用通道上的方法,指定通過字符串標識符調用方法getBatteryLevel。 該調用可能失敗 - 例如,如果平臺不支持平臺API(例如在模擬器中運行時),所以我們將invokeMethod調用包裝在try-catch語句中。

我們使用返回的結果,在setState中來更新用戶界面狀態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;
    });
  }

最后,我們在build創建包含一個小字體顯示電池狀態和一個用于刷新值的按鈕的用戶界面。

@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平臺特定的實現 {#example-java}

注意: 以下步驟使用Java。如果您更喜歡Kotlin,請跳到步驟3b.

首先在Android Studio中打開您的Flutter應用的Android部分:

  1. 啟動 Android Studio

  2. 選擇 'File > Open...'

  3. 定位到您 Flutter app目錄, 然后選擇里面的 android文件夾,點擊 OK

  4. java目錄下打開 MainActivity.java

接下來,在onCreate里創建MethodChannel并設置一個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應用中編寫的代碼完全相同。

首先,添加需要導入的依賴。

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方法。我們需要處理平臺方法名為getBatteryLevel,所以我們在call參數中進行檢測是否為getBatteryLevel。 這個平臺方法的實現只需調用我們在前一步中編寫的Android代碼,并使用response參數返回成功和錯誤情況的響應。如果調用未知的方法,我們也會通知返回:

@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();
    }
}               

您現就可以在Android上運行該應用程序。如果您使用的是Android模擬器,則可以通過工具欄中的...按鈕訪問Extended Controls面板中的電池電量

Step 3b: 使用Kotlin添加Android平臺特定的實現 {#example-kotlin}

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

此步驟假定您在step 1.中 使用該-a kotlin選項創建了項目

首先在Android Studio中打開您的Flutter應用的Android部分

  1. 啟動 Android Studio

  2. 選擇 the menu item 'File > Open...'

  3. 定位到您 Flutter app目錄, 然后選擇里面的 android文件夾,點擊 OK

  4. kotlin目錄中打開MainActivity.kt. (注意:如果您使用Android Studio 2.3進行編輯,請注意'kotlin'文件夾將顯示為'java'。)

接下來,在onCreate里創建MethodChannel并設置一個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應用中編寫的代碼完全相同。

首先,添加需要導入的依賴。

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方法。我們需要處理平臺方法名為getBatteryLevel,所以我們在call參數中進行檢測是否為getBatteryLevel。 這個平臺方法的實現只需調用我們在前一步中編寫的Android代碼,并使用response參數返回成功和錯誤情況的響應。如果調用未知的方法,我們也會通知返回:

    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()
      }
    }

您現就可以在Android上運行該應用程序。如果您使用的是Android模擬器,則可以通過工具欄中的...按鈕訪問Extended Controls面板中的電池電量

Step 4a: 使用Objective-C添加iOS平臺特定的實現 {#example-objc}

注意: 以下步驟使用Objective-C。如果您喜歡Swift,請跳到步驟4b

首先打開Xcode中Flutter應用程序的iOS部分:

  1. 啟動 Xcode

  2. 選擇 'File > Open...'

  3. 定位到您 Flutter app目錄, 然后選擇里面的 iOS文件夾,點擊 OK

  4. 確保Xcode項目的構建沒有錯誤。

  5. 選擇 Runner > Runner ,打開`AppDelegate.m

接下來,在application didFinishLaunchingWithOptions:方法內部創建一個FlutterMethodChannel,并添加一個處理方法。 確保與在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來獲取電池電量。此代碼與您在本機iOS應用程序中編寫的代碼完全相同。

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

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

最后,我們完成之前添加的setMethodCallHandler方法。我們需要處理的平臺方法名為getBatteryLevel,所以我們在call參數中進行檢測是否為getBatteryLevel。 這個平臺方法的實現只需調用我們在前一步中編寫的IOS代碼,并使用response參數返回成功和錯誤情況的響應。如果調用未知的方法,我們也會通知返回:

[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);
  }
}];

您現在可以在iOS上運行應用程序。如果您使用的是iOS模擬器,請注意,它不支持電池API,因此應用程序將顯示“電池信息不可用”。

Step 4b: 使用Swift添加一個iOS平臺的實現 {#example-swift}

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

此步驟假定您在步驟1中 使用-i swift選項創建了項目。

首先打開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

@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來獲取電池電量。此代碼與您在本機iOS應用程序中編寫的代碼完全相同。

將以下新方法添加到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方法。我們需要處理的平臺方法名為getBatteryLevel,所以我們在call參數中進行檢測是否為getBatteryLevel。 這個平臺方法的實現只需調用我們在前一步中編寫的IOS代碼,并使用response參數返回成功和錯誤情況的響應。如果調用未知的方法,我們也會通知返回:

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

您現在可以在iOS上運行應用程序。如果您使用的是iOS模擬器,請注意,它不支持電池API,因此應用程序將顯示“電池信息不可用”。

從UI代碼中分離平臺特定的代碼 {#separate}

如果您希望在多個Flutter應用程序中使用特定于平臺的代碼,將代碼分離為位于主應用程序之外的目錄中,做一個平臺插件會很有用。詳情請參閱開發 packages

將平臺特定的代碼作為一個包發布 {#publish}

如果您希望與Flutter生態系統中的其他開發人員分享您的特定平臺的代碼,請參閱發[發布 packages](/developing-packages/#publish以了解詳細信息。

自定義平臺通道和編解碼器

除了上面提到的MethodChannel,你還可以使用BasicMessageChannel,它支持使用自定義消息編解碼器進行基本的異步消息傳遞。 此外,您可以使用專門的BinaryCodecStringCodecJSONMessageCodec類,或創建自己的編解碼器。


所屬標簽

無標簽

官方入門指南

Flutter官方發布的入門指導,包括了如何在不同的平臺(Windows, Mac, Linux)上搭建開發環境,以及一些入門級的指導,以便您從零開始進入Flutter的世界,同時,一些Flutter的框架API,也是您開發時必不可少的工具書。

從這里進入


25选5玩法中奖