Flutter package 插件开发

一.Package类型

  • Dart packages:用Dart编写的通用包,其中一些可能包含Flutter特定的功能,因此依赖于Flutter框架,仅可用于Flutter,例如fluro包。
  • Plugin packages:一种专用的Dart包,其中包含一个用Dart代码编写的API以及一个或多个特定于平台的实现,例如url_launcher包。

二.开发Dart packages

1.创建包

flutter create --template=package hello

2.直接在hello/lib下进行flutter平台的代码开发。

三.开发Plugin packages

1.创建包

--platforms=后面表示插件支持的平台,可用的平台有:androidiosweblinuxmacoswindows

--org用于生成插件的包标识符。

-a表示android支持的语言,默认为kotlin

-i表示ios支持的语言,默认为swift

flutter create --org com.example --template=plugin --platforms=android,ios -i swift -a kotlin hello

2.添加ios平台代码

<1>确保代码至少已经构建过一次:
cd hello/example
flutter clean
flutter build ios --no-codesign
<2>启动Xcode:hello/example/ios/Runner.xcworkspace,开始编辑ios平台代码。
<3>添加第三方依赖Pods/Development Pods/hello/Pod/hello.podspec:
Pod::Spec.new do |s|
  # lines skipped
  s.dependency 'MTBBarcodeScanner'

添加完成后pod install

<4>插件代码位于Pods/Development Pods/hello/../../example/ios/.symlinks/plugins/hello/ios/Classes下。

遵守FlutterPlatformViewFactory协议的文件:

import UIKit

class BarcodeScannerFactory: NSObject, FlutterPlatformViewFactory {
    private var messenger: FlutterBinaryMessenger?
    
    init(messenger: FlutterBinaryMessenger) {
        super.init()
        self.messenger = messenger
    }
    
    func create(withFrame frame: CGRect, viewIdentifier viewId: Int64, arguments args: Any?) -> FlutterPlatformView {
        /// 注:frame和viewId获取不到,frame为zero,viewId为0
        return BarcodeScannerView(
            frame: frame,
            viewIdentifier: viewId,
            arguments: args,
            binaryMessenger: messenger
        )
    }
    
    func createArgsCodec() -> FlutterMessageCodec & NSObjectProtocol {
        return FlutterStandardMessageCodec(readerWriter: FlutterStandardReaderWriter())
    }
}

遵守FlutterPlatformView协议的文件:

import UIKit
import MTBBarcodeScanner

class BarcodeScannerView: NSObject, FlutterPlatformView {
    private var scannerView: UIView!
    private var scanner: MTBBarcodeScanner!
    
    init(
        frame: CGRect,
        viewIdentifier viewId: Int64,
        arguments args: Any?,
        binaryMessenger messenger: FlutterBinaryMessenger?
    ) {
        super.init()
        scannerView = UIView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
        scanner = MTBBarcodeScanner(previewView: scannerView)
        do {
            try scanner.startScanning(resultBlock: { _ in })
        } catch {}
    }
    
    func view() -> UIView {
        return scannerView;
    }
}

在插件中注册FlutterPlatformViewFactory

import Flutter
import UIKit

class BarcodeScannerPlugin: NSObject, FlutterPlugin {
    public static func register(with registrar: FlutterPluginRegistrar) {
        registrar.register(BarcodeScannerFactory(messenger: registrar.messenger()), withId: "view_type_id_scanner_view")
    }
}

3.添加android平台代码

<1>运行example文件代码

构建依赖:

cd hello/example
flutter pub get

Android Studio->File->Open,选择hello/example/android/build.gradle启动并运行。

<2>启动Android Studio:hello/android,开始编辑android平台代码。
<3>添加第三方依赖Gradle Scripts/build.gradle(Module:android.hello):
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    /// 添加第三方库
    implementation 'me.dm7.barcodescanner:zxing:1.9.13'
}

<4>插件代码位于hello/java/下。

若出现Unresolved reference: io.flutter,选择File->Invalidate Caches/Restart...

继承混合类PlatformViewFactory的文件:

import android.content.Context
import io.flutter.plugin.common.BinaryMessenger
import io.flutter.plugin.common.StandardMessageCodec
import io.flutter.plugin.platform.PlatformView
import io.flutter.plugin.platform.PlatformViewFactory

class BarcodeScannerFactory(private var messenger: BinaryMessenger) : PlatformViewFactory(StandardMessageCodec.INSTANCE) {
    override fun create(context: Context, viewId: Int, args: Any?): PlatformView {
        return BarcodeScannerView(messenger, context, viewId, args)
    }
}

继承混合类PlatformView的文件:

import android.content.Context
import android.view.View
import io.flutter.plugin.common.BinaryMessenger
import io.flutter.plugin.platform.PlatformView
import me.dm7.barcodescanner.zxing.ZXingScannerView

class BarcodeScannerView(binaryMessenger: BinaryMessenger, context: Context, viewId: Int, args: Any?) : PlatformView {
    private var scannerView = ZXingScannerView(context)

    init {
        scannerView.startCamera()
    }

    override fun getView(): View {
        return scannerView
    }

    override fun dispose() {}
}

在插件中注册PlatformViewFactory

override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
    flutterPluginBinding.platformViewRegistry.registerViewFactory("view_type_id_scanner_view", BarcodeScannerFactory(flutterPluginBinding.binaryMessenger))
  }

4.添加flutter平台代码

代码位于hello/lib:

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

class BarcodeScanner extends StatelessWidget {
  const BarcodeScanner({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    const String viewType = 'view_type_id_scanner_view';
    const Map<String, dynamic> creationParams = {'name': '张三'};

    switch (defaultTargetPlatform) {
      case TargetPlatform.android:
        return const AndroidView(
          viewType: viewType,
          creationParams: creationParams,
          creationParamsCodec: StandardMessageCodec(),
        );
      case TargetPlatform.iOS:
        return const UiKitView(
          viewType: viewType,
          creationParams: creationParams,
          creationParamsCodec: StandardMessageCodec(),
        );
      default:
        return const Text('暂不支持该平台');
    }
  }
}

四.插件发布

1.完善pubspec.yaml文件

name: 插件名称  
description: 插件描述  
version: 插件版本号,0.0.1 
author: 作者,xxxx<xx@xxx.com>  
homepage: 项目主页地址  
publish_to: 填写私有服务器的地址(如果是发布到flutter pub则不用填写,插件默认是上传到flutter pub)

2.检验是否可以发布

flutter packages pub publish --dry-run 

--dry-run 参数表示本次执行会检查插件的配置信息是否有效,插件是否满足上传条件。如果成功的话并不会真正的将插件上传,而是会显示本次要发布插件的信息,并提示成功。一般在插件的正式发布前,建议先执行该命令,避免在上传过程中出现错误。

3.正式发布

发布到pub平台:

flutter packages pub publish 

发布到私有服务器:

flutter packages pub publish --server $服务器地址  

pubspec.yaml文件中列出的包作者与授权发布该包的人员列表不同。发布某个软件包的第一个版本的人自动成为第一个也是唯一一个有权上传其他版本软件包的人。要允许或禁止其他人上载版本,请使用pub uploader命令。

五.iOSpodspec文件

1.Podfilepodspec的区别

  • Podfile指的是将本地或远端的库导入到该工程。
  • podspec指的是依赖于该库,若该库在本地没有,会先去cocoapods下载导入到该工程。

2.podsepc依赖于git

podsepc文件中的s.dependency只能依赖于cocoapods中的版本,而不能依赖于git库。可使用以下方法解决。

事例:依赖于IMKitgithttps://github.com/imkit/imkit-ios-framework-v3.git

<1>在插件工程的podsepc文件中依赖:

s.dependency 'IMKit'

<2>在项目工程的Podfile文件中导入:

target 'Runner' do
  use_frameworks!
  use_modular_headers!
  
  pod 'IMKit', :git => 'https://github.com/imkit/imkit-ios-framework-v3.git'
end

3.podsepc依赖于cocoapods的静态framework库

事例:依赖于静态库PrintSDK.framework

<1>在插件工程的podsepc文件中依赖:

# 使用静态库
s.static_framework = true
# 依赖第三方的framework
s.dependency 'PrinterSDK'
# 依赖系统库(可选)
s.frameworks = 'UIKit', 'SystemConfiguration'
# Xcode里面Build Settings ->Other Linker Flags设置-ObjC(可选)
s.pod_target_xcconfig = { 'OTHER_LDFLAGS' => '-lObjC' }

若不设置s.static_framework = true,会报错:The 'Pods-Runner' target has transitive dependencies that include statically linked binaries

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容