跳至主要内容
内容

使用平台视图在 Flutter 应用中托管原生 macOS 视图

内容

平台视图允许您在 Flutter 应用中嵌入原生视图，以便您可以从 Dart 应用转换、剪辑和不透明度到原生视图。

例如，这允许您直接在 Flutter 应用中使用原生 Web 视图。

macOS 使用混合合成，这意味着原生 NSView 会附加到视图层次结构中。

要在 macOS 上创建平台视图，请使用以下说明

Dart 端

#

在 Dart 端，创建一个 Widget 并添加构建实现，如下所示。

在 Dart 组件文件中，进行类似于 native_view_example.dart 中所示的更改

  1. 添加以下导入

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

  2. 实现 build() 方法

    dart
    Widget build(BuildContext context) {
  // This is used in the platform side to register the view.
  const String viewType = '<platform-view-type>';
  // Pass parameters to the platform side.
  final Map<String, dynamic> creationParams = <String, dynamic>{};

  return AppKitView(
    viewType: viewType,
    layoutDirection: TextDirection.ltr,
    creationParams: creationParams,
    creationParamsCodec: const StandardMessageCodec(),
  );
}

有关更多信息，请参阅以下 API 文档：AppKitView。

平台端

#

实现工厂和平台视图。NativeViewFactory 创建平台视图，平台视图提供对 NSView 的引用。例如，NativeView.swift

swift
import Cocoa
import FlutterMacOS

class NativeViewFactory: NSObject, FlutterPlatformViewFactory {
  private var messenger: FlutterBinaryMessenger

  init(messenger: FlutterBinaryMessenger) {
    self.messenger = messenger
    super.init()
  }

  func create(
    withViewIdentifier viewId: Int64,
    arguments args: Any?
  ) -> NSView {
    return NativeView(
      viewIdentifier: viewId,
      arguments: args,
      binaryMessenger: messenger)
  }

  /// Implementing this method is only necessary when the `arguments` in `createWithFrame` is not `nil`.
  public func createArgsCodec() -> (FlutterMessageCodec & NSObjectProtocol)? {
    return FlutterStandardMessageCodec.sharedInstance()
  }
}

class NativeView: NSView {

  init(
    viewIdentifier viewId: Int64,
    arguments args: Any?,
    binaryMessenger messenger: FlutterBinaryMessenger?
  ) {
    super.init(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
    wantsLayer = true
    layer?.backgroundColor = NSColor.systemBlue.cgColor
    // macOS views can be created here
    createNativeView(view: self)
  }
    
    required init?(coder nsCoder: NSCoder) {
        super.init(coder: nsCoder)
    }
    
  func createNativeView(view _view: NSView) {
    let nativeLabel = NSTextField()
    nativeLabel.frame = CGRect(x: 0, y: 0, width: 180, height: 48.0)
    nativeLabel.stringValue = "Native text from macOS"
    nativeLabel.textColor = NSColor.black
    nativeLabel.font = NSFont.systemFont(ofSize: 14)
    nativeLabel.isBezeled = false
    nativeLabel.focusRingType = .none
    nativeLabel.isEditable = true
    nativeLabel.sizeToFit()
    _view.addSubview(nativeLabel)
  }
}

最后，注册平台视图。这可以在应用或插件中完成。

对于应用注册，修改应用的 MainFlutterWindow.swift

swift
import Cocoa
import FlutterMacOS

class MainFlutterWindow: NSWindow {
  override func awakeFromNib() {
    // ...

    let registrar = flutterViewController.registrar(forPlugin: "plugin-name")
    let factory = NativeViewFactory(messenger: registrar.messenger)
    registrar.register(
      factory,
      withId: "<platform-view-type>")
  }
}

对于插件注册，修改插件的主文件（例如，Plugin.swift）

swift
import Cocoa
import FlutterMacOS

public class Plugin: NSObject, FlutterPlugin {
  public static func register(with registrar: FlutterPluginRegistrar) {
    let factory = NativeViewFactory(messenger: registrar.messenger)
    registrar.register(factory, withId: "<platform-view-type>")
  }
}

有关更多信息，请参阅以下 API 文档

整合

#

在 Dart 中实现 build() 方法时，您可以使用 defaultTargetPlatform 检测平台，并决定使用哪个组件

dart
Widget build(BuildContext context) {
  // This is used in the platform side to register the view.
  const String viewType = '<platform-view-type>';
  // Pass parameters to the platform side.
  final Map<String, dynamic> creationParams = <String, dynamic>{};

  switch (defaultTargetPlatform) {
    case TargetPlatform.android:
    // return widget on Android.
    case TargetPlatform.iOS:
    // return widget on iOS.
    case TargetPlatform.macOS:
    // return widget on macOS.
    default:
      throw UnsupportedError('Unsupported platform view');
  }
}

性能

#

Flutter 中的平台视图存在性能权衡。

例如，在典型的 Flutter 应用中，Flutter UI 在专用的光栅线程上合成。这使得 Flutter 应用能够快速运行，因为此线程很少被阻塞。

当使用混合合成渲染平台视图时，Flutter UI 继续从专用的光栅线程合成，但平台视图在平台线程上执行图形操作。为了光栅化组合内容，Flutter 在其光栅线程和平台线程之间执行同步。因此，平台线程上的任何缓慢或阻塞操作都会对 Flutter 图形性能产生负面影响。

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