概述
每个 Flutter 项目都包含一个pubspec.yaml文件,通常称为pubspec。创建新的 Flutter 项目时会在项目根目录下生成这个文件,指定项目所需的依赖项,例如特定的包(及其版本)、字体或图像文件。它还指定了其他要求,例如对开发人员包的依赖(如测试或模拟包),或对 Flutter SDK 版本的特定限制;pubspec 用YAML编写的 ,还需要注意空格(制表符与空格)的书写。
pubspec.yaml 文件示例
name: flutter_study_app
description: A new Flutter project.
# 以下行是防止包被意外发布到
# pub.dev 使用`pub publish`。这是私人包的首选。
publish_to: 'none' # 如果您希望发布到 pub.dev,请删除此行
# 应用程序的版本和内部版本号
version: 1.0.0+1
environment:
sdk: ">=2.7.0 <3.0.0"
dependencies:
flutter:
sdk: flutter
# 添加插件库依赖,如下是创建flutter项目自带添加好的图标库
# The following adds the Cupertino Icons font to your application.
# Use with the CupertinoIcons class for iOS style icons.
cupertino_icons: ^1.0.0
dev_dependencies:
flutter_test:
sdk: flutter
# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec
# The following section is specific to Flutter.
flutter:
# The following line ensures that the Material Icons font is
# included with your application, so that you can use the icons in
# the material Icons class.
uses-material-design: true
# 给应用程序添加assets文件, 比如本地需要用到ic_launcher.png,则如下添加引入:
assets:
- assets/images/ic_launcher.png
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware.
# For details regarding adding assets from package dependencies, see
# https://flutter.dev/assets-and-images/#from-packages
# To add custom fonts to your application, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
# - asset: fonts/TrajanPro_Bold.ttf
# weight: 700
#
# For details regarding fonts from package dependencies,
# see https://flutter.dev/custom-fonts/#from-packages
包名称和描述
name为当前项目包的名称(不是程序名称),每个包都需要一个名称,关于命名规则,名称应全部小写,用下划线分隔单词;另外也要确保名称是有效的 Dart 标识符,不以数字开头。
description为项目包的描述,是可选的,但是如果您打算发布您的包,则必须提供一个描述,该描述应该是英文的。描述应该相对较短(60 到 180 个字符),如:
name: flutter_study_app
description: A new Flutter project.
将包发布到站点
publish_to的作用是指定发布包的位置,默认使用pub.dev 站点。如果不发布包则指定none以防止发布包。
publish_to: 'none'
版本
应用程序的版本和内部版本号用version来定义,比如,定义版本名为1.0.0、版本号为1:
version: 1.0.0+1
version是由点分隔的三个数字,如 1.0.0;后跟由 + 分隔的可选版本号组成。版本号和建造者号都可能在flutter中被覆盖;通过分别指定 --build-name 和 --build-number 来构建。
在 Android 中,build-name 用作 versionName,而 build-number 用作 versionCode。在iOS中,build-name用作CFBundleShortVersionString,而build-number用作CFBundleVersion。
SDK约束
一个包可以表明它支持哪些版本的依赖项,但包还有另一个隐含的依赖项:Dart 平台本身。Dart 平台随着时间的推移而发展,一个包可能只适用于该平台的某些版本,所以这里可以使用environment来约束SDK的版本范围,如:
environment:
sdk: ">=2.7.0 <3.0.0"
我目前项目还没兼容到flutter2.0,还是用flutter1.22.6版本创建的项目,因此这里的sdk约束最低为2.7.0,后期统一升级到flutter2.0后,这里的SDK约束应该是2.10.0以后了。
插件库依赖
常规依赖项列在dependencies:这些是使用您的软件包的任何人也需要的软件包。仅在包本身的开发阶段需要的依赖项列在dev_dependencies.
比如示例加入的图标库依赖:
dependencies:
cupertino_icons: ^1.0.0
在开发过程中,由于版本不统一导致报错,又比如很多模块都使用了不同版本的插件库,可能需要覆盖依赖项等等,
这时就可以使用覆盖依赖项dependency_overrides,如统一使用图标库最新版本:
dependency_overrides:
cupertino_icons: ^1.0.4
Assets资源文件
资源文件是被打包到应用程序安装包中,可以在运行时访问的一种文件。常见的资产类型包括静态数据(例如 JSON 文件)、配置文件、图标和图像(JPEG、WebP、GIF、动画 WebP/GIF、PNG、BMP 和 WBMP)。使用示例:
# 给应用程序添加assets文件, 比如本地需要用到ic_launcher.png,则如下添加引入:
assets:
- assets/images/ic_launcher.png
或
assets:
- assets/images/
除了列出应用程序包中包含的图像外,图像资产还可以指一个或多个特定于分辨率的“变体”。有关“变体”及更多资源文件的理解,这里不一一赘述,请到官网查看:
https://flutter.cn/docs/development/ui/assets-and-images
Fonts字体
使用自定义字体主要是为了实现设计师奇葩的设计需求,因此这个配置也是很有必要的;目前Flutter 支持的字体格式如下:
- .ttf
- .otf
使用自定义字体示例:
flutter:
fonts:
- family: Raleway
fonts:
- asset: fonts/Raleway-Regular.ttf
- asset: fonts/Raleway-Italic.ttf
style: italic
- family: RobotoMono
fonts:
- asset: fonts/RobotoMono-Regular.ttf
- asset: fonts/RobotoMono-Bold.ttf
weight: 700
更多字体相关的理解,这里附上官网对应地址:
https://flutter.cn/docs/cookbook/design/fonts