代码视界

Hanpeng Chen的个人博客

Flutter | 4-包管理

本文于 830 天之前发表,文中内容可能已经过时。

包(Package)

在软件开发中,有一些公共的库或者SDK可能会被很多项目用到,因此,将这些代码单独抽到一个独立模块,然后哪个项目需要使用时直接集成这个模块,便可以大大提高开发效率。很多编程语言或开发工具都支持这种“模块共享”机制,比如Java语言中这种独立模块会被打成一个jar包,Android中的aar包,web开发中的npm包等等。为了表述方便,我们将这种可共享的独立模块统一称为“包”(Package)。

一个APP在实际开发中往往会依赖很多包,而这些包通常都有交叉依赖关系、版本依赖等,如果由开发者手动来管理应用中的依赖包将会非常麻烦。因此,各种开发生态或编程语言官方通常都会提供一些包管理工具,比如在Android提供了Gradle来管理依赖,iOS用Cocoapods或Carthage来管理依赖,Node中通过npm等。而在Flutter开发中也有自己的包管理工具。本节我们主要介绍一下flutter如何使用配置文件pubspec.yaml(位于项目根目录)来管理第三方依赖包。

YAML是一种直观、可读性高并且容易被人类阅读的文件格式,它和xml或Json相比,它语法简单并非常容易解析,所以YAML常用于配置文件,Flutter也是用yaml文件作为其配置文件。Flutter项目默认的配置文件是pubspec.yaml,我们看一个简单的示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
name: first_flutter_application
description: A new Flutter project.

version: 1.0.0+1

environment:
sdk: ">=2.1.0 <3.0.0"

dependencies:
flutter:
sdk: flutter
cupertino_icons: ^0.1.2

dev_dependencies:
flutter_test:
sdk: flutter

flutter:
uses-material-design: true

我们对上面的各个字段做个说明:

  • name:应用或包名称
  • description:应用或包的描述、简介
  • version:应用或包的版本号
  • dependencies:应用或包依赖的其他包或插件
  • dev_dependencies:开发环境依赖的工具包(不是Flutter应用本身依赖的包)
  • flutter:flutter相关的配置选项

如果我们的Flutter应用本身依赖某个包,我们需要将所依赖的包添加到dependencies 下,接下来我们通过一个例子来演示一下如何添加、下载并使用第三方包。

Pub仓库

Pub(https://pub.dev/) 是Google官方的Dart Packages仓库,类似于node的npm仓库,android的jcenter。

我们可以在Pub上面查找我们需要的包和插件,也可以向Pub发布我们的包和插件。

示例

假设我们需要实现一个轮播图的功能,在Pub仓库中有个“flutter_swiper”包已经实现该功能。我们首先在pub上找到flutter_swiper这个包(如下图所示),确定其最新的版本号和是否支持Flutter。

可以看到其最新版本是1.1.6,并且支持flutter。

1、下面我们将其添加到依赖列表中:

1
2
3
4
5
dependencies:
flutter:
sdk: flutter
cupertino_icons: ^0.1.2
flutter_swiper: ^1.1.6

2、下载包。用VS Code编辑器查看pubspec.yaml时,编辑器右上角有个下载包的按钮,如下图所示。

VS Code在pubspec.yaml依赖列表有修改的时候,会自动执行下载包命令,我们可以在输出窗口看到如下信息:

1
2
3
[3_first_flutter_application] flutter packages get
Running "flutter pub get" in 3_first_flutter_application... 14.6s
exit code 0

我们也可以在控制台,定位到当前工程目录,然后手动运行flutter packages get 命令来下载依赖包。另外,需要注意dependenciesdev_dependencies的区别,前者的依赖包将作为APP的源码的一部分参与编译,生成最终的安装包。而后者的依赖包只是作为开发阶段的一些工具包,主要是用于帮助我们提高开发、测试效率,比如flutter的自动化测试包等。

3、在前面创建的第一个Flutter应用的代码基础上,使用 flutter_swiper 实现轮播图功能

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
import 'package:flutter/material.dart';
import 'package:flutter_swiper/flutter_swiper.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Flutter Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: MyHomePage(title: 'Flutter Demo Home Page'),
);
}
}

class MyHomePage extends StatefulWidget {
MyHomePage({Key key, this.title}) : super(key: key);
final String title;

@override
_MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
int _counter = 0;

void _incrementCounter() {
setState(() {
_counter++;
});
}

@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
SizedBox(
height: 200,
width: 400,
child: Swiper(
itemBuilder: (BuildContext context, int index) {
return new Image.network("https://ss0.bdstatic.com/70cFuHSh_Q1YnxGkpoWK1HF6hhy/it/u=3228282522,4112292848&fm=26&gp=0.jpg", fit: BoxFit.fill);
},
itemCount: 3,
pagination: new SwiperPagination(),
control: new SwiperControl(),
),
)
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
child: Icon(Icons.add),
);
}
}

4、运行效果图如下:

其他依赖方式

上文所述的依赖方式是依赖Pub仓库的,但我们还可以依赖本地包和git仓库。

依赖本地包

如果我们正在本地开发一个包,包名为 hampton_pkg,我们可以通过下面的方式依赖:

1
2
3
dependencies:
hampton_pkg:
path: ../../code/hampton_pkg

包的路径可以是相对的,也可以是绝对的。

依赖Git

我们还可以依赖Git仓库中的包。如果软件包位于仓库的根目录下,可以通过下面的方式引入依赖:

1
2
3
4
dependencies:
hampton_pkg:
git:
url: git://github.com/xxx/hampton_pkg.git

上面假定包位于Git存储库的根目录中。如果不是这种情况,可以使用path参数指定相对位置,例如:

1
2
3
4
5
dependencies:
hampton_pkg:
git:
url: git://github.com/flutter/packages.git
path: packages/hampton_pkg

上面介绍的这些依赖方式是Flutter开发中常用的,但还有一些其它依赖方式,完整的内容大家可以自行查看:https://www.dartlang.org/tools/pub/dependencies

欢迎关注微信公众号: 『前端极客技术』『代码视界』
支付宝打赏 微信打赏

赞赏是不耍流氓的鼓励