平臺檢視允許你在 Flutter 應用中嵌入原生檢視,這樣你就可以從 Dart 應用轉換、裁剪和調整原生檢視的不透明度。

例如,這允許您在 Flutter 應用中直接使用原生 Web 檢視。

macOS 使用混合合成,這意味著原生 NSView 會被新增到檢視層級結構中。

要在 macOS 上建立平臺檢視,請使用以下說明

在 Dart 側

#

在 Dart 端,建立一個 Widget 並新增 build 實現,如以下步驟所示

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

有關更多資訊,請檢視 AppKitView API 文件。

在平臺側

#

實現工廠和平臺檢視。NativeViewFactory 建立平臺檢視,平臺檢視提供對 NSView 的引用。例如,NativeView.swift

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

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 的圖形效能產生負面影響。