第二章: 第一个Flutter应用 2.5 包管理

跟随《Flutter实战·第二版》学习,建议直接看原书

在软件开发中,很多时候有一些公共的库或 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,我们看一个简单的示例:

name: flutter_in_action
description: First Flutter Application.

version: 1.0.0+1

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 发布我们的包和插件

示例

接下来,我们实现一个显示随机字符串的 widget。有一个名为 “english_words” 的开源软件包,其中包含数千个常用的英文单词以及一些实用功能
首先在 pub上找到 english_words 这个包,确定其最新的版本号和是否支持 Flutter

pub: https://pub.dev/或
https://pub.flutter-io.cn

image.png

看到“english_words”包最新的版本是4.0.0,并且支持flutter,接下来:

  1. 将“english_words” 添加到依赖项列表,如下:
dependencies:
  flutter:
    sdk: flutter

    #新添加的依赖
    english_words: ^4.0.0
  1. 下载包。在Android Studio的编辑器视图中查看pubspec.yaml时,单击右上角的 Pub get


    image.png

这会将依赖包安装到您的项目。我们可以在控制台中看到以下内容:

flutter packages get
Running "flutter packages get" in flutter_in_action...
Process finished with exit code 0

PS: 本人在点击 Pub get后,控制台并没有什么反应

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

image.png

PS: 本人是通过在IDE的终端中输入命令flutter packages get下载的

  1. 引入english_words包。
import 'package:english_words/english_words.dart';
image.png

在输入时,Android Studio会自动提供有关库导入的建议选项。导入后该行代码将会显示为灰色,表示导入的库尚未使用。

  1. 使用english_words包来生成随机字符串。
class RandomWordsWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // TODO: implement build
    // 生成随机字符串
    final wordPair = WordPair.random();
    return Padding(
      padding: const EdgeInsets.all(8.0),
      child: Text(wordPair.toString()),
    );
  }
}

将RandomWordsWidget 添加到 _MyHomePageState.build 的Column的子widget中。


image.png
  1. 如果应用程序正在运行,请使用热重载按钮(⚡️图标) 更新正在运行的应用程序。每次单击热重载或保存项目时,都会在正在运行的应用程序中随机选择不同的单词对。 这是因为单词对是在 build 方法内部生成的。每次热更新时,build方法都会被执行


    Simulator Screen Shot - iPhone 13.png
其他依赖方式

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

  • 依赖本地包
    如果我们正在本地开发一个包,包名为pkg1,我们可以通过下面方式依赖:
dependencies:
    pkg1:
        path: ../../code/pkg1

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

  • 依赖Git:你也可以依赖存储在Git仓库中的包。如果软件包位于仓库的根目录中,请使用以下语法
dependencies:
  pkg1:
    git:
      url: git://github.com/xxx/pkg1.git

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

dependencies:
  package1:
    git:
      url: git://github.com/flutter/packages.git
      path: packages/package1

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

你可能感兴趣的:(第二章: 第一个Flutter应用 2.5 包管理)