Flutter插件详解及其发布插件

发表于 5年以前  | 总阅读数:12177 次

Flutter插件详解及其发布插件

前言 

                  Flutter提供了和原生做交互的方式,有了和原生交互这个功能,我们就可以达到Flutter调用原生平台的相关功能的目的。换句话说,Flutter做不到的事(比如:设备有关的、第三方SDK、长连接等),我们都可以通过Flutter与原生交互来做到,其中插件的编写是必不可少的一个过程,所以我们一定要掌握插件的编写。 

有人会说:“网上不是有很多插件库吗?” 没错!但是如果别人写的插件功能没有你想要的功能怎么办?如果插件与你本地不兼容怎么办?如果你的项目急用一个功能,网上找不到插件库怎么办?那么这个时候学会自己编写插件库就非常有必要了!                       

    本文的源码发布在GitHub上,如果有什么问题,欢迎留言。        

https://github.com/AweiLoveAndroid/flutter_device_information

下面详细的讲解一下Flutter如何创建一个插件,让大家快速学会自己写一个插件。同时在这里也教大家上传到Pub库,让大家也体验一把自己的库被别人使用的自豪感和成就感。

1 Flutter调用原生平台交互过程

这里以调用原生平台设备信息为例做讲解。手把手教大家写一个Flutter插件。Flutter中通过MethodChannel和原生平台做交互。如图所示:

2 创建Flutter Plugin插件项目

如果是使用Android Studio/Intellij IDEA创建项目,截图如下:

如果使用命令行的方式,可以使用 flutter create 命令行创建,项目名称放在最后,具体命令如下所示:

flutter create --org com.awei --template=plugin -a java --description "A Flutter plugin for using devices informations in Android" flutter_device_information
▲ 左右滑动查看更多

常用的命令参数如下:

  • --org:定义项目的组织结构             
  •  -a:用什么语言编写Android代码           
  •  --description:插件的描述 
  •  -i:用什么语言编写iOS代码             

上面那个命令的意思是:创建一个插件,包名为“com.awei”,指定Android代码使用Java语言编写,插件项目名称为“flutter_device_information”,项目描述为:“A Flutter plugin for using devices informations in Android”。

3 完整的目录结构

下面看一下完整的目录结构,如下图所示:

其中:

 “android”目录:是插件API在Android平台的实现。           

 “ios”目录:是插件API在iOS平台的实现。     

 “example”目录:是使用插件的一个示例项目。

 “lib”目录里面的文件:主要是创建“MethodChannel”,然后接收并处理来自原生平台发来的消息。      

4 插件编写步骤

1.创建MethodChannel对象

打开 flutter_device_information.dart 文件,开始创建 MethodChannel 对象,参数是自己协定的,后面的原生平台需要用到的这个参数,每一个 MethodChannel 对象的这个参数是唯一的标识符,必须记住。如下所示:

import 'package:flutter/services.dart';
class FlutterDeviceInformation {
   static const MethodChannel _channel =
   const MethodChannel('com.awei.devices/flutter_device_information');
}

2.Android端接收消息并做出相应的处理   

打开文件 FlutterDeviceInformationPlugin.java,然后接收MethodChannel 传过来的消息。如下所示:

 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
 import io.flutter.plugin.common.MethodChannel.Result;
 import io.flutter.plugin.common.PluginRegistry.Registrar;



 7public class FlutterDeviceInformationPlugin implements MethodCallHandler {

  /**

  * Plugin registration. 插件注册

  */

  public static void registerWith(Registrar registrar) {

    final MethodChannel channel = new MethodChannel(

    registrar.messenger(), " com.awei.devices/flutter_device_information ");

    // 设置setMethodCallHandler回调  处理Flutter端的调用

    channel.setMethodCallHandler(new FlutterDeviceInformationPlugin());

  }



  @Override

  public void onMethodCall(MethodCall call, Result result) {

    if (call.method.equals("getPlatformVersion")) {

      result.success("Android " + android.os.Build.VERSION.RELEASE);

    }  else {

      result.notImplemented();

    }

  }

}

其中:registerWith 函数是Plugin registration. 插件注册,它里面设置setMethodCallHandler回调 处理Flutter端的调用。 FlutterDeviceInformationPlugin 类实现 MethodCallHandler 接口,重写方法 onMethodCall,MethodCall 和 Result 主要是用来执行相关的逻辑判断。

3.Dart代码获取原生平台的消息       

打开 flutter_device_information.dart 文件,其中的platformVersion函数获取的是原生平台的系统版本号:

 import 'package:flutter/services.dart';

 import 'dart:async';



 class FlutterDeviceInformation {

   // 获取的是原生平台的系统版本号

   static Future<String> get platformVersion async {

     final String version = await _channel.invokeMethod('getPlatformVersion');

     return version;

   }

}

4.Dart代码调用插件里面的Dart代码       

打开 main.dart 文件:

 import 'dart:async';



 import 'package:flutter/material.dart';

 import 'package:flutter/services.dart';

 import 'package:flutter_device_information/flutter_device_information.dart';



 void main() => runApp(MyApp());



 class MyApp extends StatefulWidget {

  @override

  _MyAppState createState() => return _MyAppState();

}



class _MyAppState extends State<MyApp> {

  String _platformVersion = 'Unknown';



  @override

  void initState() {

    super.initState();

    initPlatformState();

  }



  // Platform messages are asynchronous, so we initialize in an async method.

  Future<void> initPlatformState() async {

    String platformVersion;



    // Platform messages may fail, so we use a try/catch PlatformException.

    try {

      platformVersion = await FlutterDeviceInformation.platformVersion;

    } on PlatformException {

      platformVersion = 'Failed to get platform version.';

    }



    // If the widget was removed from the tree while the asynchronous platform

    // message was in flight, we want to discard the reply rather than calling

    // setState to update our non-existent appearance.

    if (!mounted) return;



    setState(() {

      _platformVersion = platformVersion;

    });

  }



  @override

  Widget build(BuildContext context) {

    return MaterialApp(

      home: Scaffold(

        appBar: AppBar(

          title: const Text('Plugin example app'),

        ),

        body: Center(

          child: Text('Running on: $_platformVersion'),

        ),

      ),

    );

  }

}

上面代码定义了一个变量“_platformVersion”,用于存储版本号信息。“initPlatformState ()”函数是异步的,用于接收来自平台的消息,里面有一个局部变量“platformVersion”。“try...catch”语句是捕获异常。“setState((){...})”函数把我们获取到的“platformVersion”赋值给“_platformVersion”,来更新“_platformVersion”的值。

5.新增和完善插件代码       

上述代码中,只是默认创建的示例代码,下面来看看在 flutter_device_information.dart 中新增函数,获取Android的其它设备信息。新增的代码如下:

 static Future<String> get sdkInt async {

   final String version = await _channel.invokeMethod('getSDKINT');

   return version;

 }



 static Future<String> get board async {

   final String version = await _channel.invokeMethod('getBoard');

   return version;

 }



static Future<String> get brand async {

  final String version = await _channel.invokeMethod('getBrand');

  return version;

}



static Future<String> get model async {

  final String version = await _channel.invokeMethod('getModel');

  return version;

}



static Future<String> get CPUABI async {

  final String version = await _channel.invokeMethod('getCPUABI');

  return version;

}

▲ 左右滑动查看更多

6.新增和完善原生平台代码       

修改 FlutterDeviceInformationPlugin.java 文件,如下所示:

 import 'dart:async';



 if (call.method.equals("getPlatformVersion")) {

   result.success("Android release系统版本(字符串类型):" + android.os.Build.VERSION.RELEASE);

 } else if(call.method.equals("getSDKINT")){

   result.success("Android API版本(int类型):" + android.os.Build.VERSION.SDK_INT);

 } else if(call.method.equals("getBoard")){

   result.success("主板型号:" + android.os.Build.BOARD);

 } else if(call.method.equals("getBrand")){

  result.success("产品品牌(or系统制造商):" + android.os.Build.BRAND);

} else if(call.method.equals("getModel")){

  result.success("手机的型号/设备名称:" + android.os.Build.MODEL);

} else if(call.method.equals("getCPUABI")){

  result.success("设备指令集名称(CPU的类型):" + android.os.Build.CPU_ABI);

} else {

  result.notImplemented();

}

5 发布插件到Pub库

下面讲一下如何把插件发布到Pub库。

1.运行“flutter packages pub publish --dry run”

首先运行“flutter packages pub publish --dry run”命令,查看是否所有内容都通过分析。(需要翻墙)但是:如果设置了国内镜像,这个命令经常会出错,为了避免出错,建议在命令后面加上服务器地址,命令如下所示:

flutter packages pub publish --server=https://pub.dartlang.org

▲ 左右滑动查看更多

2.然后按提示输入“y/n”,输入“y”,回车

3.然后把命令行出现的网址复制到浏览器打开

4.耐心等待,出现Successfully uploaded package表示上传成功

5.我们可以在Pub上面搜索我们的库

例如:刚发的的库的地址为:

https://pub.dartlang.org/packages/flutter_device_information

6.库的API文档会自动发布到dartdocs.org

例如:我们刚才发布的库的API文档地址为:

https://pub.dartlang.org/documentation/flutter_device_information/latest/ 

 

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
如何有效定位Flutter内存问题? 4年以前  |  16339次阅读
鸿蒙系统起飞!Flutter 完全适配指南 2年以前  |  12765次阅读
Flutter的手势GestureDetector分析详解 5年以前  |  12438次阅读
Flutter插件详解及其发布插件 5年以前  |  12178次阅读
 目录