iOS Native混編Flutter互動實踐

HansRove發表於2018-09-30

開篇

圖形效能對比.jpg

開局一張圖,其他全靠_?

目前flutter框架還比較新,又是谷歌家的東西,所以網上的文章基本都是講安卓和flutter混合開發的,沒有iOS和Flutter混合開發的比較詳細的步驟實操。

混編的前提是你的電腦必須有flutter環境,不會配的請先谷歌教程配置完後再來檢視此混編教程。

正題

因為本文要講的是iOS,所以正常情況下的環境是macOS + Xcode + flutter環境(v0.8.2-beta);再加上flutter 需要的的dart語言編輯器 Android Studio 、IntelliJ IDEA 或 Visual Studio Code (VS Code) ;因為flutter是多平臺,所以也要安裝安卓相關的SDK。

本教程是基於flutter環境版本v0.8.2-beta

環境配好後,命令列輸入:flutter doctor -v , 確保FlutterAndroid toolchainiOS toolchainConnected devices (連線中的裝置,這個列表是你開啟你Xcode虛擬機器或者安卓虛擬機器的時候才會有) 都不是[✗]這個符號,則說明你的環境OK了 【也要注意編輯器的flutter環境】

flutter doctor.png

Xcode工程專案配置

Xcode專案的開始

最權威的教程當然是flutter自家的混編wiki,iOS部分我英文理解能力不是很好,實際操作的時候也按照教程操作了一遍,再和網上教程總結了一遍,一路踏坑而出。

  • Flutter混合開發還不支援bit code,所以在iOS工程檢查專案並關閉bit code

關閉專案bitcode.png

  • flutter module建立 (不要耦合近Xcode專案中,最好放到與專案目錄同級)

這裡因為使用的是flutter環境(v0.8.2-beta),應該也是很新的分支。看網上說明flutter的master才是最新的分支。先用beta建立module,如果建立不成功再切換master分支進行建立

create flutter module.png

目錄結構.png

如果建立不成功,請切換master分支試一下;執行flutter channel master

  • flutter module 重要檔案分析 (部分是隱藏檔案,記得檢視全部)

flutter module檔案分析.png

flutter內部檔案分析.png

  • 建立Xcode專案中的Config檔案,引向flutter module

    新建Config目錄,管理Xcode工程的配置銜接檔案,分別建立 Flutter.xcconfigDebug.xcconfigRelease.xcconfig 三個配置檔案;其中Flutter.xcconfig 是指向外目錄flutter module的Generated.xcconfig 檔案路徑引用檔案,其他兩個代表Xcode的環境配置檔案。

新建膠水配置檔案.png

  • 三個檔案的引入內容 (所引用的都是絕對路徑,最終都是指引到Generated.xcconfig

In Flutter.xcconfig:

#include "../../flutter_module/.ios/Flutter/Generated.xcconfig"
ENABLE_BITCODE=NO
複製程式碼

In Debug.xcconfig:

#include "Flutter.xcconfig"
複製程式碼

In Release.xcconfig:

#include "Flutter.xcconfig"
FLUTTER_BUILD_MODE=release
複製程式碼

這裡有個值得注意的地方,如果你是使用的pod管理你的專案,則Debug.xcconfigRelease.xcconfig 都需要新增一行pod的引用

  • Xcode project環境配置選擇

Xcode 專案配置選擇.png

  • 最重要: 引入xcode-backend.sh

在iOS工程裡新增執行指令碼 "$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build,並且確保Run Script這一行在"Target dependencies" 或者 "Check Pods Manifest.lock"後面。

引入xcode-backend.png

此時點選Xcode的執行,會執行到xcode-backend.sh指令碼;此時在iOS工程目錄,也會生成一個Flutter資料夾,裡面是Flutter工程的產物(這個就是flutter最終與Native互動的產物)

  • 新增flutter編譯產物

右鍵專案 - Add Files to 'xxx' 【Options先選Create groups】,選擇Flutter目錄

新增flutter編譯產物.png

但是flutter_assets 並不能使用Create groups 的方式新增,只能使用Creat folder references 的方式新增進Xcode專案內,否則跳轉flutter會頁面渲染失敗(頁面空白)。

flutter_assets特殊處理1.png
應該刪除flutter_assets,資料夾再Add Files to 'xxx',選擇Creat folder references ;最終如下圖

flutter_assets特殊處理.png

將iOS工程目錄下的Flutter資料夾新增到工程,然後確保資料夾下的兩個framework新增到Embeded Binaries

flutter framework引入.png

至此,Xcode與Flutter之間混編配置完成,兩個專案檔案已經關聯上了。這時候你就可以修改main.dart 檔案內容,重新編譯執行Xcode 則APP.framework自動會被編譯成最新的flutter程式碼。

專案中使用pod管理情況

一、舊專案沒使用pod管理,混編後又想pod管理

  • 1、先刪除Xcode工程專案中的Run Script
  • 2、pod init
  • 3、在生成的pod file檔案寫你要增加的第三方框架,如pod 'AFNetworking’
  • 4、pod install
  • 5、(使用.xcworkspace開啟專案)重新配置Run Script
  • 6、修改Debug.xcconfigRelease。xcconfig 都需要增加一行pod config檔案引用:(自己檢視自己的Pods目錄檔案路徑, release就使用.release.xcconfig)
#include "Flutter.xcconfig"
// 下面為pod引入需要增加的一行
#include "Pods/Target Support Files/Pods-iOSBridgeFlutterDemo/Pods-iOSBridgeFlutterDemo.debug.xcconfig"
複製程式碼
  • 7、專案重新編譯,Success

二、如果舊專案已經使用pod管理

  • 如果專案ignore Pods資料夾, 則走一方法中的1、4、5、6、7步驟
  • 如果專案Pods資料夾存在,則走一方法中的6、7步驟

PS: 每次pod update或者pod install都會報錯,因為Run Script的原因,所以每次新增或更新pod都得刪除Run Script更新pod再新增回Run Script(1、4、6、7步驟);這些繁瑣的操作不知道有沒有辦法避免,知道的朋友可以回覆一下?不吝賜教,謝謝!

Xcode 與 Flutter 互動

AppDelegate 改造

改造AppDelegate.h,使其繼承FlutterAppDelegate:

#import <Flutter/Flutter.h>

@interface AppDelegate : FlutterAppDelegate <UIApplicationDelegate, FlutterAppLifeCycleProvider>

@end
複製程式碼

改造AppDelegate.m

#import "AppDelegate.h"

@interface AppDelegate ()
    
@end

@implementation AppDelegate
{
  FlutterPluginAppLifeCycleDelegate *_lifeCycleDelegate;
}
    
- (instancetype)init {
    if (self = [super init]) {
        _lifeCycleDelegate = [[FlutterPluginAppLifeCycleDelegate alloc] init];
    }
    return self;
}
    
- (BOOL)application:(UIApplication*)application
didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    return [_lifeCycleDelegate application:application didFinishLaunchingWithOptions:launchOptions];
}
    
- (void)applicationDidEnterBackground:(UIApplication*)application {
    [_lifeCycleDelegate applicationDidEnterBackground:application];
}
    
- (void)applicationWillEnterForeground:(UIApplication*)application {
    [_lifeCycleDelegate applicationWillEnterForeground:application];
}
    
- (void)applicationWillResignActive:(UIApplication*)application {
    [_lifeCycleDelegate applicationWillResignActive:application];
}
    
- (void)applicationDidBecomeActive:(UIApplication*)application {
    [_lifeCycleDelegate applicationDidBecomeActive:application];
}
    
- (void)applicationWillTerminate:(UIApplication*)application {
    [_lifeCycleDelegate applicationWillTerminate:application];
}
    
- (void)application:(UIApplication*)application
didRegisterUserNotificationSettings:(UIUserNotificationSettings*)notificationSettings {
    [_lifeCycleDelegate application:application
didRegisterUserNotificationSettings:notificationSettings];
}
    
- (void)application:(UIApplication*)application
didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)deviceToken {
    [_lifeCycleDelegate application:application
didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}
    
- (void)application:(UIApplication*)application
didReceiveRemoteNotification:(NSDictionary*)userInfo
fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
    [_lifeCycleDelegate application:application
       didReceiveRemoteNotification:userInfo
             fetchCompletionHandler:completionHandler];
}
    
- (BOOL)application:(UIApplication*)application
            openURL:(NSURL*)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options {
    return [_lifeCycleDelegate application:application openURL:url options:options];
}
    
- (BOOL)application:(UIApplication*)application handleOpenURL:(NSURL*)url {
    return [_lifeCycleDelegate application:application handleOpenURL:url];
}
    
- (BOOL)application:(UIApplication*)application
            openURL:(NSURL*)url
  sourceApplication:(NSString*)sourceApplication
         annotation:(id)annotation {
    return [_lifeCycleDelegate application:application
                                   openURL:url
                         sourceApplication:sourceApplication
                                annotation:annotation];
}
    
- (void)application:(UIApplication*)application
performActionForShortcutItem:(UIApplicationShortcutItem*)shortcutItem
  completionHandler:(void (^)(BOOL succeeded))completionHandler NS_AVAILABLE_IOS(9_0) {
    [_lifeCycleDelegate application:application
       performActionForShortcutItem:shortcutItem
                  completionHandler:completionHandler];
}
    
- (void)application:(UIApplication*)application
handleEventsForBackgroundURLSession:(nonnull NSString*)identifier
  completionHandler:(nonnull void (^)(void))completionHandler {
    [_lifeCycleDelegate application:application
handleEventsForBackgroundURLSession:identifier
                  completionHandler:completionHandler];
}
    
- (void)application:(UIApplication*)application
performFetchWithCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler {
    [_lifeCycleDelegate application:application performFetchWithCompletionHandler:completionHandler];
}
    
- (void)addApplicationLifeCycleDelegate:(NSObject<FlutterPlugin>*)delegate {
    [_lifeCycleDelegate addDelegate:delegate];
}

#pragma mark - Flutter
    // Returns the key window's rootViewController, if it's a FlutterViewController.
    // Otherwise, returns nil.
- (FlutterViewController*)rootFlutterViewController {
    UIViewController* viewController = [UIApplication sharedApplication].keyWindow.rootViewController;
    if ([viewController isKindOfClass:[FlutterViewController class]]) {
        return (FlutterViewController*)viewController;
    }
    return nil;
}
    
- (void)touchesBegan:(NSSet*)touches withEvent:(UIEvent*)event {
    [super touchesBegan:touches withEvent:event];
    
    // Pass status bar taps to key window Flutter rootViewController.
    if (self.rootFlutterViewController != nil) {
        [self.rootFlutterViewController handleStatusBarTouches:event];
    }
}

@end

複製程式碼

Flutter主動,Native被動 (MethodChannel)

Flutter 程式碼: 引入import 'package:flutter/services.dart';

請用下面程式碼替換class _MyHomePageState extends State<MyHomePage> 這個類內容

class _MyHomePageState extends State<MyHomePage> {

  // 建立一個給native的channel (類似iOS的通知)
  static const methodChannel = const MethodChannel('com.pages.your/native_get');

  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;

      print('flutter的log列印:現在輸出count=$_counter');
      // 當個數累積到3的時候給客戶端發引數
      if(_counter == 3) {
        _toNativeSomethingAndGetInfo();
      }

      // 當個數累積到5的時候給客戶端發引數
      if(_counter == 1002) {
        Map<String, String> map = { "title": "這是一條來自flutter的引數" };
        methodChannel.invokeMethod('toNativePush',map);
      }

      // 當個數累積到8的時候給客戶端發引數
      if(_counter == 1005) {
        Map<String, dynamic> map = { "content": "flutterPop回來","data":[1,2,3,4,5]};
        methodChannel.invokeMethod('toNativePop',map);
      }
    });
  }

  // 給客戶端傳送一些東東 , 並且拿到一些東東
  Future<Null> _toNativeSomethingAndGetInfo() async {
    dynamic result;
    try {
      result = await methodChannel.invokeMethod('toNativeSomething','大佬你點選了$_counter下');
    } on PlatformException {
      result = 100000;
    }
    setState(() {
      // 型別判斷
      if (result is int) {
        _counter = result;
      }

    });
  }

  @override
  Widget build(BuildContext context) {

    return new Scaffold(
//      appBar: new AppBar(
//        // Here we take the value from the MyHomePage object that was created by
//        // the App.build method, and use it to set our appbar title.
//        title: new Text(widget.title),
//      ),
      body: new Center(
        child: new Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            new Text(
              'You have pushed the button this many times:',
            ),
            new Text(
              '$_counter',
              style: Theme.of(context).textTheme.display1,
            ),
          ],
        ),
      ),
      floatingActionButton: new FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: new Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }
}

複製程式碼

Native 程式碼:

- (void)pushFlutterViewController {
        FlutterViewController* flutterViewController = [[FlutterViewController alloc] initWithProject:nil nibName:nil bundle:nil];
        flutterViewController.navigationItem.title = @"Flutter Demo";
            __weak __typeof(self) weakSelf = self;
        
        // 要與main.dart中一致
        NSString *channelName = @"com.pages.your/native_get";
        
            FlutterMethodChannel *messageChannel = [FlutterMethodChannel methodChannelWithName:channelName binaryMessenger:flutterViewController];
        
            [messageChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
                // call.method 獲取 flutter 給回到的方法名,要匹配到 channelName 對應的多個 傳送方法名,一般需要判斷區分
                // call.arguments 獲取到 flutter 給到的引數,(比如跳轉到另一個頁面所需要引數)
                // result 是給flutter的回撥, 該回撥只能使用一次
                NSLog(@"flutter 給到我:\nmethod=%@ \narguments = %@",call.method,call.arguments);
                
                if ([call.method isEqualToString:@"toNativeSomething"]) {
                    UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"flutter回撥" message:[NSString stringWithFormat:@"%@",call.arguments] delegate:self cancelButtonTitle:@"確定" otherButtonTitles:nil];
                    [alertView show];
                    
                    // 回撥給flutter
                    if (result) {
                        result(@1000);
                    }
                } else if ([call.method isEqualToString:@"toNativePush"]) {
                    ThirdViewController *testVC = [[ThirdViewController alloc] init];
                    testVC.parames = call.arguments;
                    [weakSelf.navigationController pushViewController:testVC animated:YES];
                } else if ([call.method isEqualToString:@"toNativePop"]) {
                    [weakSelf.navigationController popViewControllerAnimated:YES];
                }
            }];
        
        [self.navigationController pushViewController:flutterViewController animated:YES];
    }
複製程式碼

Native主動,Flutter被動 (EventChannel)

一般用於flutter初始化需要從客戶端獲取一些引數作為渲染條件;類似iOS這邊的KVO,監聽flutter是否已經在監聽,監聽的時候回撥到代理【這步其實還是flutter監聽的時候,內部發了一個通知,iOS這邊收到並回撥】,iOS Native處理代理,並回撥給flutter所需要引數

Flutter 程式碼 (class中):

  // 註冊一個通知
  static const EventChannel eventChannel = const EventChannel('com.pages.your/native_post');

  // 渲染前的操作,類似viewDidLoad
  @override
  void initState() {
    super.initState();
    
    // 監聽事件,同時傳送引數12345
    eventChannel.receiveBroadcastStream(12345).listen(_onEvent,onError: _onError);
  }

  String naviTitle = '你好,大佬' ;
  // 回撥事件
  void _onEvent(Object event) {
    setState(() {
      naviTitle =  event.toString();
    });
  }
  // 錯誤返回
  void _onError(Object error) {

  }
複製程式碼

Native程式碼:

- (void)pushFlutterViewController_EventChannel {
        FlutterViewController* flutterViewController = [[FlutterViewController alloc] initWithProject:nil nibName:nil bundle:nil];
        flutterViewController.navigationItem.title = @"EventChannel Demo";
        // 要與main.dart中一致
        NSString *channelName = @"com.pages.your/native_post";
        
        FlutterEventChannel *evenChannal = [FlutterEventChannel eventChannelWithName:channelName binaryMessenger:flutterViewController];
        // 代理
        [evenChannal setStreamHandler:self];
        
        [self.navigationController pushViewController:flutterViewController animated:YES];
    }

#pragma mark - <FlutterStreamHandler>
    // // 這個onListen是Flutter端開始監聽這個channel時的回撥,第二個引數 EventSink是用來傳資料的載體。
    - (FlutterError* _Nullable)onListenWithArguments:(id _Nullable)arguments
                                           eventSink:(FlutterEventSink)events {
        
        // arguments flutter給native的引數
        // 回撥給flutter, 建議使用例項指向,因為該block可以使用多次
        if (events) {
            events(@"我是標題");
        }
        return nil;
    }
    
    /// flutter不再接收
    - (FlutterError* _Nullable)onCancelWithArguments:(id _Nullable)arguments {
        // arguments flutter給native的引數
        return nil;
 }
 
複製程式碼

互動總結

這兩種方式都差不多,一個使用的時候使用block,一個使用的時候使用delegate;最終回撥給flutter的都是通過block。

MethodChannel 使用block,上下文更加明確;同一個channel name可以根據flutter給回的call.methodcall.arguments更加靈活的處理回撥handle, 回撥只能使用一次(意思就是就算你建立一個例項指向block,單block回撥只能使用一次,回撥之後flutter block那邊不再接收);

EventChannel 使用delegate,程式碼層次更鮮明;同一個channel name只能通過判斷arguments引數處理回撥handle, 回撥可以使用多次(建立一個例項指向block,該block可以向flutter傳送多次);

BasicMessageChannel 請自行學習。

疑問

建立使用FlutterViewController Xcode的Memory一直在增加到一個水平,分類重寫- (void)dealloc 也沒有進來,估計是記憶體洩漏了。於是去查了官方的Issues ,確實有幾個關聯:

Native 簡單push FlutterViewControllerpop回,記憶體到達一個階段後不降,FlutterViewController不會執行dealloc方法。不知道這誰知道有沒有解決方案?不吝賜教,謝謝!

學習

相關文章