原生App項目集成flutter混合開發(fā)詳細指南

記得去年9月份的時候谷歌在上海有一次開發(fā)者大會,去參加的時候關(guān)注到了flutter,隨后沒過多久就發(fā)布了1.0版本。18年底的時候用flutter做了個小項目,發(fā)現(xiàn)flutter確實挺好用的。于是嘗試在公司找個小項目上馬,進行混合開發(fā)試試。

方案選擇

目前主流的混合開發(fā)方案有兩種集成方式:

源碼集成:也就是谷歌官方提供的方案[https://github.com/flutter/flutter/wiki/Add-Flutter-to-existing-apps]

產(chǎn)物集成:Flutter項目單獨開發(fā),開發(fā)完成后發(fā)布成aar包或者iOS的framework形式,原生項目依賴flutter輸出的制品即可。具體可以參考閑魚的文章

image-20190221145655505.png

兩種方式各有優(yōu)劣,其實產(chǎn)物集成更好一些,不過即使是進行產(chǎn)物集成,也需要弄懂源碼集成的方式,因為當(dāng)有很多和原生交互的功能進行開發(fā)的時候,源碼集成的方式可以直接調(diào)試會方便很多。

根據(jù)目前我們的情況:

1.參與人員都要進行flutter開發(fā)、

2.持續(xù)發(fā)布和構(gòu)建我可以修改控制

我們現(xiàn)在這個項目選擇了源碼集成的方式。

為原生項目集成flutter

整個的集成方案是參考谷歌方法:[https://github.com/flutter/flutter/wiki/Add-Flutter-to-existing-apps],但是有一些不一樣,我是創(chuàng)建了一個flutter項目后,在原生的項目中使用git submodule的形式進行管理的。

1.創(chuàng)建flutter module project

我們假定已經(jīng)有了原生的項目Native-iOSNative-Android;現(xiàn)在我們需要創(chuàng)建我們的flutter項目。

  1. 把我們的flutter的channel切換到master(master分支下是flutter的preview版本)

    flutter channel master

  2. 創(chuàng)建flutter模塊的項目

    flutter create -t module {moduleName}

    我這里創(chuàng)建一個flutter的模塊項目叫flutter_module

    ? flutter create -t module flutter_module
    Creating project flutter_module...
      flutter_module/test/widget_test.dart (created)
      ...
      ...
      flutter_module/.idea/workspace.xml (created)
    Running "flutter packages get" in flutter_module...                 7.2s
    Wrote 12 files.
    
    All done!
    Your module code is in flutter_module/lib/main.dart.
    

    創(chuàng)建成功后我們可以看一下目錄結(jié)構(gòu)

    ?  flutter_module git:(master) ? tree -L 2 -a
    .
    ├── .android
    │   ├── Flutter
    │   ├── app
    │   ├── ...
    ├── .gitignore
    ├── .ios
    │   ├── Config
    │   ├── Flutter
    │   ├── ...
    │   └── Runner.xcworkspace
    ├── lib
    │   └── main.dart
    ├── pubspec.lock
    ├── pubspec.yaml
    └── test
        └── widget_test.dart
    

    在flutter的模塊項目中包含有一個隱藏的.android.ios目錄這個目錄下是可運行的Android和iOS項目,我們的flutter代碼還是在lib下編寫,注意在.android.ios目錄下都有一個Flutter目錄,這個是我們flutter的庫項目了。也就是Android用來生成aar,iOS用來生產(chǎn)framework的庫。如果我們用flutter create xxx 生成的純flutter項目是沒有這個Flutter目錄的。

  3. 把該項目使用git管理起來,稍后我們要在native項目中以子模塊的形式添加進去。

    ?  cd flutter_module
    ?  git init
    Initialized empty Git repository in /Users/zhiqiangdeng/Documents/ProjectSource/FlutterProject/flutter_module/.git/
    ?  flutter_module git:(master) ?
    

    初始化git倉庫后我們先編輯一下項目下的.gitignore文件,當(dāng)前這個文件是把項目下的.ios.android忽略掉的。這個兩個項目我們需要跟蹤一下,大家可以去github上找一下iOS和Android的gitignore模版文件,然后添加到這個兩個目錄中,然后把頂層目錄的文件作出如下修改,刪除.android和.ios添加.ios/Flutter/Generated.xcconfig

    .gitignore文件:

    -.android/
    -.ios/
    +.ios/Flutter/Generated.xcconfig
    
  4. 提交你的flutter模塊項目到你的git服務(wù)器(我提交到github上了[https://github.com/zakiso/flutter-module-demo.git]大家可以參考)

    git remote add origin {你的flutter module的倉庫地址}
    git push origin master
    

2.給iOS項目集成flutter

1.進入我們原生的iOS項目根目錄中,為它添加一個git submodule,把我們的flutter項目拉取下來.

git submodule add {你的flutter module的倉庫地址}
git submodule update

2.在項目的Podfile文件中添加下面的代碼,在每次執(zhí)行pod install會運行podhelper.rb

platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
  pod 'AFNetworking', '~> 2.6'
  xxxx
end
#添加如下兩行代碼,路徑修改為我們的fluter module的路徑
flutter_application_path = './flutter-module-demo'
  eval(File.read(File.join(flutter_application_path, '.ios', 'Flutter', 'podhelper.rb')), binding)

3.打開Xcode關(guān)閉bitcode配置Build Settings->Build Options->Enable Bitcode

4.添加編譯腳本,打開Xcode在 Build Phases中添加New Run Script Phase在里面填入如下腳本

"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" build
"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh" embed
image.png

5.項目的配置完成現(xiàn)在需要生成一些配置文件

? a. 進入原生項目的flutter模塊目錄中執(zhí)行flutter packages get命令

? b. 回到原生項目根目錄執(zhí)行pod install

?  cd flutter-module-demo
?  flutter-module-demo git:(master) flutter packages get
Running "flutter packages get" in flutter-module-demo...            0.4s
?  flutter-module-demo git:(master) cd ..
?  FlutterNativeiOS git:(master) ? pod install
Analyzing dependencies
Fetching podspec for `Flutter` from `./flutter-module-demo/.ios/Flutter/engine`
Fetching podspec for `FlutterPluginRegistrant` from `./flutter-module-demo/.ios/Flutter/FlutterPluginRegistrant`
Downloading dependencies
Using AFNetworking (2.6.3)
Installing Flutter (1.0.0)
Installing FlutterPluginRegistrant (0.0.1)
Generating Pods project
Integrating client project
Sending stats
Pod installation complete! There are 3 dependencies from the Podfile and 3 total pods installed.

到此為止我們的原生項目就已經(jīng)集成好了flutter項目了。

5.在原生項目中使用flutter,下面以swift項目為例

修改AppDelegate.swift:注意AppDelegate是集成自FlutterAppDelegate

import UIKit
import Flutter
import FlutterPluginRegistrant // Only if you have Flutter Plugins.

@UIApplicationMain
class AppDelegate: FlutterAppDelegate {
  var flutterEngine : FlutterEngine?;
  // Only if you have Flutter plugins.
  override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    self.flutterEngine = FlutterEngine(name: "io.flutter", project: nil);
    self.flutterEngine?.run(withEntrypoint: nil);
    GeneratedPluginRegistrant.register(with: self.flutterEngine);
    return super.application(application, didFinishLaunchingWithOptions: launchOptions);
  }

}

修改Controller代碼

import UIKit
import Flutter
class ViewController: UIViewController {
  override func viewDidLoad() {
    super.viewDidLoad()
    let button = UIButton(type:UIButtonType.custom)
    ...
    self.view.addSubview(button)
  }

  @objc func handleButtonAction() {
    let flutterEngine = (UIApplication.shared.delegate as? AppDelegate)?.flutterEngine;
    let flutterViewController = FlutterViewController(engine: flutterEngine, nibName: nil, bundle: nil)!;
    self.present(flutterViewController, animated: true, completion: nil)
  }

  1. RUN….

3.iOS項目集成過程梳理

整個的集成過程其實總得來說是如下三個步驟:

1.將flutter項目放入原生項目的文件夾下

2.在podfile中添加podhelper.rb配置

3.在Xcode的build phases添加"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh"iOS編譯腳本。

其中podhelper.rb文件位于我們flutter模塊項目的.ios/Flutter/podhelper.rb下,大家查看它的源碼可以發(fā)現(xiàn),它有下面幾個作用:

1.把Flutter(flutterEngine)和FlutterPluginRegistrant兩個庫用pod給原生項目導(dǎo)入進入

2.如果flutter項目有用到flutter plugin插件,把插件用pod導(dǎo)入

3.導(dǎo)入Generated.xcconfig的相關(guān)配置信息,在podhelper.rb同級別的目錄下還有一個Generated.xcconfig文件,這個文件在使用flutter create xx、flutter run xxx、flutter packages get命令的時候如果該文件不存在則會生成這個文件。這個文件內(nèi)容如下:

// This is a generated file; do not edit or check into version control.
FLUTTER_ROOT=/Users/zhiqiangdeng/.flutter_wrapper/1.2.2-pre.43
FLUTTER_APPLICATION_PATH=/Users/zhiqiangdeng/Documents/ProjectSource/XcodeProject/lianhua-order-iOS/order-check-module-flutter
FLUTTER_TARGET=lib/main.dart
FLUTTER_BUILD_DIR=build
SYMROOT=${SOURCE_ROOT}/../build/ios
FLUTTER_BUILD_NAME=1.0.0
FLUTTER_BUILD_NUMBER=1

他記錄了當(dāng)前flutter sdk的目錄位置,以及版本號,還有項目模塊的目錄位置。這個文件的內(nèi)容在執(zhí)行pod install的時候會被寫入到xcode build setting中,在執(zhí)行完pod install之后,可以在原生項目根目錄使用xcodebuild -showBuildSettings|grep flutter 查看相關(guān)的信息。

image-20190221183656596.png

最后一步就是運行程序,運行程序的時候在Build phase添加了xcode_backend.sh該腳本會使用到上面pod install給xcode build setting設(shè)置的那些環(huán)境變量,然后找到項目目錄生成AppFramework。

4.給原生Android項目集成Flutter

Android的文章很多,這里不再詳細描述了

1.在原生Android項目中添加子模塊,將上面創(chuàng)建的flutter module項目拉取到原生安卓項目中

git submodule add {你的flutter module的倉庫地址}
git submodule update

2.在根目錄的settings.gradle中添加如下配置

setBinding(new Binding([gradle: this]))                                 
evaluate(new File(                                                                 
  '{xxxxx你的flutter module目錄}/.android/include_flutter.groovy'                    
))      

3.在原生項目的app目錄下的build.gradle文件中添加Flutter庫的依賴

dependencies {
  implementation project(':flutter')
}

4.在原生代碼中集成flutter跳轉(zhuǎn)到flutter頁面

我使用了一個新的Activity進行跳轉(zhuǎn)。具體可以參看源碼

Button open = findViewById(R.id.openBtn);
open.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        Intent intent = new Intent();
        intent.setClass(MainActivity.this, MyFlutterActivity.class);
        startActivity(intent);
    }
});
public class MyFlutterActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_flutter);
        final FlutterView flutterView = Flutter.createView(
                this,
                getLifecycle(),
                "route1"
        );
        final FrameLayout layout = findViewById(R.id.flutter_container);
        layout.addView(flutterView);
        final FlutterView.FirstFrameListener[] listeners = new FlutterView.FirstFrameListener[1];
        listeners[0] = new FlutterView.FirstFrameListener() {
            @Override
            public void onFirstFrame() {
                layout.setVisibility(View.VISIBLE);
            }
        };
        flutterView.addFirstFrameListener(listeners[0]);
    }
}

Android從原生跳到Flutter模塊的黑屏問題,在網(wǎng)上看到很多說設(shè)置透明主題的但是沒有用,后來看到一種先隱藏顯示,等待渲染好第一幀后才顯示flutter頁面的方法。這里要注意一點要在布局中先把flutter的Container布局設(shè)置為InVisible狀態(tài),不要使用Gone,用gone的話是不顯示也不渲染,用InVisible不顯示但是會渲染界面占位置,等待渲染完成后再設(shè)置為Visible即可。

項目demo我已經(jīng)傳到github中:有遇到問題的可以參考項目源碼

5.flutter的版本管理

在我們的開發(fā)過程中遇到了一個問題,就是各個開發(fā)者使用的flutter sdk版本不一致,導(dǎo)致一些庫無法運行,在網(wǎng)上也遇到有相同問題的人,提出了模仿gradle wrapper來做一個flutter_wrapper的思路。于是我根據(jù)自己的需要寫了一個flutter_wrapper的小工具。它的主要作用是統(tǒng)一開發(fā)人員的本地flutter環(huán)境。

項目倉庫地址:https://github.com/zakiso/flutterw.git

使用說明

  1. 在你的項目根目錄中執(zhí)行命令下載腳本
    curl -O https://raw.githubusercontent.com/zakiso/flutterw/master/flutterw && chmod 755 flutterw
  2. 下載好腳本后在根目錄中使用
    ./flutterw init
    該命令會收集你當(dāng)前系統(tǒng)中的flutter版本,并將相關(guān)信息寫入flutter_wrapper.properties文件中,團隊中所有成員都會以該版本號做為該項目的標(biāo)準(zhǔn)版本
  3. 將flutterw文件和flutter_wrapper.properties文件添加到git中提交到倉庫里
  4. 其他成員拉取代碼后在項目中使用flutter命令的地方使用./flutterw代替,如果使用ide請選擇home目錄下對應(yīng)版本的sdk包

flutterw做了什么?

  1. 使用flutterw的時候會獲取當(dāng)前目錄下的flutter_wrapper.properties文件中的版本號
  2. 去用戶的${HOME}/flutter_wrapper/{版本號}/ 目錄下查找是否有該版本sdk
  3. 如果沒有該版本sdk會下載下來,然后使用該目錄下的sdk執(zhí)行命令

注意事項

如果flutter版本是preview的版本是直接使用master的最新代碼來管理的。大家可以查看源碼很簡單,根據(jù)自己的需要定制。

最后:

這是整個項目用來開發(fā)的示意圖:


image-20190221223543845.png

我們整個項目都是使用git進行管理的,雖然每個開發(fā)者都需要安裝flutter環(huán)境,但是對于小團隊來說成本并不高,加上flutter_wrapper也保證了版本的一致性。iOS開發(fā)者可以在原來的iOS項目中開發(fā)flutter的項目,Android開發(fā)者可以在原android項目中開發(fā)flutter,flutter開發(fā)者也可以自己單獨開發(fā)flutter項目,這種方式其實對于開發(fā)者來說也是很方便的。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。