【Flutter 實戰】pubspec.yaml 配置檔案詳解

阿新 • • 發佈：2020-11-04

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