【Flutter 實戰】pubspec.yaml 配置文件詳解

老孟導讀：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

下面咱們一個一個的詳細介紹下。

name

此屬性表示包名（package name），此屬性是很是重要的，引入其餘文件時須要使用此包名：

import 'package:flutter_app/home_page.dart';

若是你修改包名爲 ，那麼相應的引入也須要修改:

import 'package:flutter_app_demo/home_page.dart';

若是你建立了一個 Flutter 插件併發布到 pub.dev，那麼此屬性將會做爲標題顯示，同時其餘人引用也須要使用此屬性。

description

description 屬性是一個可選配置屬性，是對當前項目的介紹。若是做爲插件發佈到 pub.dev 上，此值顯示在以下位置：

version

此屬性應用程序的版本和內部版本號，格式爲 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

版本的指定有多種形式：

不指定或者 any

path_provider:

path_provider: any

此種格式默認加載 最新的版本，但強烈不推薦使用此方式，由於版本的變化會致使接口發生變化，項目出現編譯異常。

x.y.z

明確指定版本

path_provider: 1.6.22

指定依賴的版本。

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

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

path_provider: <=1.6.22

path_provider: <1.6.22

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

指定版本的區間

path_provider: '>=1.0.0 <1.6.22'

^x.y.z

此方式爲最多見的方式，也是推薦的方式。

此方式表示大版本不變，小版本使用最新的版本，例如^1.6.22 至關於 '>=1.6.22 <2.0.0'`

path_provider: ^1.6.22

author homepage issue_tracker repository

這四種屬性在 Flutter Application 項目中默認是沒有的，正常項目中也無需這幾個屬性，當咱們開發插件併發布到 pub 時須要這幾個屬性。

當咱們建立一個插件時，默認配置：

issue_tracker 和 repository 咱們能夠手動建立。這四個屬性說明：

• author：做者，填寫本身的署名
• homepage：主頁。
• issue_tracker：issue，通常寫當前插件源代碼的Github issue 地址。
• repository：通常寫當前插件源代碼的Github地址。

這些屬性會顯示在 pub.dev 主頁上：

Environment

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 就像其名字同樣，dependencies 下的全部依賴會編譯到項目中，而 dev_dependencies 僅僅是運行期間的包，好比自動生成代碼的庫。

咱們能夠經過四種方式依賴其包：

• 依賴 pub.dev 上的第三方庫
• 依賴本地庫
• 依賴 git repository
• 依賴咱們本身的 pub倉庫

依賴 pub.dev 上的第三方庫

依賴 pub.dev 上的第三方庫是最經常使用的一種方式

dependencies:
  path_provider: ^1.6.22

依賴本地庫

若是你在本地建立了一個模塊，依賴本地的庫：

dependencies:
  flutter_package:
    path: ../flutter_package

依賴 git repository

依賴 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 倉庫。

通常大公司都會搭建本身的 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

flutter:
  uses-material-design: true

確保您的應用程序中包含Material Icons字體，以便您可使用material Icons類中的圖標。

assets

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

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】：