flutter如何使用配置文件pubspec.yaml(位于项目根目录)来管理第三方依赖包

官方文档

在软件开发中,很多时候有一些公共的库或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.dartlang.org/ )是Google官方的Dart Packages仓库,类似于node中的npm仓库,android中的jcenter。我们可以在Pub上面查找我们需要的包和插件,也可以向Pub发布我们的包和插件。我们将在后面的章节中介绍如何向Pub发布我们的包和插件。

示例

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

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

  1. 将“english_words”(3.1.3版本)添加到依赖项列表,如下:

    dependencies:
      flutter:
        sdk: flutter
    
      cupertino_icons: ^0.1.0
      # 新添加的依赖
      english_words: ^3.1.3
    
  2. 下载包。在Android Studio的编辑器视图中查看pubspec.yaml时(图2-6),单击右上角的 Packages get 。

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

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

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

  3. 引入english_words包。
    import ‘package:english_words/english_words.dart‘;
    

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

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

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

    Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ... //省略无关代码
        RandomWordsWidget(),
      ],
    )
    
  5. 如果应用程序正在运行,请使用热重载按钮(??图标) 更新正在运行的应用程序。每次单击热重载或保存项目时,都会在正在运行的应用程序中随机选择不同的单词对。 这是因为单词对是在 build 方法内部生成的。每次热更新时,build方法都会被执行,运行效果如图2-7所示。

其它依赖方式

上文所述的依赖方式是依赖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 。

原文地址:https://www.cnblogs.com/sundaysme/p/12635276.html

时间: 2024-08-28 03:32:07

flutter如何使用配置文件pubspec.yaml(位于项目根目录)来管理第三方依赖包的相关文章

maven新建的项目,不自动引入依赖包

1.检查repository的目录是不是纯英文. 2.重新下载一次repository. 如果解决了问题,那么原因就是前面在加载repository的时候,因为断网导致了下载的包有误,无法被eclipse识别到. 来自为知笔记(Wiz)

项目的范围管理

项目范围管理知识领域中包含规划项目范围管理.收集需求.定义范围.创建WBS.确定范围.控制范围等6个过程组,本篇将从项目范围管理的定义以及6个过程组中的输入.工具以及输出给大家介绍项目范围管理里面的主要内容. 一.定义 项目范围管理包括确保项目做且只做所需的全部工作,以成功完成项目的各个过程.管理项目范围主要在于定义和控制哪些工作应该包括在项目内,哪些不应该包括在项目内. 管理项目范围所需的各个过程及支持工具与技术,会因项目而异.经过批准的项目范围说明书.工作分解结构(WBS)和相应的WBS词典

Linux下离线安装python项目的依赖包

第一步新建一个文件夹,把python项目有需要的依赖包导出到site-packages下的requirements.txt中 1 $ pip3 freeze > requirements.txt 第二步下载python项目需要的所有的依赖包pip3 download -r requirements.txt 第三步,把site-packages文件夹复制到离线的机器上然后找到Linux安装的python3的目录,把site-packages文件下的requirements.tx放入/usr/pyt

告警系统主脚本、告警系统配置文件、告警系统监控项目

告警系统主脚本 1.定义shell项目-告警系统脚本main.sh [[email protected] ~]# cd /usr/local/sbin/ [[email protected] sbin]# mkdir mon [[email protected] sbin]# cd mon [[email protected] mon]# ls [[email protected] mon]# mkdir bin conf shares log [[email protected] mon]#

【SpringBoot】SpringBoot配置文件及YAML简介

SpringBoot配置文件 SpringBoot使用一个全局的配置文件,配置文件名是固定的; application.properties application.yml 配置文件的作用:修改SpringBoot自动配置的默认值; SpringBoot在底层就自动配置好; YAML简介 AML(YAML Ain't Markup Language) YAML A Markup Language:是一个标记语言 YAML isn't Markup Language:不是一个标记语言; 标记语言:

Eclipse将引用了第三方jar包的Java项目打包成jar文件的两种方法

方案一:用Eclipse自带的Export功能 步骤1:准备主清单文件 “MANIFEST.MF”, 由于是打包引用了第三方jar包的Java项目,故需要自定义配置文件MANIFEST.MF,在该项目下建立文件MANIFEST.MF,内容如下: Manifest-Version: 1.0 Class-Path: lib/commons-codec.jar lib/commons-httpclient-3.1.jar lib/commons-logging-1.1.jar lib/log4j-1.

Eclipse项目中引用第三方jar包时将项目打包成jar文件的两种方式

转载自:http://www.cnblogs.com/lanxuezaipiao/p/3291641.html 方案一:用Eclipse自带的Export功能 步骤1:准备主清单文件 “MANIFEST.MF”, 由于是打包引用了第三方jar包的Java项目,故需要自定义配置文件MANIFEST.MF,在该项目下建立文件MANIFEST.MF,内容如下: Manifest-Version: 1.0 Class-Path: lib/commons-codec.jar lib/commons-htt

将引用了第三方jar包的Java项目打包成jar文件的两种方法

方案一:用Eclipse自带的Export功能 步骤1:准备主清单文件 “MANIFEST.MF”, 由于是打包引用了第三方jar包的Java项目,故需要自定义配置文件MANIFEST.MF,在该项目下建立文件MANIFEST.MF,内容如下: Manifest-Version: 1.0 Class-Path: lib/commons-codec.jar lib/commons-httpclient-3.1.jar lib/commons-logging-1.1.jar lib/log4j-1.

(转载)Eclipse将引用了第三方jar包的Java项目打包成可执行jar的两种方法

转载自:http://www.cnblogs.com/lanxuezaipiao/p/3291641.html 方案一:用Eclipse自带的Export功能 步骤1:准备主清单文件 "MANIFEST.MF", 由于是打包引用了第三方jar包的Java项目,故需要自定义配置文件MANIFEST.MF,在该项目下建立文件MANIFEST.MF,内容如下: Manifest-Version: 1.0 Class-Path: lib/commons-codec.jar lib/common