Flutter Dart Package开发及发布到pub,实例popup_menu

作为一个开发人员,我们不仅要会用第三方代码,更重要的是能开发出自己的库,供他人使用,在这个过程中可以学到很多东西。

Flutter 包管理

Dart的包管理pub可以很方便的管理flutter项目中的第三方依赖。这上面可以找到用于Flutter和Web的各种第三方的库。

Flutter Package的分类

分为两种类型,引用官方的说明如下:

Dart packages: 用Dart开发的包,例如path。这里面有些依赖Flutter framework,并包含一些Flutter特有的方法,这种只能用在Flutter中,例如:fluro。(即如果不包含Flutter framework, 则可以用在dart相关的其它项目上)

Plugin packages: 一个包含Dart API及Android和iOS平台实现的包。例如:battery。(所以如果要引用平台相关的api时,就要开发一个Plugin package,并同时实现Android和iOS的相关功能)

如何开发一个自己的软件包

首先建议看一下官方的教程,不看也没关系,下面我会把步骤写出来。

这篇文章主要讲Dart package的开发以及发布到pub过程中遇到的一些问题。

第一步 创建package工程

打开terminal.

flutter create --template=package popup_menu

这会创建一个纯package的工程,没有example工程。这是不科学的,所以我们要自己在popup_menu目录下再创建一个example工程。

第二步 创建example工程

cd popup_menu
flutter create example

第三步 实现你的package

在第一步创建的package项目下的lib目录里面去实现你的package


03.png

这是我实现的popup_menu的效果图。

第四步 添加License和修改pubspec.yaml文件

License

PopupMenu

MIT License

Copyright (c) 2019 chinabrant

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
......

pubspec.yaml

name: popup_menu
description: A Flutter popup menu.Writted with pure dart, supported both iOS and Android.
version: 1.0.1
author: chinabrant 
homepage: https://github.com/chinabrant/popup_menu

这是package的基本设置,其它的sdk版本看自己的需求设置。

注意

  • author:名称后面的邮箱一下要加上,不然后面检查会不通过.
  • description:的长度要不少于70个字符,不然也会警告。
  • 代码实现中的所有警告和pubspec.yaml文件里面的警告都会影响pub发布后的Overall Score.如果这个分数变红了,我想不会有人愿意用你的库的,至少我是这么想的。所以代码写完后,最好format一下,命名都要规范。
  • 文档注释要用 /// 不要用 /** */

我第一次发布出去是一个红色的分数,后面按pub上的提示改了一次。还有一个文档注释的减分


1111.png

第五步 发布

发布前用命令检查

flutter pub pub publish --dry-run

发布

flutter pub publish

注意

  • 如果是没有翻墙的,在.bash_profile里面设置了 PUB_HOSTED_URLFLUTTER_STORAGE_BASE_URL 的记得注释掉这两个环境变量。
#export PUB_HOSTED_URL=https://pub.flutter-io.cn
#export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn
  • flutter pub publish的时候要翻墙。请确保终端翻墙了。 (ping www.google.com)如果是通的,则可以执行。如果终端没有翻墙可以搜索一下 proxifier

结果:

Looks great! Are you ready to upload your package (y/n)? y
Uploading...
Successfully uploaded package.

如果环境都正常,上面的确认步骤还是很快的。

最后

再推荐一下我的popup_menu

你可能感兴趣的:(Flutter Dart Package开发及发布到pub,实例popup_menu)