目录
- 创建package
- package结构
- package发布
- package使用
- 常见问题
1,创建package
创建package的方法有两种:
- 可视化
- 命令行
可视化
使用AndroidStudio 创建
在第二步选择创建package的类型
两种方式的差别在,dart包是只写纯flutter的代码,plugin是包含其他平台代码。比如要写一个定位功能,必须要基于平台做相应的工作,这时候就需要用插件的方式;如果单纯的就是一些Dart 的常用工具,或者一些View组件的封装,则只需dart包就可以了
命令行
创建Dart包 flutter create --template=package dartPackageName
创建plugin包 flutter create --org com.example --template=plugin --platforms=android,ios -a kotlin -i swift pluginPackageName
参数: --org:指定您的组织,使用反向域名表示法 --template: 指定是纯Dart包还是Plugin包 --platforms: 代表指定插件支持的平台 可用的平台有:android、ios、web、linux、macos 和windows -a 指定Android平台所使用的语言 java、kotlin -i 指定iOS平台所支持的语言 objc、swift
2,package结构
2.1 纯Dart包 包含的文件
LICENSE 文件: 许可证文件。
test/flutter_package_first_test.dart文件: Package 的 单元测试 文件。
.gitignore 文件 告诉 git 系统应该隐藏哪些文件或文件夹的一个隐藏文件。
pubspec.yam*l 文件 pub 工具需要使用的,包含 package 依赖的 yaml 格式的文件。*
README.md 文件 起步文档,用于描述 package。
lib/flutter_package_first.dart 文件 ## package 的 Dart 实现代码
CHANGELOG.md 文件 用于记录 package 的版本变更
2.2 Plugin包 包含的文件
lib/flutter_plugin.dart Dart 插件 API 实现。
android/src/main/java/com/example/flutter_plugin/FlutterPlugin Android 平台原生插件 API 实现(使用 Kotlin 编程语言)。
ios/Classes/FlutterPlugin.m iOS 平台原生插件 API 实现(使用 Objective-C 编程语言)。
example/ 一个依赖于该插件并说明了如何使用它的 Flutter 应用。
3,package发布
3.1 发布地址
- 发布到: pub.dev. 也就是官网
- 发布到私库
3.1.1发布到官网
这个就是简单的一个发布,不在此进行详述了。
3.1.2发布到私库
首先要搭建自己的私库
3.2 发布的配置:
pubspec.yaml
pubspec.yaml配置文件的配置:
name: xxxx ## pub库名称
version: 0.0.1 ## 当前插件版本 确保每次发布与之前的版本不一致
description: xxxxxxxxx ## pub库简介
homepage:https://github.com/xxxx ## pub库git地址
publish_to:http://pub.100tal.com/ ## 私有pub库上传地址 如果不是私有pub仓库 不用配置
author:xxxxxx@100tal.com ## pub库作者
3.3 发布操作
检测配置文件: flutter packages pub publish --dry-run
检测成功后:
发布 flutter packages pub publish
输入y
4. package使用
4.1 依赖pub.dev仓库的package包
flutter_plugin:
git: url: https://github.com/xxxxxx/xxxxxx.git #git仓库地址
path: xxxxx #如果项目不是在git地址的根目录 则需要指定path
ref: ‘1.0.0’ #指定的版本 对应git仓库中的tag标签 也可以指定分支 ref: some-branch
eg:
4.2 依赖私有pub仓库的package包
flutter_plugin
hosted:
name:flutter_plugin
url:https://xxxxx
eg:
4.3 依赖本地package
flutter_pub: path: …/ #可以是相对路径 也可以是绝对路径
5. 常见问题
5.1 私库打包的时候,需要使用安装my.dart.snapshot(私库安装的时候生成的),而平时拉包的时候使用 pub.dart.snapshot;来回切换太麻烦了,怎么办?
flutter打包其实是使用的flutter sdk下面的pub文件,该文件位于${flutterSDK Path}/bin/cache /dart-sdk/bin下,打开pub文件可以发现
知道这个原理后,我们就可以,复制一份pub 文件,然后命名为pub2
然后修改pub2中的代码,指定打包文件为my.dart.snapshot
;
然后将环境变量配置到这个目录下面,后续打包的时候,只需要执行命令
pub2 publish
就可以打包了
参考文献:
https://www.xujun.org/note-131757.html