環境
Flutter 3.29
macOS Sequoia 15.4.1
Xcode 16.3
集成
Flutter
提供了camera
插件來拍照和錄視頻,它提供了一系列可用的相機,并使用特定的相機展示相機預覽、拍照、錄視頻。
添加依賴
- camera: 提供使用設備相機模塊的工具
- path_provider: 尋找存儲圖片的正確路徑
- path: 創建適配任何平臺的路徑
flutter pub add camera path_provider path
執行完成后iOS工程的GeneratedPluginRegistrant.m
文件會自動生成對應的集成代碼
#if __has_include(<camera_avfoundation/CameraPlugin.h>)
#import <camera_avfoundation/CameraPlugin.h>
#else
@import camera_avfoundation;
#endif#if __has_include(<path_provider_foundation/PathProviderPlugin.h>)
#import <path_provider_foundation/PathProviderPlugin.h>
#else
@import path_provider_foundation;
#endif
...[CameraPlugin registerWithRegistrar:[registry registrarForPlugin:@"CameraPlugin"]];[PathProviderPlugin registerWithRegistrar:[registry registrarForPlugin:@"PathProviderPlugin"]];
分析
[registry registrarForPlugin:@“CameraPlugin”]
在AppDelegate.swfit
的application(_:didFinishLaunchingWithOptions:)
中將FlutterAppDelegate的子類AppDelegate對象作為參數傳入并調用該方法
GeneratedPluginRegistrant.register(with: self)
源碼: FlutterAppDelegate.mm
- (NSObject<FlutterPluginRegistrar>*)registrarForPlugin:(NSString*)pluginKey {/// <1> 獲取應用的flutterRootViewController對象FlutterViewController* flutterRootViewController = [self rootFlutterViewController];if (flutterRootViewController) {/// <4> 返回一個FlutterEngine對象return [[flutterRootViewController pluginRegistry] registrarForPlugin:pluginKey];}return nil;
}// Returns the key window's rootViewController, if it's a FlutterViewController.
// Otherwise, returns nil.
- (FlutterViewController*)rootFlutterViewController {///- (FlutterViewController*(^ rootFlutterViewControllerGetter) (void))/// <2> 檢查是否有外部注入,有則使用自定義的回調獲取FlutterViewController對象if (_rootFlutterViewControllerGetter != nil) {return _rootFlutterViewControllerGetter();}/// <3> 沒有則檢查window的rootViewController屬性,如果是FlutterViewController則返回,否則返回nilUIViewController* rootViewController = _window.rootViewController;if ([rootViewController isKindOfClass:[FlutterViewController class]]) {return (FlutterViewController*)rootViewController;}return nil;
}
[flutterRootViewController pluginRegistry]
第<4>步中的方法調用在 FlutterViewController.mm
/// pluginRegistry方法獲得一個遵守FlutterPluginRegistry協議的對象
- (id<FlutterPluginRegistry>)pluginRegistry {return self.engine;
}
.../// engine是FlutterEngine對象
- (void)sharedSetupWithProject:(nullable FlutterDartProject*)projectinitialRoute:(nullable NSString*)initialRoute {
...
engine = [[FlutterEngine alloc] initWithName:@"io.flutter"project:projectallowHeadlessExecution:self.engineAllowHeadlessExecutionrestorationEnabled:self.restorationIdentifier != nil];
...
_engine = engine;
... - (instancetype)initWithEngine:(FlutterEngine*)enginenibName:(nullable NSString*)nibNamebundle:(nullable NSBundle*)nibBundle {
...
_engine = engine;
FlutterPluginRegistry
協議的繼承結構
FlutterEngine
對象調用registrarForPlugin:
方法
源碼: FlutterEngine.mm
/// 文件: FlutterEngine.mm
...
/*** All registrars returned from registrarForPlugin:*/
@property(nonatomic, readonly)NSMutableDictionary<NSString*, FlutterEngineRegistrar*>* pluginRegistrars;
...- (id<FlutterPluginRegistrar>)registrarForPlugin:(NSString*)pluginName {/// <5> 檢查可變字典中是否已存在插件名的keyid<FlutterPluginRegistrar> registrar = self.pluginRegistrars[pluginName];if (!registrar) {/// <6> 首次注冊,生成FlutterEngineRegistrar對象并持有pluginName和弱引用FlutterEngine 對象/// 為什么是弱引用?/// 文件:FlutterViewController.m 強引入了FlutterEngine對象/// @property(nonatomic, readonly) FlutterEngine* engine;FlutterEngineRegistrar* registrarImpl =[[FlutterEngineRegistrar alloc] initWithPlugin:pluginName flutterEngine:self];/// 接收傳入的pluginName + self即FlutterEngine對象/// @interface FlutterEngineRegistrar : NSObject <FlutterPluginRegistrar>/// @property(nonatomic, weak) FlutterEngine* flutterEngine;/// @implementation FlutterEngineRegistrar {/// NSString* _pluginKey;/// }/// 因為FlutterViewController.m 已經強引入了FlutterEngine對象,所以這里的flutterEngine弱引用即可/// @property(nonatomic, readonly) FlutterEngine* engine;/// /// <7> 添加到FlutterEngine對象的可變字典中self.pluginRegistrars[pluginName] = registrarImpl;registrar = registrarImpl;}/// <8> 返回FlutterEngineRegistrar注冊對象,其中保存FlutterEngine相關的信息,負責與Flutter的iOS插件交互return registrar;
}
[CameraPlugin registerWithRegistrar:
registrar]
/// camera插件的類定義
public final class CameraPlugin: NSObject, FlutterPlugin {
@protocol FlutterPlugin <NSObject, FlutterApplicationLifeCycleDelegate>
@required
+ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar;
Flutter中的iOS插件遵守FlutterPlugin
協議且必須實現+registerWithRegistrar:
方法
以camera插件為例,CameraPlugin.swift是對外的Swift的接口包裝
public static func register(with registrar: FlutterPluginRegistrar) {let instance = CameraPlugin(/// 文件: FlutterEngine.mm/// <9> 從FlutterEngineRegistrar對象中獲取紋理的對象/// - (NSObject<FlutterTextureRegistry>*)textures {/// return _flutterEngine.textureRegistry;/// }registry: registrar.textures(),/// Returns a `FlutterBinaryMessenger` for creating Dart/iOS communication/// channels to be used by the plugin./// <10> 從FlutterEngineRegistrar返回Dart與iOS原生消息的對象messenger: registrar.messenger(),globalAPI: FCPCameraGlobalEventApi(binaryMessenger: registrar.messenger()),deviceDiscoverer: FLTDefaultCameraDeviceDiscoverer(),permissionManager: FLTCameraPermissionManager(permissionService: FLTDefaultPermissionService()),deviceFactory: { name in// TODO(RobertOdrowaz) Implement better error handling and remove non-null assertionFLTDefaultCaptureDevice(device: AVCaptureDevice(uniqueID: name)!)},captureSessionFactory: { FLTDefaultCaptureSession(captureSession: AVCaptureSession()) },captureDeviceInputFactory: FLTDefaultCaptureDeviceInputFactory(),captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue"))/// <11>設置Dart相機API的消息通道SetUpFCPCameraApi(registrar.messenger(), instance)}
registrar.messenger()
從前面可知registrar
是一個FlutterEngineRegistrar
/// 文件: FlutterEngine.mm
@implementation FlutterEngineRegistrar {
...
- (NSObject<FlutterBinaryMessenger>*)messenger {/// 返回的是FlutterEngineRegistrar對象綁定的FlutterEngine中的binaryMessenger屬性return _flutterEngine.binaryMessenger;
}
...@implementation FlutterEngine {
...
FlutterBinaryMessengerRelay* _binaryMessenger;
.../// FlutterEngine對象中的binaryMessenger屬性是FlutterBinaryMessengerRelay對象
/// 且parent屬性關聯的是FlutterEngine對象
_binaryMessenger = [[FlutterBinaryMessengerRelay alloc] initWithParent:self];
SetUpFCPCameraApi(registrar.messenger(), instance)
代碼執行進入文件 message.g.m
void SetUpFCPCameraApiWithSuffix(id<FlutterBinaryMessenger> binaryMessenger,NSObject<FCPCameraApi> *api, NSString *messageChannelSuffix) {messageChannelSuffix = messageChannelSuffix.length > 0? [NSString stringWithFormat:@".%@", messageChannelSuffix]: @"";/// Returns the list of available cameras./// 建立設備的相機可用列表API{FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]initWithName:[NSString stringWithFormat:@"%@%@",@"dev.flutter.pigeon.camera_avfoundation."@"CameraApi.getAvailableCameras",messageChannelSuffix]binaryMessenger:binaryMessengercodec:FCPGetMessagesCodec()];if (api) {NSCAssert([api respondsToSelector:@selector(availableCamerasWithCompletion:)],@"FCPCameraApi api (%@) doesn't respond to @selector(availableCamerasWithCompletion:)",api);[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) {[api availableCamerasWithCompletion:^(NSArray<FCPPlatformCameraDescription *> *_Nullable output,FlutterError *_Nullable error) {callback(wrapResult(output, error));}];}];} else {[channel setMessageHandler:nil];}}.../// 綁定一系列相機操作的API
FlutterBasicMessageChannel
類在FlutterChannel.m
中,先初始化一個FlutterBasicMessageChannel
對象,實現上只是接收外界參數
- (instancetype)initWithName:(NSString*)namebinaryMessenger:(NSObject<FlutterBinaryMessenger>*)messengercodec:(NSObject<FlutterMessageCodec>*)codectaskQueue:(NSObject<FlutterTaskQueue>*)taskQueue {self = [super init];NSAssert(self, @"Super init cannot be nil");_name = [name copy];_messenger = messenger;_codec = codec;_taskQueue = taskQueue;return self;
}
[channel setMessageHandler:^(id _Nullable message, FlutterReply callback) ...];
接著判斷入參的api
是否不為空,api
是生成的CameraPlugin
對象,所以不為空,然后消息的回調
- (void)setMessageHandler:(FlutterMessageHandler)handler {/// 未自定義回調時,這里應該是多次調用則清空上一次的,然后再重新創建if (!handler) {if (_connection > 0) {[_messenger cleanUpConnection:_connection];_connection = 0;} else {[_messenger setMessageHandlerOnChannel:_name binaryMessageHandler:nil];}return;}// Grab reference to avoid retain on self.// `self` might be released before the block, so the block needs to retain the codec to// make sure it is not released with `self`/// 從前面的代碼可以知道這個self即channel對象只有一個局部對象在持有,所以超過作用域會被回收,所以這里接收到codecNSObject<FlutterMessageCodec>* codec = _codec;FlutterBinaryMessageHandler messageHandler = ^(NSData* message, FlutterBinaryReply callback) {handler([codec decode:message], ^(id reply) {callback([codec encode:reply]);});};_connection = SetMessageHandler(_messenger, _name, messageHandler, _taskQueue);
}
static FlutterBinaryMessengerConnection SetMessageHandler(NSObject<FlutterBinaryMessenger>* messenger,NSString* name,FlutterBinaryMessageHandler handler,NSObject<FlutterTaskQueue>* taskQueue) {/// 是否要在指定的任務隊列上執行/// name在這里是 dev.flutter.pigeon.camera_avfoundation.CameraApi.getAvailableCameras.../// handler是設置的回調/// 發送給FlutterBinaryMessengerRelay對象if (taskQueue) {NSCAssert([messenger respondsToSelector:@selector(setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:)],@"");return [messenger setMessageHandlerOnChannel:namebinaryMessageHandler:handlertaskQueue:taskQueue];} else {return [messenger setMessageHandlerOnChannel:name binaryMessageHandler:handler];}
}
進入到FlutterBinaryMessengerRelay
對象的setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:
文件: FlutterBinaryMessengerRelay.mm
- (FlutterBinaryMessengerConnection)setMessageHandlerOnChannel:(NSString*)channelbinaryMessageHandler:(FlutterBinaryMessageHandler)handlertaskQueue:(NSObject<FlutterTaskQueue>*)taskQueue {/// parent就是engine對象,因此又回到engine上setMessageHandlerOnChannel:binaryMessageHandler: taskQueue:if (self.parent) {return [self.parent setMessageHandlerOnChannel:channelbinaryMessageHandler:handlertaskQueue:taskQueue];} else {FML_LOG(WARNING) << "Communicating on a dead channel.";return -1;}
}
文件: FlutterEngine.mm
- (FlutterBinaryMessengerConnection)setMessageHandlerOnChannel:(NSString*)channelbinaryMessageHandler:(FlutterBinaryMessageHandler)handlertaskQueue:(NSObject<FlutterTaskQueue>* _Nullable)taskQueue {NSParameterAssert(channel);if (_shell && _shell->IsSetup()) {/// 獲取原生平臺的線程,并傳入channel名,回調,任務隊列self.platformView->GetPlatformMessageHandlerIos()->SetMessageHandler(channel.UTF8String,handler, taskQueue);/// std::unique_ptr<flutter::ConnectionCollection> _connections;/// /// 文件:connection_collection.mm/// ConnectionCollection::Connection ConnectionCollection::AquireConnection(const std::string& name) {/// Connection nextConnection = ++counter_;/// connections_[name] = nextConnection;/// return nextConnection;/// }/// FlutterEngine對象中的連接集合屬性,AcquireConnection方法讓connections字典中key為channel的計數加1return _connections->AquireConnection(channel.UTF8String);} else {NSAssert(!handler, @"Setting a message handler before the FlutterEngine has been run.");// Setting a handler to nil for a channel that has not yet been set up is a no-op.return flutter::ConnectionCollection::MakeErrorConnection(-1);}
}
文件: platform_view_ios.h
/// 調用GetPlatformMessageHandlerIos即返回platform_message_handler_屬性
class PlatformViewIOS final : public PlatformView {
...
std::shared_ptr<PlatformMessageHandlerIos> GetPlatformMessageHandlerIos() const {return platform_message_handler_;}
...
文件: platform_view_ios.mm
PlatformViewIOS::PlatformViewIOS(PlatformView::Delegate& delegate,const std::shared_ptr<IOSContext>& context,__weak FlutterPlatformViewsController* platform_views_controller,const flutter::TaskRunners& task_runners): PlatformView(delegate, task_runners),ios_context_(context),platform_views_controller_(platform_views_controller),accessibility_bridge_([this](bool enabled) { PlatformView::SetSemanticsEnabled(enabled); }),/// 從初始化列表中可以看出platform_message_handler_的值通過GetPlatformTaskRunner獲取UI的主線程platform_message_handler_(new PlatformMessageHandlerIos(task_runners.GetPlatformTaskRunner())) {}
到這里Flutter的插件的原生代碼部分已經將channel
,回調,執行隊列(可選)給原生平臺的主線程。
獲取可用相機列表
/// Dart端調用獲取可用攝像頭列表
final cameras = await availableCameras();
文件: camera_controller.dart
/// Completes with a list of available cameras.
///
/// May throw a [CameraException].
Future<List<CameraDescription>> availableCameras() async {return CameraPlatform.instance.availableCameras();
}
調用CameraPlatform
對象的availableCameras
方法
文件: camera_platform.dart
abstract class CameraPlatform extends PlatformInterface {/// Constructs a CameraPlatform.CameraPlatform() : super(token: _token);.../// Completes with a list of available cameras.////// This method returns an empty list when no cameras are available.Future<List<CameraDescription>> availableCameras() {throw UnimplementedError('availableCameras() is not implemented.');}
CameraPlatform
是個抽象類,要找具體的實現。找到camera插件的pubspec.yaml
flutter:plugin:implements: cameraplatforms:ios:pluginClass: CameraPlugindartPluginClass: AVFoundationCamera
dartPluginClass: Optional. The Dart class that serves as the entry point for a Flutter plugin. This can be used with the Android, iOS, Linux macOS, and Windows platforms.
因此camera
插件dart
的入口應該是AVFoundationCamera
這個類,它繼承了上面的CameraPlatform
抽象類
文件: avfoundation_camera.dart
class AVFoundationCamera extends CameraPlatform {/// Creates a new AVFoundation-based [CameraPlatform] implementation instance.AVFoundationCamera({ CameraApi? api}): _hostApi = api ?? CameraApi();...Future<List<CameraDescription>> availableCameras() async {try {return (await _hostApi.getAvailableCameras()).map(cameraDescriptionFromPlatform).toList();} on PlatformException catch (e) {throw CameraException(e.code, e.message);}}
從上面代碼可知實際調用的是_hostApi
的getAvailableCameras
方法
Future<List<PlatformCameraDescription>> getAvailableCameras() async {/// 前面建立channel時已經傳入了,這樣原生執行完相關方法后能通過channel調用對應的回調final String pigeonVar_channelName ='dev.flutter.pigeon.camera_avfoundation.CameraApi.getAvailableCameras$pigeonVar_messageChannelSuffix';/// A named channel for communicating with platform plugins using asynchronous message passing./// 創建異步消息final BasicMessageChannel<Object?> pigeonVar_channel =BasicMessageChannel<Object?>(pigeonVar_channelName,pigeonChannelCodec,binaryMessenger: pigeonVar_binaryMessenger,);/// 阻塞**發送消息**final List<Object?>? pigeonVar_replyList =await pigeonVar_channel.send(null) as List<Object?>?;/// 消息為空拋異常if (pigeonVar_replyList == null) {throw _createConnectionError(pigeonVar_channelName);} else if (pigeonVar_replyList.length > 1) {throw PlatformException(code: pigeonVar_replyList[0]! as String,message: pigeonVar_replyList[1] as String?,details: pigeonVar_replyList[2],);} else if (pigeonVar_replyList[0] == null) {throw PlatformException(code: 'null-error',message: 'Host platform returned null value for non-null return value.',);} else {/// 得到可用列表轉換為Flutter上的攝像頭描述的對象return (pigeonVar_replyList[0] as List<Object?>?)!.cast<PlatformCameraDescription>();}}
await pigeonVar_channel.send(null) as List<Object?>?;
/// Sends the specified [message] to the platform plugins on this channel.////// Returns a [Future] which completes to the received response, which may/// be null.Future<T?> send(T message) async {/// 調用binaryMessenger對象編碼發送消息 && 得到返回后再解碼return codec.decodeMessage(await binaryMessenger.send(name, codec.encodeMessage(message)));}
Flutter Dart端發送指定channel消息 && 調用原來添加的回調走到Flutter原生插件部分這里,比如當前走到獲取可用攝像頭的回調
...
[api availableCamerasWithCompletion:^(NSArray<FCPPlatformCameraDescription *> *_Nullable output,FlutterError *_Nullable error) {callback(wrapResult(output, error));}];
即調用api(CameraPlugin)的availableCamerasWithCompletion:方法
extension CameraPlugin: FCPCameraApi {public func availableCameras(completion: @escaping ([FCPPlatformCameraDescription]?, FlutterError?) -> Void) {captureSessionQueue.async { [weak self] inguard let strongSelf = self else { return }var discoveryDevices: [AVCaptureDevice.DeviceType] = [.builtInWideAngleCamera,.builtInTelephotoCamera,].../// 前置,后置等攝像頭,然后統一添加到reply這個數組對象for device in devices {var lensFacing: FCPPlatformCameraLensDirectionswitch device.position {case .back:lensFacing = .backcase .front:lensFacing = .frontcase .unspecified:...}reply.append(cameraDescription)}/// 最后執行callback(wrapResult(output, error));/// 獲取成功后,Flutter的Dart部分可以獲取到可用的攝像頭列表completion(reply, nil)
}
總結
- 原生插件將方法的channel(約定的字符串),回調設置給Flutter原生平臺代碼(C++ && OC)
- Flutter的Dart層發送消息并傳遞channel,Flutter根據channel找到設置的回調(Dart -> C++ && OC),然后執行原生插件提供的方法(C++ && OC)
- 獲取執行結果并返回給Flutter的原生平臺代碼(C++ && OC),再發送給Dart代碼(C++ && OC -> Dart)
參考
- camera
- 使用 Camera 插件實現拍照功能
- do-not-use-buildcontexts-across-async-gaps
- Flutter pubspec options
- 一張圖理解Flutter中Dart與原生環境通信