【Flutter】开发 Flutter 包和插件 ( 开发 Dart 插件包 | 发布 Dart 插件包 )（一）

文章目录

前言

一、开发 Dart 包内容

二、配置 pubspec.yaml

三、编写 Dart 包使用说明

四、编写 Dart 包授权许可

五、设置版本变更记录

六、验证 Dart 包正确性

七、将 Dart 包推送到中央仓库中

前言

上一篇博客 【Flutter】开发 Flutter 包和插件 ( Flutter 包和插件简介 | 创建 Flutter 插件 | 创建 Dart 包 ) 三、创建 Dart 包

1、Android Studio 中可视化创建 中 , 创建了 Dart 包 ;

本篇博客中 , 开发该 Dart 包 , 并将其发布到 Flutter 公共仓库中 ;

一、开发 Dart 包内容

创建完毕之后 , 自动生成了一个 flutter_package.dart 源码文件 , 内容是

library flutter_package;
/// A Calculator.
class Calculator {
  /// Returns [value] plus 1.
  int addOne(int value) => value + 1;
}

实现了一个简单计算功能 , 导入该包后 , 调用 addOne 方法 , 就会将传入的参数 +1 返回 ;

这里保持不变 ;

二、配置 pubspec.yaml

在 pubspec.yaml 中配置该项目 :

# Dart 包名称
name: flutter_package
# 描述
description: A new Flutter project.
# 版本号
version: 0.0.1
# 主页 , 一般是 GitHub 的地址
homepage:
# 所需的环境
environment:
  sdk: ">=2.12.0 <3.0.0"
  flutter: ">=1.17.0"
# 依赖关系
dependencies:
  flutter:
    sdk: flutter

三、编写 Dart 包使用说明

一般在 Flutter 包中央仓库中 , 搜索到某个 Flutter 包或插件 , 显示的内容就是 Flutter 包 / 插件的工程根目录的 README.md 文档 ;

一般将插件的使用说明 , 写在该文档中 ;

四、编写 Dart 包授权许可

修改根目录下的 LICENSE 许可 ;

随便找个 Flutter 插件 , 复制一份即可 ;

该协议不是必须的 ;

五、设置版本变更记录

在 CHANGELOG.md 中 , 设置每个版本的变更记录 , 具体就是某个版本更新后 , 更新了哪些内容 , 修改了哪些内容 ;

六、验证 Dart 包正确性

先运行如下命令 , 检查该 Flutter 包是否正常 ;

flutter packages pub publish --dry-run

运行后正常 :

D:\002_Project\002_Android_Learn\flutter_package>flutter packages pub publish --dry-run
Publishing flutter_package 0.0.1 to https://pub.flutter-io.cn:
|-- .gitignore
|-- .metadata
|-- CHANGELOG.md
|-- LICENSE
|-- README.md
|-- lib
|   '-- flutter_package.dart
|-- pubspec.yaml
'-- test
    '-- flutter_package_test.dart
Package has 0 warnings.