2. 程式人生 > >Flutter 外掛編寫必知必會

Flutter 外掛編寫必知必會

阿新 • • 發佈：2018-12-26

本文目的

  • 介紹包和外掛的概念
  • 介紹 flutter 呼叫平臺特定程式碼的機制：Platform Channels，和相關類的常用方法
  • 介紹外掛開發流程和示例
  • 介紹優化外掛的方法：新增文件，合理設定版本號，新增單元測試，新增持續整合
  • 介紹釋出外掛的流程和常見問題

目錄結構

  • 編寫之前
  • Platform Channels
  • 外掛開發
  • 優化外掛
  • 釋出外掛
  • 總結

編寫之前

包（packages）的概念

packages 將程式碼內聚到一個模組中，可以用來分享程式碼。一個 package 最少要包括：

  • 一個 pubspec.yaml
    檔案：它定義了包的很多元資料，比如包名，版本，作者等
  • 一個 lib 資料夾，包含了包中的 public 程式碼，一個包裡至少會有一個 <package-name>.dart 檔案

packages 根據內容和作用大致分為2類：

  • Dart packages ：程式碼都是用 Dart 寫的
  • Plugin packages ：一種特殊的 Dart package，它包括 Dart 編寫的 API ，加上平臺特定程式碼，如 Android (用Java/Kotlin), iOS (用ObjC/Swift)

編寫平臺特定程式碼可以寫在一個 App 裡，也可以寫在 package

裡，也就是本文的主題 plugin 。變成 plugin 的好處是便於分享和複用（通過 pubspec.yml 中新增依賴）。

Platform Channels

Flutter提供了一套靈活的訊息傳遞機制來實現 Dart 和 platform-specific code 之間的通訊。這個通訊機制叫做 Platform Channels

  • Native Platform 是 host ，Flutter 部分是 client
  • host 和 client 都可以監聽這個 platform channels 來收發訊息

Platofrm Channel架構圖

Architectural overview: platform channels

常用類和主要方法

Flutter 側

MethodChannel

Future invokeMethod (String method, [dynamic arguments]); // 呼叫方法
void setMethodCallHandler (Future handler(MethodCall call)); //給當前channel設定一個method call的處理器，它會替換之前設定的handler
void setMockMethodCallHandler (Future handler(MethodCall call)); // 用於mock，功能類似上面的方法
複製程式碼

Android 側

MethodChannel

void invokeMethod(String method, Object arguments) // 同dart
void invokeMethod(String method, Object arguments, MethodChannel.Result callback) // callback用來處理Flutter側的結果，可以為null，
void setMethodCallHandler(MethodChannel.MethodCallHandler handler) // 同dart
複製程式碼

MethodChannel.Result

void error(String errorCode, String errorMessage, Object errorDetails) // 異常回調方法
void notImplemented() // 未實現的回撥
void success(Object result) // 成功的回撥
複製程式碼

PluginRegistry

Context	context() // 獲取Application的Context
Activity activity() // 返回外掛註冊所在的Activity
PluginRegistry.Registrar addActivityResultListener(PluginRegistry.ActivityResultListener listener) // 新增Activityresult監聽
PluginRegistry.Registrar addRequestPermissionsResultListener(PluginRegistry.RequestPermissionsResultListener listener) // 新增RequestPermissionResult監聽
BinaryMessenger	messenger() // 返回一個BinaryMessenger，用於外掛與Dart側通訊
複製程式碼

iOS 側

FlutterMethodChannel

- (void)invokeMethod:(nonnull NSString *)method arguments:(id _Nullable)arguments;

// result:一個回撥，如果Dart側失敗，則回撥引數為FlutterError型別；
// 如果Dart側沒有實現此方法，則回撥引數為FlutterMethodNotImplemented型別；
// 如果回撥引數為nil獲取其它型別，表示Dart執行成功
- (void)invokeMethod:(nonnull NSString *)method arguments:(id _Nullable)arguments result:(FlutterResult _Nullable)callback; 

- (void)setMethodCallHandler:(FlutterMethodCallHandler _Nullable)handler;
複製程式碼

Platform Channel 所支援的型別

標準的 Platform Channels 使用StandardMessageCodec，將一些簡單的資料型別，高效地序列化成二進位制和反序列化。序列化和反序列化在收/發資料時自動完成，呼叫者無需關心。

type support

外掛開發

建立 package

在命令列輸入以下命令，從 plugin 模板中建立新包

flutter create --org com.example --template=plugin hello # 預設Android用Java，iOS用Object-C
flutter create --org com.example --template=plugin -i swift -a kotlin hello
 # 指定Android用Kotlin，iOS用Swift
複製程式碼

實現 package

下面以install_plugin為例，介紹開發流程

1.定義包的 API（.dart）

class InstallPlugin {
  static const MethodChannel _channel = const MethodChannel('install_plugin');

  static Future<String> installApk(String filePath, String appId) async {
    Map<String, String> params = {'filePath': filePath, 'appId': appId};
    return await _channel.invokeMethod('installApk', params);
  }

  static Future<String> gotoAppStore(String urlString) async {
    Map<String, String> params = {'urlString': urlString};
    return await _channel.invokeMethod('gotoAppStore', params);
  }
}
複製程式碼

2.新增 Android 平臺程式碼（.java/.kt）

  • 首先確保包中 example 的 Android 專案能夠 build 通過
cd hello/example
flutter build apk
複製程式碼
  • 在 AndroidStudio 中選擇選單欄 File > New > Import Project… , 並選擇 hello/example/android/build.gradle 匯入
  • 等待 Gradle sync
  • 執行 example app
  • 找到 Android 平臺程式碼待實現類
    • java:./android/src/main/java/com/hello/hello/InstallPlugin.java
    • kotlin:./android/src/main/kotlin/com/zaihui/hello/InstallPlugin.kt
    class InstallPlugin(private val registrar: Registrar) : MethodCallHandler {

    companion object {
    
        @JvmStatic
        fun registerWith(registrar: Registrar): Unit { 
            val channel = MethodChannel(registrar.messenger(), "install_plugin")
            val installPlugin = InstallPlugin(registrar)
            channel.setMethodCallHandler(installPlugin)
            // registrar 裡定義了addActivityResultListener，能獲取到Acitvity結束後的返回值
            registrar.addActivityResultListener { requestCode, resultCode, intent ->
                ...
            }
        }
    }

    override fun onMethodCall(call: MethodCall, result: Result) {
        when (call.method) {
            "installApk" -> {
                // 獲取引數
                val filePath = call.argument<String>("filePath")
                val appId = call.argument<String>("appId")
                try {
                    installApk(filePath, appId)
                    result.success("Success")
                } catch (e: Throwable) {
                    result.error(e.javaClass.simpleName, e.message, null)
                }
            }
            else -> result.notImplemented()
        }
    }

    private fun installApk(filePath: String?, appId: String?) {...}
}
複製程式碼

3.新增iOS平臺程式碼（.h+.m/.swift）

  • 首先確保包中 example 的 iOS 專案能夠 build 通過
cd hello/exmaple
flutter build ios --no-codesign
複製程式碼
  • 開啟Xcode，選擇 File > Open, 並選擇 hello/example/ios/Runner.xcworkspace
  • 找到 iOS 平臺程式碼待實現類
    • Object-C:/ios/Classes/HelloPlugin.m
    • Swift:/ios/Classes/SwiftInstallPlugin.swift
    import Flutter
import UIKit
    
public class SwiftInstallPlugin: NSObject, FlutterPlugin {
    public static func register(with registrar: FlutterPluginRegistrar) {
        let channel = FlutterMethodChannel(name: "install_plugin", binaryMessenger: registrar.messenger())
        let instance = SwiftInstallPlugin()
        registrar.addMethodCallDelegate(instance, channel: channel)
    }

    public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
        switch call.method {
        case "gotoAppStore":
            guard let urlString = (call.arguments as? Dictionary<String, Any>)?["urlString"] as? String else {
                result(FlutterError(code: "引數異常", message: "引數url不能為空", details: nil))
                return
            }
            gotoAppStore(urlString: urlString)
        default:
            result(FlutterMethodNotImplemented)
        }
    }
    func gotoAppStore(urlString: String) {...}
}
複製程式碼

4. 在 example 中呼叫包裡的 dart API

5. 執行 example 並測試平臺功能

優化外掛

外掛的意義在於複用和分享，開源的意義在於分享和迭代。外掛的開發者都希望自己的外掛能變得popular。外掛釋出到pub.dartlang後，會根據 Popularity ，Health， Maintenance 進行打分，其中 Maintenance 就會看 README, CHANGELOG, 和 example 是否添加了內容。

新增文件

1. README.md

2. CHANGELOG.md

  • 關於寫 ChangeLog 的意義和規則：推薦一個網站keepachangelog，和它的專案的[changelog]((github.com/olivierlaca…)作為範本。
    keepachangelog principle and types
  • 如何高效的寫 ChangeLog ？github 上有不少工具能減少寫 changeLog 工作量，推薦一個github-changelog-generator,目前僅對 github 平臺有效，能夠基於 tags, issues, merged pull requests，自動生成changelog 檔案。

3. LICENSE

比如 MIT License,要把[yyyy] [name of copyright owner]替換為年份+所有者，多個所有者就寫多行。

license-ownner-year

4. 給所有public的API新增 documentation

合理設定版本號

在姊妹篇Flutter 外掛使用必知必會中已經提到了語義化版本的概念，作為外掛開發者也要遵守

版本格式：主版本號.次版本號.修訂號，版本號遞增規則如下：

  • 主版本號：當你做了不相容的 API 修改，
  • 次版本號：當你做了向下相容的功能性新增，
  • 修訂號：當你做了向下相容的問題修正。

編寫單元測試

plugin的單元測試主要是測試 dart 中程式碼的邏輯，也可以用來檢查函式名稱，引數名稱與 API定義的是否一致。如果想測試 platform-specify 程式碼，更多依賴於 example 的用例，或者寫平臺的測試程式碼。

因為InstallPlugin.dart的邏輯很簡單，所以這裡只驗證驗證方法名和引數名。用setMockMethodCallHandler mock 並獲取 MethodCall，在 test 中用isMethodCall驗證方法名和引數名是否正確。

void main() {
  const MethodChannel channel = MethodChannel('install_plugin');
  final List<MethodCall> log = <MethodCall>[];
  String response; // 返回值

  // 設定mock的方法處理器
  channel.setMockMethodCallHandler((MethodCall methodCall) async {
    log.add(methodCall);
    return response; // mock返回值
  });

  tearDown(() {
    log.clear();
  });


  test('installApk test', () async {
    response = 'Success';
    final fakePath = 'fake.apk';
    final fakeAppId = 'com.example.install';
    final String result = await InstallPlugin.installApk(fakePath, fakeAppId);
    expect(
      log,
      <Matcher>[isMethodCall('installApk', arguments: {'filePath': fakePath, 'appId': fakeAppId})],
    );
    expect(result, response);
  });
}
複製程式碼

新增CI

持續整合（Continuous integration，縮寫CI），通過自動化和指令碼來驗證新的變動是否會產生不利影響，比如導致建構失敗，單元測試break，因此能幫助開發者儘早發現問題，減少維護成本。對於開源社群來說 CI 尤為重要，因為開源專案一般不會有直接收入，來自 contributor 的程式碼質量也良莠不齊。

我這裡用 Travis 來做CI，入門請看這裡travis get stated

在專案根目錄新增 .travis.yml 檔案

os:
  - linux
sudo: false
addons:
  apt:
    sources:
      - ubuntu-toolchain-r-test # if we don't specify this, the libstdc++6 we get is the wrong version
    packages:
      - libstdc++6
      - fonts-droid
before_script:
  - git clone https://github.com/flutter/flutter.git -b stable --depth 1
  - ./flutter/bin/flutter doctor
script:
  - ./flutter/bin/flutter test # 跑專案根目錄下的test資料夾中的測試程式碼
cache:
  directories:
    - $HOME/.pub-cache
複製程式碼

這樣當你要提 PR 或者對分支做了改動，就會觸發 travis 中的任務。還可以把 build 的小綠標新增到 README.md 中哦，注意替換路徑和分支。

[![Build Status](https://travis-ci.org/hui-z/flutter_install_plugin.svg?branch=master)](https://travis-ci.org/hui-z/flutter_install_plugin#)

複製程式碼

travis ci

釋出外掛

1. 檢查程式碼

$ flutter packages pub publish --dry-run
複製程式碼

會提示你專案作者（格式為authar_name <[email protected]>,保留尖括號），主頁，版本等資訊是否補全，程式碼是否存在 warnning（會檢測說 test 裡有多餘的 import，實際不是多餘的，可以不理會）等。

2. 釋出

$ flutter packages pub publish
複製程式碼

如果釋出失敗，可以在上面命令後加-v,會列出詳細釋出過程，確定失敗在哪個步驟，也可以看看issue上的解決辦法。

常見問題

  • Flutter 安裝路徑缺少許可權，導致釋出失敗，參考
sudo flutter packages pub publish -v
複製程式碼
  • 如何新增多個 uploader？參考
 pub uploader add [email protected]
 pub uploader remove [email protected] # 如果只有一個uploader，將無法移除
複製程式碼

去掉官方指引裡面對PUB_HOSTED_URL、FLUTTER_STORAGE_BASE_URL的修改，這些修改會導致上傳pub失敗。

總結

本文介紹了一下外掛編寫必知的概念和編寫的基本流程，並配了個簡單的例子（原始碼）。希望大家以後不再為Flutter缺少native功能而頭疼，可以自己動手豐衣足食，順便還能為開源做一點微薄的貢獻！

參考

相關推薦

Flutter 外掛編寫必知必會

本文目的 介紹包和外掛的概念 介紹 flutter 呼叫平臺特定程式碼的機制：Platform Channels，和相關類的常用方法 介紹外掛開發流程和示例 介紹優化外掛的方法：新增文件，合理設定版本號，新增單元測試，新增持續整合 介紹釋出外掛的流程和常見問題 目錄結構

Flutter 外掛使用必知必會

本文目的 介紹外掛的搜尋方式，三方庫評估的意義和基本思路 介紹如何給應用新增外掛，從原始碼角度看外掛是如何註冊生效的 介紹如何給外掛指定版本和解決版本衝突問題 介紹依賴源的種類，如何從pub/git/本地指定依賴庫 介紹依賴的2種分類方式：直接依賴和傳遞依賴；常規依賴和dev依賴

Flutter佈局詳解/必知必會

前言 本文的目的是為了讓讀者掌握不同佈局類Widget的佈局特點，分享一些在實際使用過程遇到的一些問題，在《Flutter實戰》這本書中已經講解的很詳細了，本文主要是對其內容的濃縮及實際遇到的問題的補充。 什麼是佈局類Widget 佈局類Widget就是指直接或間接繼承(包含)MultiChildRen

vc++HOOK API黑客外掛程式設計必知必會

 #include <windows.h> // 定義API掛接項結構typedef struct _HOOK_ITEM { DWORD dwAddr ;   // IAT項所在地址 DWORD dwOldValue ;  // IAT項的原始函式地址 DWORD

Pytest自動化測試 - 必知必會的一些外掛

Pytest擁有豐富的外掛架構，超過800個以上的外部外掛和活躍的社群，在PyPI專案中以“ pytest- *”為標識。 本篇將列舉github標星超過兩百的一些外掛進行實戰演示。 外掛庫地址：http://plugincompat.herokuapp.com/   1、pytest-html

【MySQL必知必會】第6章 過濾數據

sea 錯誤 arch order by ice where 大量數據 子句 否則 1、使用WHERE子句 　　數據庫一般包含大量數據，所以一般不會檢索所有行。只檢索所需數據需要指定搜索條件（search criteria），搜索條件也稱為過濾條件（filter condi

《MYSQL必知必會》

聚集函數 結構 則表達式 拼接 建議 支持 類型 習慣 功能 1、 同一個數據庫中不允許出現同名表；不同的數據庫中可以出現同名表2、 每一行記錄都用有一個key（一列或一組列作為key）3、 作為key的列不允許值為空（NULL）4、 多個列作為key時，多個列的組

《MYSQL必知必會2

pri upd delet rate 服務器 cal delete 生效 單獨 60、NULL是沒有值，空串是一個有效值61、主鍵只能使用不允許未NULL值的列62、每個表只允許一個auto_increment列63、不允許使用函數作為默認值，只支持常量64、InnoDB

SQL必知必會 -------- 通配符、計算字段、函數

提取 mar 第8章 column round vendor 方法 多少 頁面 1.LIKE操作符 1.1百分號（%）通配符 SELECT prod_id, prod_name FROM Products WHERE prod_name LIKE ‘Fish%‘

【MySQL必知必會】第十章 創建計算字段

客戶機 cat 第十章 去掉 quantity 字段 cme 引用 field 1、字段（field）：一般與列（同義），經常互換使用，不過數據庫列一般稱之為列，字段通常用在計算字段的連接上。 2、拼接：將值連接到一起構成單個值。 　　註：多數DBMS使用+或||來實現拼接

【MySQL必知必會】第十三章 分組數據

num mysql 統計 where子句 rom 過濾 group by 大於 映射 1、創建分組 　　輸入： 　　SELECT vend_id , COUNT(*) AS num_prods 　　FROM products 　　GROUP BY vend_id; 　　輸出

【MySQL必知必會】第十六章 創建高級聯結

類型 where子句 contact items order by 其他 mysq custom 必知必會 1、使用表別名 　　好處： 　　a、縮短SQL語句。 　　b、允許在單條SELECT語句中多次使用相同的表。 　　輸入： 　　SELECT　　cust_name,cu

SQL必知必會摘要

用法 row 第一個 table class err num 方向 返回 數據檢索 2.2 檢索單個列 SELECT prod_name FROM Products; SQL語句不區分大小寫 2.3 檢索多個列 SELECT prod_name，pr

《領導梯隊》：4星。企業中六個層級的領導的必知必會和必須不能做的事情。

進行 方案 更多 思路 和平 要花 能力 事情 專註 書不錯，根據許多企業的情況總結出來的，作者們有企業家的顧問經驗。 總體內容是每一次晉級都是思路的轉換，每一層領導都需要轉換思路才能做好，每一層領導都容易犯的錯誤是事必躬親。 作者列出六個層級的領導：經理、總監、事

JSON必知必會學習總結（一）

tor lint 沒有 script app 對數 數據交換格式 object 什麽 七月第一周，從學校畢業回來上班的第一周。離開一段時候後，再次回來重新工作，有了很多新的認識，不再是實習時那麽混混沌沌了。每天我自己該做什麽，怎麽做，做到什麽程度更清晰了。除了要去完成我負責

《MySQL必知必會學習筆記》：子查詢

簡單的 後繼 復雜 pos clas tty append 靈活 values 子查詢 在開始了解子查詢之前，首先做下準備工作，建立3個表， 一個是customers表，當中包含：客戶名字、客戶ID、客戶Tel等。 一個是orders

MySQL必知必會-表的關系

mysql必知必會-表的關系MySQL必知必會-表的關系

MySQL必知必會筆記

mysql必知必會筆記Having和Where的區別：先執行Where的條件，再執行Having的條件group by和order by的區別：group by是分組，order by是排序select子句的順序：select...from...where...group by...having...orde

讀MYSQL必知必會的總結

pda 視圖 撤銷 參數 正則表達式 更新 表現 into 解鎖 看到了mysql必知必會 總結了以下幾個以後很有可能用到的知識點： 1.在檢索多列的時候，需要再列名之間用“，”進行分開，最後的列名後面不加。 select id,uid,name from 表名;

Java必知必會：異常機制詳解

賦值 輸出結果 類庫 負數 虛擬 類名 通過反射 基於 all 一、Java異常概述 在Java中，所有的事件都能由類描述，Java中的異常就是由java.lang包下的異常類描述的。 1、Throwable（可拋出）：異常類的最終父類，它有兩個子類，Error與Exce