iOS已有項目集成Flutter

環境配置

因為是在iOS已有項目中集成Flutter,所以正常情況的環境是macOS + Xcode + flutter環境;再加上flutter 需要的的dart語言編輯器 Android Studio 、IntelliJ IDEA 或 Visual Studio Code (VS Code) ;因為flutter是多平臺,所以也要安裝安卓相關的SDK。macOS下搭建Flutter開發環境可以參考 Mac下搭建Flutter開發環境

創建Flutter項目

Flutter項目最好獨立于iOS項目,不要耦合進iOS項目中,最好放在與項目目錄同級。
在iOS項目目錄下終端運行:

flutter create -t module flutter_module

運行完成后,iOS項目與Flutter項目層級如下:

iOS工程配置

  • 因為Flutter混合開發還不支持bit code,所以在iOS工程中需要關閉bit code。

  • 創建Xcode項目中的Config文件,引向flutter module
    新建Config目錄,管理Xcode工程的配置銜接文件,分別創建 Flutter.xcconfig 、Debug.xcconfig、Release.xcconfig 三個配置文件;其中Flutter.xcconfig 是指向外目錄flutter module的Generated.xcconfig 文件路徑引用文件,其他兩個代表Xcode的環境配置文件。

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

Flutter.xcconfig:

#include "../../flutter_module/.ios/Flutter/Generated.xcconfig"
ENABLE_BITCODE=NO

Debug.xcconfig:

#include "Flutter.xcconfig"

Release.xcconfig:

#include "Flutter.xcconfig"
FLUTTER_BUILD_MODE=release
  • 修改Xcode project環境配置

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

在iOS工程里添加運行腳本 "$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build,并且確保Run Script這一行在"Target dependencies" 或者 "Check Pods Manifest.lock"后面。

點擊Xcode運行,會執行到xcode-backend.sh腳本;如果運行成功,則說明環境配置的都沒問題,此時在Flutter工程下的.ios/Flutter/目錄下會生成App.framework和/engine/Flutter.framework,其中App.framework即為Flutter工程生成的產物。

打包framework命令

flutter build ios-framework --output=/Users/Desktop/FlutterTest

導入Flutter工程產物到iOS工程中

方法一:可以將Flutter工程中生成的App.framework和Flutter.framework產物拷貝到iOS工程中,然后再鏈接到iOS項目中。
該方法存在的問題:每次修改完Flutter代碼重新打包生成App.framework產物后都需要重新拷貝到iOS工程中。

方法二:直接讓iOS項目鏈接Flutter工程下的App.framework和Flutter.framework產物,然后修改導入framework的路徑,這樣修改Flutter的代碼后通過運行Xcode即可得到最新Flutter工程的產物。

導入App.framework和Flutter.framework后需要將Embed改成Embed & Sign。

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

下面開始寫代碼了

從iOS頁面跳轉到Flutter頁面

  • 將Flutter工程下的main.dart替換成下面的代碼:
import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return  MaterialApp(
      title: "My App",
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text("My App"),
        ),
        body: Center(
          child: Text("Hello World!"),
        ),
      ),
    );
  }
}
  • iOS工程點擊屏幕跳轉到Flutter頁面:
- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    FlutterViewController *flutterVC = [[FlutterViewController alloc] init];
    flutterVC.modalPresentationStyle = UIModalPresentationFullScreen;
    [self presentViewController:flutterVC animated:YES completion:nil];
}
  • 點擊Xcode運行,點擊屏幕就可以跳轉到Flutter頁面,效果圖如下:

iOS原生與Flutter進行交互

  • Flutter調用iOS的方法,iOS返回結果給Flutter:
    main.dart代碼:
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';

void main() {
  runApp(MyHome());
}

class MyHome extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: "My Home",
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key}) : super(key: key);

  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State <MyHomePage> {
  // 創建一個給native的channel(類似于iOS的通知)
  static const methodChannel = const MethodChannel('com.pages.your/native_get');

  var _leftNumber = 10;
  var _rightNumber = 20;
  var _result = 0;

  Future<Null>_callNativeMethodToCalculateAdd() async {
    dynamic result;
    try {
      // Flutter調用Native
      result = await methodChannel.invokeMethod('callAdd', {"left": _leftNumber, "right": _rightNumber});
    } on PlatformException {
      result = 0;
    }

    setState(() {
      _result = result;
    });
  }

  Future<Null>_callNativeMethodToCalculateMul() async {
    dynamic result;
    try {
      // Flutter調用Native
      result = await methodChannel.invokeMethod('callMul', {"left": _leftNumber, "right": _rightNumber});
    } on PlatformException {
      result = 0;
    }

    setState(() {
      _result = result;
    });
  }

  @override
  Widget build(BuildContext context) {
    return new Scaffold(
      appBar: AppBar(
        title: Text('My Home'),
      ),
      body: Container(
        padding: EdgeInsets.all(20),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Container(
              child: GestureDetector(
                child: Text("調用native方法計算加法"),
                onTap: () {
                  _callNativeMethodToCalculateAdd();
                },
              ),
              color: Colors.grey,
              margin: EdgeInsets.only(bottom: 20),
            ),
            Container(
              child: GestureDetector(
                child: Text("調用native方法計算乘法"),
                onTap: () {
                  _callNativeMethodToCalculateMul();
                },
              ),
              color: Colors.grey,
              margin: EdgeInsets.only(bottom: 20),
            ),
            Container(
              child: Text("計算結果是: ${_result}"),
            )
          ],
        ),
      ),
    );
  }
}

iOS代碼:

- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    FlutterViewController *flutterVC = [[FlutterViewController alloc] init];
    flutterVC.modalPresentationStyle = UIModalPresentationFullScreen;
    [self presentViewController:flutterVC animated:YES completion:nil];
    
    // 要與main.dart中一致
    NSString *channelName = @"com.pages.your/native_get";
    
    FlutterMethodChannel *messageChannel = [FlutterMethodChannel methodChannelWithName:channelName binaryMessenger:flutterVC];
    [messageChannel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
        NSDictionary *numbers = call.arguments;
        NSInteger left = [numbers[@"left"] integerValue];
        NSInteger right = [numbers[@"right"] integerValue];
        NSInteger r = 0;
        if ([call.method isEqualToString:@"callAdd"]) {
            r = left + right;
        } else if ([call.method isEqualToString:@"callMul"]) {
            r = left * right;
        }
        result(@(r));
    }];
}

運行結果:

  • iOS主動調用Flutter

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

main.dart代碼:

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

void main() {
  runApp(MyHome());
}

class MyHome extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: "My Home",
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key}) : super(key: key);

  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  // 注冊一個通知
  static const EventChannel eventChannel = const EventChannel("com.pages.your/native_post");

  // 渲染前的操作,類似于iOS中的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) {

  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("My Home"),
      ),
      body: Center(
        child: Text(naviTitle),
      ),
    );
  }
}

iOS代碼:

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

@interface ViewController () <FlutterStreamHandler>
{
    int I;
    FlutterEventSink _events;
}

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    
    [NSTimer scheduledTimerWithTimeInterval:1.0 target:self selector:@selector(timerRun) userInfo:nil repeats:YES];
}

- (void)timerRun {
    if (_events) {
        _events(@(i++));
    }
}

- (void)touchesBegan:(NSSet<UITouch *> *)touches withEvent:(UIEvent *)event {
    FlutterViewController *flutterVC = [[FlutterViewController alloc] init];
    flutterVC.modalPresentationStyle = UIModalPresentationFullScreen;
    [self presentViewController:flutterVC animated:YES completion:nil];
    
    // 要與main.dart中一致
    NSString *channelName = @"com.pages.your/native_post";
    
    FlutterEventChannel *eventChannel = [FlutterEventChannel eventChannelWithName:channelName binaryMessenger:flutterVC];
    [eventChannel setStreamHandler:self];
}

#pragma mark - FlutterStreamHandler
// 這個onListen是Flutter端開始監聽這個channel時的回調,第二個參數EventSink是用來傳數據的載體
- (FlutterError *)onListenWithArguments:(id)arguments eventSink:(FlutterEventSink)events {
    // arguments 是 flutter給native的參數
    // 回調給flutter,建議使用實例指向,因為該block可以使用多次
    _events = events;
    return nil;
}

// flutter不在接收
- (FlutterError *)onCancelWithArguments:(id)arguments {
    // arguments flutter給native的參數
    return nil;
}

@end

運行結果:

交互總結
這兩種方式都差不多,一個使用的是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發送多次);

參考

iOS Native混編Flutter交互實踐
iOS老項目集成Flutter(iOS混編Flutter)
Flutter官方文檔
Flutter中文網

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,578評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,701評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 178,691評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,974評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,694評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,026評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,015評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,193評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,719評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,442評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,668評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,151評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,846評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,255評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,592評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,394評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,635評論 2 380

推薦閱讀更多精彩內容