Package 介绍
使用package可以创建可轻松共享的模块化代码。一个最小的package包括
- 一个
pubspec.yaml
文件:声明了package的名称、版本、作者等的元数据文件。 - 一个
lib
文件夹:包括包中公开的(public)代码,最少应有一个<package-name>.dart
文件
Package 类型
Packages可以包含多种内容:
- Dart包:其中一些可能包含Flutter的特定功能,因此对Flutter框架具有依赖性,仅将其用于Flutter,例如
fluro
包。 - 插件包:一种专用的Dart包,其中包含用Dart代码编写的API,以及针对Android(使用Java或Kotlin)和/或针对iOS(使用ObjC或Swift)平台的特定实现。一个具体的例子是
battery
插件包。
操作步骤:
Step 1:创建 enhance_stepper 本地工程
flutter create --template=package enhance_stepper
进入 enhance_stepper 文件夹,创建 example 工程
flutter create example
Step 2: 实现package
...
Step 3:关联到 github 并添加文档
github 上创建同名库,clone 到本地,将本地文件上传同步到 github。
建议将以下文档添加到所有软件包:
README.md:介绍包的文件
CHANGELOG.md 记录每个版本中的更改
LICENSE 包含软件包许可条款的文件
所有公共API的API文档 (详情见下文)
Step 4:检查是否可发布
flutter packages pub publish --dry-run --server=https://pub.dartlang.org
Step 5:发布
flutter packages pub publish --server=https://pub.dartlang.org
Step 6:上传成功, 并收到邮件通知
Successfully uploaded package.
如果是发布私有库/package,Step 3 结束后不发布即为私有库, 使用如下:
dependencies:
library_name:
git:
url: https://github.com/username/library_name.git
ref: dev #branch name
参考资料:
https://flutterchina.club/developing-packages/
https://flutter.cn/docs/development/packages-and-plugins/developing-packages
网友评论