编写自定义平台特定代码

本指南介绍如何编写自定义平台特定代码。某些平台特定功能可通过现有插件包获得；请参阅使用插件包。

Flutter 使用灵活的系统，允许您以直接使用这些 API 的语言调用平台特定的 API

• Android 上的 Kotlin 或 Java
• iOS 上的 Swift 或 Objective-C
• Windows 上的 C++
• macOS 上的 Objective-C
• Linux 上的 C

Flutter 的内置平台特定 API 支持不依赖于代码生成，而是依赖于灵活的消息传递方式。或者，您可以使用Pigeon插件包进行发送结构化类型安全消息并进行代码生成。

• 应用的 Flutter 部分通过平台通道向其主机（应用的非 Dart 部分）发送消息。

• 主机在平台通道上监听并接收消息。然后，它使用原生编程语言调用任意数量的平台特定 API，并将响应发送回客户端（应用的 Flutter 部分）。

消息在客户端（UI）和主机（平台）之间通过平台通道传递，如下图所示。

消息和响应异步传递，以确保用户界面保持响应。

在客户端，MethodChannel 允许发送与方法调用相对应消息。在平台端，Android 上的 MethodChannel（MethodChannelAndroid）和 iOS 上的 FlutterMethodChannel（MethodChanneliOS）允许接收方法调用并发送回结果。这些类允许您开发平台插件，只需很少的“样板”代码。

标准平台通道使用标准消息编解码器，该编解码器支持简单 JSON 类值的有效二进制序列化，例如布尔值、数字、字符串、字节缓冲区以及这些值的列表和映射（有关详细信息，请参阅StandardMessageCodec）。当您发送和接收值时，这些值的序列化和反序列化到消息和从消息中自动进行。

下表显示了 Dart 值如何在平台端接收，反之亦然。

以下代码演示了如何调用平台特定 API 来检索和显示当前电池电量。它使用 Android 的 BatteryManager API、iOS 的 device.batteryLevel API、Windows 的 GetSystemPowerStatus API 以及 Linux 的 UPower API，并使用单个平台消息 getBatteryLevel()。

此示例在主应用本身内部添加了平台特定代码。如果您希望将平台特定代码重用于多个应用，则项目创建步骤略有不同（请参阅开发插件包），但平台通道代码的编写方式仍然相同。

首先创建一个新的应用

• 在终端中运行：flutter create batterylevel

默认情况下，我们的模板支持使用 Kotlin 编写 Android 代码，或使用 Swift 编写 iOS 代码。要使用 Java 或 Objective-C，请使用 -i 和/或 -a 标志。

• 在终端中运行：flutter create -i objc -a java batterylevel

应用的 State 类保存当前应用状态。将其扩展以保存当前电池状态。

首先，构造通道。使用具有单个返回电池电量平台方法的 MethodChannel。

通道的客户端和主机端通过传递给通道构造函数的通道名称连接。单个应用中使用的所有通道名称必须唯一；使用唯一的“域前缀”作为通道名称的前缀，例如：samples.flutter.dev/battery。

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

class _MyHomePageState extends State<MyHomePage> {
  static const platform = MethodChannel('samples.flutter.dev/battery');
  // Get battery level.

接下来，在方法通道上调用方法，使用 String 标识符 getBatteryLevel 指定要调用的具体方法。调用可能会失败，例如，如果平台不支持平台 API（例如在模拟器中运行时），因此请将 invokeMethod 调用包装在 try-catch 语句中。

使用返回的结果在 setState 内部的 _batteryLevel 中更新用户界面状态。

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

Future<void> _getBatteryLevel() async {
  String batteryLevel;
  try {
    final result = await platform.invokeMethod<int>('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 Material(
    child: Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.spaceEvenly,
        children: [
          ElevatedButton(
            onPressed: _getBatteryLevel,
            child: const Text('Get Battery Level'),
          ),
          Text(_batteryLevel),
        ],
      ),
    ),
  );
}

import androidx.annotation.NonNull
import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugin.common.MethodChannel

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

  override fun configureFlutterEngine(@NonNull flutterEngine: FlutterEngine) {
    super.configureFlutterEngine(flutterEngine)
    MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL).setMethodCallHandler {
      call, result ->
      // This method is invoked on the main thread.
      // TODO
    }
  }
}

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

  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
  }

    MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL).setMethodCallHandler {
      call, result ->
      // This method is invoked on the main thread.
      // TODO
    }

    MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL).setMethodCallHandler {
      // This method is invoked on the main thread.
      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()
      }
    }

import androidx.annotation.NonNull;
import io.flutter.embedding.android.FlutterActivity;
import io.flutter.embedding.engine.FlutterEngine;
import io.flutter.plugin.common.MethodChannel;

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

  @Override
  public void configureFlutterEngine(@NonNull FlutterEngine flutterEngine) {
    super.configureFlutterEngine(flutterEngine);
    new MethodChannel(flutterEngine.getDartExecutor().getBinaryMessenger(), CHANNEL)
        .setMethodCallHandler(
          (call, result) -> {
            // This method is invoked on the main thread.
            // TODO
          }
        );
  }
}

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;

  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;
  }

      new MethodChannel(flutterEngine.getDartExecutor().getBinaryMessenger(), CHANNEL)
        .setMethodCallHandler(
          (call, result) -> {
            // This method is invoked on the main thread.
            // TODO
          }
      );

      new MethodChannel(flutterEngine.getDartExecutor().getBinaryMessenger(), CHANNEL)
        .setMethodCallHandler(
          (call, result) -> {
            // This method is invoked on the main thread.
            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 模拟器，请在工具栏中 ... 按钮访问的“扩展控件”面板中设置电池电量。

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    let controller : FlutterViewController = window?.rootViewController as! FlutterViewController
    let batteryChannel = FlutterMethodChannel(name: "samples.flutter.dev/battery",
                                              binaryMessenger: controller.binaryMessenger)
    batteryChannel.setMethodCallHandler({
      [weak self] (call: FlutterMethodCall, result: FlutterResult) -> Void in
      // This method is invoked on the UI thread.
      // Handle battery messages.
    })

    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

private func receiveBatteryLevel(result: FlutterResult) {
  let device = UIDevice.current
  device.isBatteryMonitoringEnabled = true
  if device.batteryState == UIDevice.BatteryState.unknown {
    result(FlutterError(code: "UNAVAILABLE",
                        message: "Battery level not available.",
                        details: nil))
  } else {
    result(Int(device.batteryLevel * 100))
  }
}

batteryChannel.setMethodCallHandler({
  [weak self] (call: FlutterMethodCall, result: FlutterResult) -> Void in
  // This method is invoked on the UI thread.
  guard call.method == "getBatteryLevel" else {
    result(FlutterMethodNotImplemented)
    return
  }
  self?.receiveBatteryLevel(result: result)
})

#import <Flutter/Flutter.h>
#import "GeneratedPluginRegistrant.h"

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

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

  [batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    // This method is invoked on the UI thread.
    // TODO
  }];

  [GeneratedPluginRegistrant registerWithRegistry:self];
  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

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

__weak typeof(self) weakSelf = self;
[batteryChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
  // This method is invoked on the UI thread.
  if ([@"getBatteryLevel" isEqualToString:call.method]) {
    int batteryLevel = [weakSelf getBatteryLevel];

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

您现在应该能够在 iOS 上运行该应用了。如果使用 iOS 模拟器，请注意它不支持电池 API，应用会显示“电池电量不可用”。

首先在 Visual Studio 中打开 Flutter 应用的 Windows 宿主部分。

1. 在项目目录中运行一次 flutter build windows 以生成 Visual Studio 解决方案文件。

2. 启动 Visual Studio。

3. 选择 打开项目或解决方案。

4. 导航到包含 Flutter 应用的目录，然后进入 build 文件夹，再进入 windows 文件夹，然后选择 batterylevel.sln 文件。点击 打开。

添加平台通道方法的 C++ 实现。

1. 在解决方案资源管理器中 展开 batterylevel > 源文件。

2. 打开 flutter_window.cpp 文件。

首先，在文件顶部，于 #include "flutter_window.h" 之后添加必要的包含语句。

#include <flutter/event_channel.h>
#include <flutter/event_sink.h>
#include <flutter/event_stream_handler_functions.h>
#include <flutter/method_channel.h>
#include <flutter/standard_method_codec.h>
#include <windows.h>

#include <memory>

编辑 FlutterWindow::OnCreate 方法，并创建一个与通道名称 samples.flutter.dev/battery 绑定的 flutter::MethodChannel。

bool FlutterWindow::OnCreate() {
  // ...
  RegisterPlugins(flutter_controller_->engine());

  flutter::MethodChannel<> channel(
      flutter_controller_->engine()->messenger(), "samples.flutter.dev/battery",
      &flutter::StandardMethodCodec::GetInstance());
  channel.SetMethodCallHandler(
      [](const flutter::MethodCall<>& call,
         std::unique_ptr<flutter::MethodResult<>> result) {
        // TODO
      });

  SetChildContent(flutter_controller_->view()->GetNativeWindow());
  return true;
}

接下来，添加使用 Windows 电池 API 获取电池电量的 C++ 代码。此代码与您在原生 Windows 应用程序中编写的代码完全相同。

在 flutter_window.cpp 的顶部，于 #include 部分之后添加以下内容作为新函数。

static int GetBatteryLevel() {
  SYSTEM_POWER_STATUS status;
  if (GetSystemPowerStatus(&status) == 0 || status.BatteryLifePercent == 255) {
    return -1;
  }
  return status.BatteryLifePercent;
}

最后，完成前面添加的 setMethodCallHandler() 方法。您需要处理一个平台方法 getBatteryLevel()，因此在 call 参数中对其进行测试。此平台方法的实现调用上一步中编写的 Windows 代码。如果调用了未知方法，则报告该方法。

删除以下代码。

  channel.SetMethodCallHandler(
      [](const flutter::MethodCall<>& call,
         std::unique_ptr<flutter::MethodResult<>> result) {
        // TODO
      });

并替换为以下代码。

  channel.SetMethodCallHandler(
      [](const flutter::MethodCall<>& call,
         std::unique_ptr<flutter::MethodResult<>> result) {
        if (call.method_name() == "getBatteryLevel") {
          int battery_level = GetBatteryLevel();
          if (battery_level != -1) {
            result->Success(battery_level);
          } else {
            result->Error("UNAVAILABLE", "Battery level not available.");
          }
        } else {
          result->NotImplemented();
        }
      });

您现在应该能够在 Windows 上运行该应用程序了。如果您的设备没有电池，它会显示“电池电量不可用”。

首先在 Xcode 中打开 Flutter 应用的 macOS 宿主部分。

1. 启动 Xcode。

2. 选择菜单项 文件 > 打开...。

3. 导航到包含 Flutter 应用的目录，然后选择其中的 macos 文件夹。点击 确定。

添加平台通道方法的 Swift 实现。

1. 在项目导航器中 展开 Runner > Runner。

2. 打开位于项目导航器中 Runner > Runner 下的 MainFlutterWindow.swift 文件。

首先，在文件顶部，于 import FlutterMacOS 之后添加必要的导入语句。

import IOKit.ps

在 awakeFromNib 方法中创建一个与通道名称 samples.flutter.dev/battery 绑定的 FlutterMethodChannel。

  override func awakeFromNib() {
    // ...
    self.setFrame(windowFrame, display: true)
  
    let batteryChannel = FlutterMethodChannel(
      name: "samples.flutter.dev/battery",
      binaryMessenger: flutterViewController.engine.binaryMessenger)
    batteryChannel.setMethodCallHandler { (call, result) in
      // This method is invoked on the UI thread.
      // Handle battery messages.
    }

    RegisterGeneratedPlugins(registry: flutterViewController)

    super.awakeFromNib()
  }
}

接下来，添加使用 IOKit 电池 API 获取电池电量的 macOS Swift 代码。此代码与您在原生 macOS 应用中编写的代码完全相同。

在 MainFlutterWindow.swift 底部添加以下内容作为新方法。

private func getBatteryLevel() -> Int? {
  let info = IOPSCopyPowerSourcesInfo().takeRetainedValue()
  let sources: Array<CFTypeRef> = IOPSCopyPowerSourcesList(info).takeRetainedValue() as Array
  if let source = sources.first {
    let description =
      IOPSGetPowerSourceDescription(info, source).takeUnretainedValue() as! [String: AnyObject]
    if let level = description[kIOPSCurrentCapacityKey] as? Int {
      return level
    }
  }
  return nil
}

最后，完成前面添加的 setMethodCallHandler 方法。您需要处理一个平台方法 getBatteryLevel()，因此在 call 参数中对其进行测试。此平台方法的实现调用上一步中编写的 macOS 代码。如果调用了未知方法，则报告该方法。

batteryChannel.setMethodCallHandler { (call, result) in
  switch call.method {
  case "getBatteryLevel":
    guard let level = getBatteryLevel() else {
      result(
        FlutterError(
          code: "UNAVAILABLE",
          message: "Battery level not available",
          details: nil))
     return
    }
    result(level)
  default:
    result(FlutterMethodNotImplemented)
  }
}

您现在应该能够在 macOS 上运行该应用程序了。如果您的设备没有电池，它会显示“电池电量不可用”。

对于此示例，您需要安装 upower 开发人员头文件。这可能可以通过您的发行版获得，例如使用以下命令：

sudo apt install libupower-glib-dev

首先在您选择的编辑器中打开 Flutter 应用的 Linux 宿主部分。以下说明适用于安装了“C/C++”和“CMake”扩展的 Visual Studio Code，但可以调整以适用于其他 IDE。

1. 启动 Visual Studio Code。

2. 打开项目内的 linux 目录。

3. 在提示“是否要配置项目“linux”？”时选择 是。这将启用 C++ 自动完成。

4. 打开 my_application.cc 文件。

首先，在文件顶部，于 #include 之后添加必要的包含语句。

#include <math.h>
#include <upower.h>

在 _MyApplication 结构体中添加一个 FlMethodChannel。

struct _MyApplication {
  GtkApplication parent_instance;
  char** dart_entrypoint_arguments;
  FlMethodChannel* battery_channel;
};

确保在 my_application_dispose 中清理它。

static void my_application_dispose(GObject* object) {
  MyApplication* self = MY_APPLICATION(object);
  g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev);
  g_clear_object(&self->battery_channel);
  G_OBJECT_CLASS(my_application_parent_class)->dispose(object);
}

编辑 my_application_activate 方法，并在调用 fl_register_plugins 之后使用通道名称 samples.flutter.dev/battery 初始化 battery_channel。

static void my_application_activate(GApplication* application) {
  // ...
  fl_register_plugins(FL_PLUGIN_REGISTRY(self->view));

  g_autoptr(FlStandardMethodCodec) codec = fl_standard_method_codec_new();
  self->battery_channel = fl_method_channel_new(
      fl_engine_get_binary_messenger(fl_view_get_engine(view)),
      "samples.flutter.dev/battery", FL_METHOD_CODEC(codec));
  fl_method_channel_set_method_call_handler(
      self->battery_channel, battery_method_call_handler, self, nullptr);

  gtk_widget_grab_focus(GTK_WIDGET(self->view));
}

接下来，添加使用 Linux 电池 API 获取电池电量的 C 代码。此代码与您在原生 Linux 应用程序中编写的代码完全相同。

在 my_application.cc 的顶部，于 G_DEFINE_TYPE 行之后添加以下内容作为新函数。

static FlMethodResponse* get_battery_level() {
  // Find the first available battery and report that.
  g_autoptr(UpClient) up_client = up_client_new();
  g_autoptr(GPtrArray) devices = up_client_get_devices2(up_client);
  if (devices->len == 0) {
    return FL_METHOD_RESPONSE(fl_method_error_response_new(
        "UNAVAILABLE", "Device does not have a battery.", nullptr));
  }

  UpDevice* device = UP_DEVICE(g_ptr_array_index(devices, 0));
  double percentage = 0;
  g_object_get(device, "percentage", &percentage, nullptr);

  g_autoptr(FlValue) result =
      fl_value_new_int(static_cast<int64_t>(round(percentage)));
  return FL_METHOD_RESPONSE(fl_method_success_response_new(result));
}

最后，添加前面 fl_method_channel_set_method_call_handler 调用中引用的 battery_method_call_handler 函数。您需要处理一个平台方法 getBatteryLevel，因此在 method_call 参数中对其进行测试。此函数的实现调用上一步中编写的 Linux 代码。如果调用了未知方法，则报告该方法。

在 get_battery_level 函数之后添加以下代码。

static void battery_method_call_handler(FlMethodChannel* channel,
                                        FlMethodCall* method_call,
                                        gpointer user_data) {
  g_autoptr(FlMethodResponse) response = nullptr;
  if (strcmp(fl_method_call_get_name(method_call), "getBatteryLevel") == 0) {
    response = get_battery_level();
  } else {
    response = FL_METHOD_RESPONSE(fl_method_not_implemented_response_new());
  }

  g_autoptr(GError) error = nullptr;
  if (!fl_method_call_respond(method_call, response, &error)) {
    g_warning("Failed to send response: %s", error->message);
  }
}

您现在应该能够在 Linux 上运行该应用程序了。如果您的设备没有电池，它会显示“电池电量不可用”。

前面的示例使用 MethodChannel 在宿主和客户端之间进行通信，这并不是类型安全的。调用和接收消息取决于宿主和客户端是否声明了相同参数和数据类型，以使消息能够正常工作。您可以使用 Pigeon 包作为 MethodChannel 的替代方案，以生成以结构化、类型安全的方式发送消息的代码。

使用 Pigeon，消息传递协议在 Dart 的一个子集中定义，然后为 Android、iOS、macOS 或 Windows 生成消息传递代码。您可以在 pub.dev 上的 pigeon 页面上找到更完整的示例和更多信息。

使用 Pigeon 可以避免在宿主和客户端之间匹配消息名称和数据类型的字符串。它支持：嵌套类、将消息分组到 API 中、生成异步包装器代码以及双向发送消息。生成的代码可读性强，并保证多个不同版本的客户端之间不会发生冲突。支持的语言包括 Objective-C、Java、Kotlin、C++ 和 Swift（与 Objective-C 互操作）。

Pigeon 文件

import 'package:pigeon/pigeon.dart';

class SearchRequest {
  final String query;

  SearchRequest({required this.query});
}

class SearchReply {
  final String result;

  SearchReply({required this.result});
}

@HostApi()
abstract class Api {
  @async
  SearchReply search(SearchRequest request);
}

Dart 使用

import 'generated_pigeon.dart';

Future<void> onClick() async {
  SearchRequest request = SearchRequest(query: 'test');
  Api api = SomeApi();
  SearchReply reply = await api.search(request);
  print('reply: ${reply.result}');
}

如果您希望在多个 Flutter 应用中使用平台特定的代码，可以考虑将代码分离到主应用程序目录之外的平台插件中。有关详细信息，请参阅 开发插件。

要与 Flutter 生态系统中的其他开发人员共享您的平台特定代码，请参阅 发布插件。

除了上面提到的 MethodChannel 之外，您还可以使用更基本的 BasicMessageChannel，它支持使用自定义消息编解码器进行基本的异步消息传递。您还可以使用专门的 BinaryCodec、StringCodec 和 JSONMessageCodec 类，或创建您自己的编解码器。

您还可以查看 cloud_firestore 插件中的自定义编解码器示例，该插件能够序列化和反序列化比默认类型更多的类型。

在平台端调用目标为 Flutter 的通道时，请在平台的主线程上调用它们。在 Flutter 中调用目标为平台端的通道时，请从任何作为根隔离区的隔离区或注册为根隔离区后台隔离区的隔离区调用它们。平台端处理程序可以在平台的主线程上执行，也可以在使用任务队列时在后台线程上执行。您可以异步地在任何线程上调用平台端处理程序。

任何隔离区都可以使用插件和通道，但该隔离区必须是根隔离区（由 Flutter 创建）或注册为根隔离区的后台隔离区。

以下示例演示了如何注册后台隔离区以从后台隔离区使用插件。

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

void _isolateMain(RootIsolateToken rootIsolateToken) async {
  BackgroundIsolateBinaryMessenger.ensureInitialized(rootIsolateToken);
  SharedPreferences sharedPreferences = await SharedPreferences.getInstance();
  print(sharedPreferences.getBool('isDebug'));
}

void main() {
  RootIsolateToken rootIsolateToken = RootIsolateToken.instance!;
  Isolate.spawn(_isolateMain, rootIsolateToken);
}

为了使通道的平台端处理程序在后台线程上执行，必须使用任务队列 API。目前，此功能仅在 iOS 和 Android 上受支持。

在 Kotlin 中

override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
  val taskQueue =
      flutterPluginBinding.binaryMessenger.makeBackgroundTaskQueue()
  channel = MethodChannel(flutterPluginBinding.binaryMessenger,
                          "com.example.foo",
                          StandardMethodCodec.INSTANCE,
                          taskQueue)
  channel.setMethodCallHandler(this)
}

在 Java 中

@Override
public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
  BinaryMessenger messenger = binding.getBinaryMessenger();
  BinaryMessenger.TaskQueue taskQueue =
      messenger.makeBackgroundTaskQueue();
  channel =
      new MethodChannel(
          messenger,
          "com.example.foo",
          StandardMethodCodec.INSTANCE,
          taskQueue);
  channel.setMethodCallHandler(this);
}

在 Swift 中

public static func register(with registrar: FlutterPluginRegistrar) {
  let taskQueue = registrar.messenger.makeBackgroundTaskQueue()
  let channel = FlutterMethodChannel(name: "com.example.foo",
                                     binaryMessenger: registrar.messenger(),
                                     codec: FlutterStandardMethodCodec.sharedInstance,
                                     taskQueue: taskQueue)
  let instance = MyPlugin()
  registrar.addMethodCallDelegate(instance, channel: channel)
}

在 Objective-C 中

+ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
  NSObject<FlutterTaskQueue>* taskQueue =
      [[registrar messenger] makeBackgroundTaskQueue];
  FlutterMethodChannel* channel =
      [FlutterMethodChannel methodChannelWithName:@"com.example.foo"
                                  binaryMessenger:[registrar messenger]
                                            codec:[FlutterStandardMethodCodec sharedInstance]
                                        taskQueue:taskQueue];
  MyPlugin* instance = [[MyPlugin alloc] init];
  [registrar addMethodCallDelegate:instance channel:channel];
}

为了符合通道的 UI 线程要求，您可能需要从后台线程跳转到 Android 的 UI 线程以执行通道方法。在 Android 中，您可以通过将 Runnable 发送到 Android 的 UI 线程 Looper 来实现此目的，这会导致 Runnable 在下一次机会时在主线程上执行。

在 Kotlin 中

Handler(Looper.getMainLooper()).post {
  // Call the desired channel message here.
}

在 Java 中

new Handler(Looper.getMainLooper()).post(new Runnable() {
  @Override
  public void run() {
    // Call the desired channel message here.
  }
});

为了符合通道的主线程要求，您可能需要从后台线程跳转到 iOS 的主线程以执行通道方法。您可以在 iOS 中通过在主 调度队列 上执行一个 块 来实现此目的。

在 Objective-C 中

dispatch_async(dispatch_get_main_queue(), ^{
  // Call the desired channel message here.
});

在 Swift 中

DispatchQueue.main.async {
  // Call the desired channel message here.
}

除非另有说明，否则本网站上的文档反映了 Flutter 的最新稳定版本。页面上次更新于 2024-09-26。 查看源代码 或 报告问题。