关于flutter:Flutter-实战pubspecyaml-配置文件详解

5次阅读

共计 4718 个字符，预计需要花费 12 分钟才能阅读完成。

老孟导读：pubspec.yaml 文件是 Flutter 中十分重要的配置文件，上面就让咱们看看外面各个配置的含意。

pubspec.yaml 是 Flutter 我的项目的配置文件，相似于 Android 中的 Gradle 配置文件，上面咱们就看看 pubspec.yaml 中各个属性的配置。

创立一个新的我的项目（Flutter Application），pubspec.yaml 位于根目录，如图：

我的项目中默认配置，去掉正文局部，剩下如下：

name: flutter_app
description: A new Flutter application.

publish_to: 'none' 

version: 1.0.0+1

environment:
  sdk: ">=2.7.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter

  cupertino_icons: ^1.0.0

dev_dependencies:
  flutter_test:
    sdk: flutter

flutter:
  uses-material-design: true

上面咱们一个一个的具体介绍下。

此属性示意包名（package name），此属性是十分重要的，引入其余文件时须要应用此包名：

import 'package:flutter_app/home_page.dart';

如果你批改包名为，那么相应的引入也须要批改:

import 'package:flutter_app_demo/home_page.dart';

如果你创立了一个 Flutter 插件并公布到 pub.dev，那么此属性将会作为题目显示，同时其他人援用也须要应用此属性。

description 属性是一个可选配置属性，是对以后我的项目的介绍。如果作为插件公布到 pub.dev 上，此值显示在如下地位：

此属性应用程序的版本和外部版本号，格局为 x.x.x+x，例如：1.0.0+1，这个版本号称为 语义版本号（semantic versioning），semantic versioning 相干常识请参考此处。

版本号 + 后面到局部，叫做 version number，由 2 个小点隔开，前面的局部叫做 build number。

在 Android 中 version number 对应 versionName，build number 对应 versionCode，在 android/build.gradle 下有相干配置，

晚期的版本 build.gradle 中 versionName 和 versionCode 是间接写死的数字，如下：

此时批改版本号只能通过批改 build.gradle。而当初能够间接通过 pubspec.yaml 进行批改。

如果是插件，那么用户能够通过此版本号指定应用哪个版本，

path_provider: ^1.6.22

版本的指定有多种形式：

path_provider:

path_provider: any

此种格局默认加载 最新的版本，但强烈不举荐应用此形式，因为版本的变动会导致接口发生变化，我的项目呈现编译异样。

明确指定版本

path_provider: 1.6.22

指定依赖的版本。

小于或者小于等于此版本的包

path_provider: <=1.6.22

path_provider: <1.6.22

指定版本的区间

path_provider: '>=1.0.0 <1.6.22'

此形式为最常见的形式，也是举荐的形式。

此形式示意大版本不变，小版本应用最新的版本，例如^1.6.22 相当于 ‘>=1.6.22 <2.0.0’`

path_provider: ^1.6.22

这四种属性在 Flutter Application 我的项目中默认是没有的，失常我的项目中也无需这几个属性，当咱们开发插件并公布到 pub 时须要这几个属性。

当咱们创立一个插件时，默认配置：

issue_tracker 和 repository 咱们能够手动创立。这四个属性阐明：

author：作者，填写本人的署名
homepage：主页。
issue_tracker：issue，个别写以后插件源代码的 Github issue 地址。
repository：个别写以后插件源代码的 Github 地址。

这些属性会显示在 pub.dev 主页上：

Environment 属性下增加 Flutter 和 Dart 版本控制。

environment:
  sdk: ">=2.7.0 <3.0.0"

下面的版本规定此利用或库只能在高于或等于 2.7.0，低于 3.0.0 的 Dart SDK 版本上运行。

咱们也能够手动增加 Flutter 版本：

environment:
  sdk: ">=2.7.0 <3.0.0"
  flutter: "1.22.0"

也能够通过此属性应用试验性质的版本：

environment:
  sdk: ">=2.11.0-213.0.dev <2.12.0"

dependencies 和 dev_dependencies 下蕴含应用程序所依赖的包，dependencies 和 dev_dependencies 就像其名字一样，dependencies 下的所有依赖会编译到我的项目中，而 dev_dependencies 仅仅是运行期间的包，比方主动生成代码的库。

咱们能够通过四种形式依赖其包：

依赖 pub.dev 上的第三方库
依赖本地库
依赖 git repository
依赖咱们本人的 pub 仓库

依赖 pub.dev 上的第三方库是最罕用的一种形式

dependencies:
  path_provider: ^1.6.22

如果你在本地创立了一个模块，依赖本地的库：

dependencies:
  flutter_package:
    path: ../flutter_package

依赖 Github 上的一个插件：

dependencies:
  bloc:
    git:
      url: https://github.com/felangel/bloc.git
      ref: bloc_fixes_issue_110
      path: packages/bloc

url：github 地址
ref：示意 git 援用，能够是 commit hash, tag 或者 branch
path：如果 git 仓库中有多个软件包，则能够应用此属性指定软件包

个别大公司都会搭建本人的 pub 仓库，援用本人仓库的形式：

dependencies:
  bloc: 
    hosted:
      name: bloc
      url: http://your-package-server.com
    version: ^6.0.0

设想如下场景：我的项目依赖一个库（比方 path_provider）的版本为 1.6.22，而另一个依赖库也依赖这个 path_provider，但版本为 0.5.0，那么我最终到底依赖哪个版本，此时执行 flutter pub get 则会呈现如下谬误：

Running "flutter pub get" in flutter_app...                     

Because every version of flutter_plugin from path depends on path_provider ^0.5.0 and flutter_app depends on path_provider ^1.6.22, flutter_plugin from path is forbidden.
So, because flutter_app depends on flutter_plugin from path, version solving failed.
pub get failed (1; So, because flutter_app depends on flutter_plugin from path, version solving failed.)
Process finished with exit code 1

此时要解决这个抵触，能够增加 dependency_overrides：

dependency_overrides:
  path_provider: ^1.6.22

增加此属性后，所有 path_provider 插件都会应用同一个最新版本，应用此字段执行 flutter pub get 则会呈现如下正告：

/Users/mengqingdong/project/flutter/bin/flutter --no-color pub get
Running "flutter pub get" in flutter_app...                     

Warning: You are using these overridden dependencies:
! path_provider 1.6.22
Running "flutter pub get" in flutter_app...                         0.5s
Process finished with exit code 0

Flutter 上面的配置都是 Flutter 的相干配置。

flutter:
  uses-material-design: true

确保您的应用程序中蕴含 Material Icons 字体，以便您能够应用 material Icons 类中的图标。

assets 是对以后资源的配置，比方图片、字体等。

配置本地图片，应用Image.asset() 加载。

assets:
  - images/a_dot_burr.jpeg
  - images/a_dot_ham.jpeg

配置字体：

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

plugin 配置只存在与插件我的项目中，package 和 pluginClass 个别是不须要批改的，

flutter:
  plugin:
    platforms:
      android:
        package: com.flutter.app_market
        pluginClass: AppMarketPlugin
      ios:
        pluginClass: AppMarketPlugin

此配置失常状况下不须要批改，当须要增加新平台适配时，间接增加：

flutter:
  plugin:
    platforms:
      android:
        package: com.flutter.app_market
        pluginClass: AppMarketPlugin
      ios:
        pluginClass: AppMarketPlugin
      macos:
        default_package: app_market_macos
      web:
        default_package: app_market_web

pubspec.yaml 蕴含应用程序和依赖的软件包，规定 Dart 和 Flutter SDK 的版本束缚，治理依赖关系并设置 Flutter 特定的配置。更具体的信息能够转到 pubspec 的官网文档查看。

老孟 Flutter 博客（330 个控件用法 + 实战入门系列文章）：http://laomengit.com

欢送退出 Flutter 交换群（微信：laomengit）、关注公众号【老孟 Flutter】：

正文完

flutter

发表至： flutter

2020-11-04

0

关于flutter:flutter-自定义-Drawer-组件不依赖-Scaffold

关于flutter:Flutter-状态管理-使用-MobX

关于flutter:Flutter第七课Flutter-的Widget的生命周期和App生命周期

关于flutter:flutter系列之flutter中可以建索引的栈布局IndexedStack

关于程序员:jtday02

关于flutter:Flutter-实战pubspecyaml-配置文件详解

name

description

version

不指定或者 any

x.y.z

<=x.y.z 或者 <x.y.z

>=a.b.c <x.y.z

^x.y.z

author homepage issue_tracker repository

Environment

dependencies 和 dev_dependencies

依赖 pub.dev 上的第三方库

依赖本地库

依赖 git repository

依赖咱们本人的 pub 仓库。

依赖笼罩

Flutter

uses-material-design

assets

plugin

交换

站内搜索