Flutter插件開發(fā)指南01: 通道Channel的編寫與實現(xiàn)

Flutter插件開發(fā)指南01: 通道Channel的編寫與實現(xiàn)

視頻

https://www.bilibili.com/video/BV1ih4y1E7E3/

前言

本文將會通過一個加法計算,來實現(xiàn) Channel 的雙向通訊碟刺,讓大家有個一個體會。

Flutter插件

Flutter插件是Flutter應用程序與原生平臺之間的橋梁,使得Flutter應用程序可以與原生代碼進行交互,從而擴展Flutter應用程序的功能和能力。Flutter插件通常包括Dart和原生代碼(例如Java恩沛、Kotlin或Objective-C、Swift等)缕减,并可以通過Flutter插件框架來注冊雷客、管理和調(diào)用。

在整個Flutter架構(gòu)中桥狡,F(xiàn)lutter插件具有非常重要的作用和重要性搅裙。以下是Flutter插件在Flutter架構(gòu)中的一些重要作用:

  1. 擴展Flutter應用程序的功能:Flutter插件可以提供許多原生平臺的功能和能力,例如訪問原生設備API总放、訪問原生UI組件等呈宇。通過使用Flutter插件,F(xiàn)lutter應用程序可以獲得更多的功能和能力局雄,從而可以更好地滿足用戶需求甥啄。
  2. 提高Flutter應用程序的性能:通過使用Flutter插件,F(xiàn)lutter應用程序可以通過原生平臺API來執(zhí)行某些任務炬搭,從而可以提高應用程序的性能和響應速度蜈漓。例如,使用原生平臺的圖像處理庫來處理大量圖像數(shù)據(jù)宫盔。
  3. 與原生代碼進行交互:Flutter插件可以使Flutter應用程序與原生代碼之間進行雙向通信融虽,從而可以讓Flutter應用程序與原生平臺進行無縫集成。這對于需要與現(xiàn)有原生應用程序集成的Flutter應用程序來說尤為重要灼芭。
  4. 促進Flutter生態(tài)系統(tǒng)的發(fā)展:Flutter插件可以提供許多不同類型的功能和能力有额,例如訪問原生設備傳感器、訪問原生廣告庫等彼绷。通過將這些插件共享給其他Flutter開發(fā)者巍佑,F(xiàn)lutter插件可以促進Flutter生態(tài)系統(tǒng)的發(fā)展和壯大,使得更多的開發(fā)者能夠使用Flutter來構(gòu)建高質(zhì)量的應用程序寄悯。

Channel 通道

Channel是Flutter應用程序與原生平臺之間進行通信的橋梁萤衰。Flutter應用程序和原生平臺可以通過Channel來交換消息和數(shù)據(jù),從而實現(xiàn)雙向通信猜旬。Flutter插件通常包含一個或多個Channel脆栋,用于與原生代碼交互倦卖。

Channel在Flutter插件開發(fā)中的作用有以下幾個方面:

  1. 提供雙向通信:Channel提供了Flutter應用程序與原生平臺之間進行雙向通信的能力。Flutter應用程序可以向原生平臺發(fā)送消息和數(shù)據(jù)椿争,原生平臺也可以向Flutter應用程序發(fā)送消息和數(shù)據(jù)怕膛。
  2. 管理方法調(diào)用:Channel可以用于管理Flutter應用程序和原生平臺之間的方法調(diào)用。Flutter應用程序可以通過Channel調(diào)用原生平臺的方法丘薛,原生平臺也可以通過Channel調(diào)用Flutter應用程序的方法嘉竟。
  3. 實現(xiàn)數(shù)據(jù)傳輸:Channel可以用于在Flutter應用程序和原生平臺之間傳輸數(shù)據(jù)。Flutter應用程序可以通過Channel向原生平臺發(fā)送數(shù)據(jù)洋侨,原生平臺也可以通過Channel向Flutter應用程序發(fā)送數(shù)據(jù)舍扰。
  4. 擴展Flutter應用程序的功能:通過使用Channel,F(xiàn)lutter應用程序可以訪問原生平臺的功能和能力希坚,例如訪問原生設備API边苹、訪問原生UI組件等。這可以擴展Flutter應用程序的功能和能力裁僧,從而可以更好地滿足用戶需求个束。

原文 https://ducafecat.com/blog/flutter-plugin-channel

參考

https://docs.flutter.dev/packages-and-plugins/developing-packages

步驟

第一步:創(chuàng)建插件

使用 Android Studio 創(chuàng)建插件

項目類型 plugin

選的語言是 java object-c

平臺選了所有 all

創(chuàng)建完成后

目錄、文件名 說明
ios 原生
android 原生
linux 原生
macos 原生
windows 原生
lib/flutter_plugin_add_platform_interface.dart 功能接口定義
lib/flutter_plugin_add_method_channel.dart 原生功能接口實現(xiàn)
lib/flutter_plugin_add_web.dart Web功能接口實現(xiàn)
lib/flutter_plugin_add.dart flutter 接口調(diào)用類

第二步:編寫 android 代碼

首先我們用模擬器把 android 項目運行下聊疲,讓 android gradle 自動拉取依賴茬底。

選擇 example 來運行。

打開項目的正確目錄是 example/android获洲,而不是根目錄的 android阱表,否則依賴包認不出。

打開后能正常認出

如果認不出可以清下緩存

選取清除歷史和緩存文件

編寫加法計算

android/src/main/java/com/ducafecat/flutter_plugin_add/FlutterPluginAddPlugin.java

  @Override
  public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
    if (call.method.equals("getPlatformVersion")) {
      result.success("Android " + android.os.Build.VERSION.RELEASE);
    }

    // add
    else if (call.method.equals("add")) {
      int a = call.argument("a");
      int b = call.argument("b");
      int sum = add(a, b);
      result.success(sum);
    }

    else {
      result.notImplemented();
    }
  }
  1. Flutter應用程序通過MethodChannel向原生平臺發(fā)送方法調(diào)用請求時贡珊。
  2. 原生平臺收到Flutter應用程序的方法調(diào)用請求后最爬,根據(jù)請求的方法名執(zhí)行相應的方法后,將執(zhí)行結(jié)果返回給Flutter應用程序门岔。
  private int add(int a, int b) {
    return a + b;
  }

第三步:編寫 flutter 接口代碼

接口配置

pubspec.yaml

  plugin:
    platforms:
      android:
        package: com.ducafecat.flutter_plugin_add
        pluginClass: FlutterPluginAddPlugin
      ios:
        pluginClass: FlutterPluginAddPlugin
      linux:
        pluginClass: FlutterPluginAddPlugin
      macos:
        pluginClass: FlutterPluginAddPlugin
      windows:
        pluginClass: FlutterPluginAddPluginCApi
      web:
        pluginClass: FlutterPluginAddWeb
        fileName: flutter_plugin_add_web.dart

platforms 部分定義了 Flutter 插件在以下不同平臺上的支持:

  1. android:定義了Flutter插件在Android平臺上的支持爱致,包括插件的Java包名和插件的類名。
  2. ios:定義了Flutter插件在iOS平臺上的支持寒随,包括插件的類名糠悯。
  3. linux:定義了Flutter插件在Linux平臺上的支持,包括插件的類名妻往。
  4. macos:定義了Flutter插件在macOS平臺上的支持互艾,包括插件的類名。
  5. windows:定義了Flutter插件在Windows平臺上的支持蒲讯,包括插件的類名和插件的C API實現(xiàn)。
  6. web:定義了Flutter插件在Web平臺上的支持灰署,包括插件的類名和插件的文件名判帮。

編寫接口定義

lib/flutter_plugin_add_platform_interface.dart

  Future<int?> add(int a, int b) {
    throw UnimplementedError('add() has not been implemented.');
  }

原生端接口調(diào)用

lib/flutter_plugin_add_method_channel.dart

  @override
  Future<int?> add(int a, int b) async {
    final val = await methodChannel.invokeMethod<int>(
      'add',
      <String, int>{
        'a': a,
        'b': b,
      },
    );
    return val;
  }

flutter 接口調(diào)用類

lib/flutter_plugin_add.dart

  Future<int?> add(int a, int b) {
    return FlutterPluginAddPlatform.instance.add(a, b);
  }

第四步:編寫測試例子

example/lib/main.dart

class _MyAppState extends State<MyApp> {
  int addResult = 0;
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: [
              Text('Running on: $_platformVersion\n'),

              // 加法
              Text('add: $addResult'),
              ElevatedButton(
                onPressed: () async {
                  int? val = await _flutterPluginAddPlugin.add(addResult, 1);
                  setState(() {
                    addResult = val ?? -1;
                  });
                },
                child: const Text('add'),
              ),
            ],
          ),
        ),
      ),
    );
  }

_flutterPluginAddPlugin.add 的方式調(diào)用我們寫的接口

第五步:編寫 ios 代碼

運行下 ios 自動拉取包局嘁,或者手動 pod 拉包

$ cd ios
$ pod install

使用 xcode 打開 example / ios 目錄

打開插件代碼

寫入加法代碼

ios/Classes/FlutterPluginAddPlugin.m

- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([@"getPlatformVersion" isEqualToString:call.method]) {
    result([@"iOS " stringByAppendingString:[[UIDevice currentDevice] systemVersion]]);
  }
  
  else if ([@"add" isEqualToString:call.method]) {
      int a = [call.arguments[@"a"] intValue];
      int b = [call.arguments[@"b"] intValue];
      result(@(a + b));
  }

  else {
    result(FlutterMethodNotImplemented);
  }
}

運行測試

代碼

https://github.com/ducafecat/flutter_develop_tips/tree/main/flutter_plugin_add

小結(jié)

Flutter插件在Flutter應用程序開發(fā)中具有非常重要的作用和重要性,F(xiàn)lutter開發(fā)者應該熟悉和掌握Flutter插件的開發(fā)和使用晦墙。

大家需要注意這幾點:

  • 插件 channel 執(zhí)行過程
  • 如何正確的打開原生項目
  • android ios 源碼位置
  • 哪些重要的函數(shù)
  • flutter 中如何配置接口
  • flutter 中編寫接口定義代碼

感謝閱讀本文

如果我有什么錯悦昵?請在評論中讓我知道。我很樂意改進晌畅。


? 貓哥
ducafecat.com

end

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末但指,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子抗楔,更是在濱河造成了極大的恐慌棋凳,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,366評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件连躏,死亡現(xiàn)場離奇詭異剩岳,居然都是意外死亡,警方通過查閱死者的電腦和手機入热,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,521評論 3 395
  • 文/潘曉璐 我一進店門拍棕,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人勺良,你說我怎么就攤上這事绰播。” “怎么了尚困?”我有些...
    開封第一講書人閱讀 165,689評論 0 356
  • 文/不壞的土叔 我叫張陵蠢箩,是天一觀的道長。 經(jīng)常有香客問我尾组,道長忙芒,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,925評論 1 295
  • 正文 為了忘掉前任讳侨,我火速辦了婚禮呵萨,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘跨跨。我一直安慰自己潮峦,他們只是感情好,可當我...
    茶點故事閱讀 67,942評論 6 392
  • 文/花漫 我一把揭開白布勇婴。 她就那樣靜靜地躺著忱嘹,像睡著了一般。 火紅的嫁衣襯著肌膚如雪耕渴。 梳的紋絲不亂的頭發(fā)上拘悦,一...
    開封第一講書人閱讀 51,727評論 1 305
  • 那天,我揣著相機與錄音橱脸,去河邊找鬼。 笑死,一個胖子當著我的面吹牛让禀,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播医寿,決...
    沈念sama閱讀 40,447評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼蘑斧!你這毒婦竟也來了靖秩?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,349評論 0 276
  • 序言:老撾萬榮一對情侶失蹤竖瘾,失蹤者是張志新(化名)和其女友劉穎沟突,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體准浴,經(jīng)...
    沈念sama閱讀 45,820評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡事扭,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,990評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了乐横。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片求橄。...
    茶點故事閱讀 40,127評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖葡公,靈堂內(nèi)的尸體忽然破棺而出罐农,到底是詐尸還是另有隱情,我是刑警寧澤催什,帶...
    沈念sama閱讀 35,812評論 5 346
  • 正文 年R本政府宣布涵亏,位于F島的核電站,受9級特大地震影響蒲凶,放射性物質(zhì)發(fā)生泄漏气筋。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,471評論 3 331
  • 文/蒙蒙 一旋圆、第九天 我趴在偏房一處隱蔽的房頂上張望宠默。 院中可真熱鬧,春花似錦灵巧、人聲如沸搀矫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,017評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽瓤球。三九已至,卻和暖如春敏弃,著一層夾襖步出監(jiān)牢的瞬間卦羡,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,142評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留绿饵,地道東北人逝薪。 一個月前我還...
    沈念sama閱讀 48,388評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像蝴罪,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子步清,可洞房花燭夜當晚...
    茶點故事閱讀 45,066評論 2 355

推薦閱讀更多精彩內(nèi)容