GVKun编程网logo

【Flutter 实战】pubspec.yaml 配置文件详解(flutter pub.dev)

10

最近很多小伙伴都在问【Flutter实战】pubspec.yaml配置文件详解和flutterpub.dev这两个问题,那么本篇文章就来给大家详细解答一下,同时本文还将给你拓展dart系列之:元世界p

最近很多小伙伴都在问【Flutter 实战】pubspec.yaml 配置文件详解flutter pub.dev这两个问题,那么本篇文章就来给大家详细解答一下,同时本文还将给你拓展dart 系列之:元世界 pubspec.yaml 文件详解、dart系列之:元世界pubspec.yaml文件详解、flutter pubspec.yaml 退出代码 65、Flutter pubspec.yaml 配置文件等相关知识,下面开始了哦!

本文目录一览:

【Flutter 实战】pubspec.yaml 配置文件详解(flutter pub.dev)

【Flutter 实战】pubspec.yaml 配置文件详解(flutter pub.dev)

老孟导读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 属性下添加 FlutterDart 版本控制。

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,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】:

总结

以上是小编为你收集整理的【Flutter 实战】pubspec.yaml 配置文件详解全部内容。

如果觉得小编网站内容还不错,欢迎将小编网站推荐给好友。

dart 系列之:元世界 pubspec.yaml 文件详解

dart 系列之:元世界 pubspec.yaml 文件详解

简介

pubspec.yaml 是所有 dart 项目的灵魂,它包含了所有 dart 项目的依赖信息和其他元信息,所以 pubspec.yaml 就是 dart 项目的 meta!

pubspec.yaml 支持的字段

根据 dart 的定义,pubspec.yaml 中可以包含下面的字段:

字段名 是否必须字段 描述
name package 的名字
version 如果发布到 pub.dev,则需要 package 的版本号
description 如果发布到 pub.dev,则需要 package 的描述信息
homepage package 的主页
repository package 的源代码地址
issue_tracker package 问题跟踪地址
documentation package 的文档信息
dependencies package 的依赖信息
dev_dependencies pacakge 的 dev 依赖信息
dependency_overrides 想要覆盖的 package
environment dart2 需要  
executables package 的可执行文件路径
publish_to package 将如何发布

注意,以上是 dart 中 pubspec.yaml 支持的字段,如果是在 flutter 环境中,则会有些额外支持的字段。

# 一个例子

我们看一个具体的例子:

 name: my_app
version: 11.15
description: >-
  this is a new app
homepage: http://www.flydean.com
documentation: http://www.flydean.com
environment:
  sdk: ''>=2.10.0 <3.0.0''
dependencies:
  efts: ^2.0.4
  transmogrify: ^0.4.0
dev_dependencies:
  test: ''>=1.15.0 <2.0.0''

字段详情

下面来看下各个字段的详情和限制情况:

  1. Name

name 表示的是包的名字,name 必须是全小写,如果有多个词的话,可以用下划线来区分,如:my_app.

并且只能使用小写字母和数字的组合,同时不能以数字开头,并且不要使用 dart 中的保留字。

  1. Version

Version 表示的是版本号,版本号是由点分割的三个数字,如:11.15.0. 后面还可以跟上 build 版本号:+1, +2, +hotfix.oopsie, 或者预发布版本等:-dev.4, -alpha.12, -beta.7, -rc.5.

  1. Description

package 的描述信息最好使用英文来描写,长度是 60 到 180 个字符,表示这个包的作用。

  1. Dependencies

有两种依赖信息,一种是所有使用到这个 packages 的人都需要用到的依赖,这种依赖放在 dependencies 中。

还有一种是只用在当前 pacakge 开发中的包,这种依赖放在 dev_dependencies 中。

在某些情况下,我们有可能需要覆盖某些依赖包,则可以放在:dependency_overrides 中。

  1. Executables

有些 pacakges 提供的是工具供大家使用,这些工具有可能是命令行工具,所以需要在 executables 中指定可以执行的命令的路径。

比如下面的配置:

executables:
  slidy: main
  fvm:

那么在执行 pub global activate 之后,就可以在全局执行 slidy 来执行 bin/main.dart, 和 fvm 来执行 binfvm.dart.

  1. environment

因为 Dart 是一门新的语言,所以目前来说其变动还是挺大的。所以有些应用可以依赖于不同的 dart 版本,这时候就需要用到 environment:

environment:
  sdk: ''>=2.10.0 <3.0.0''

上面的代码中,我们指定了 dart sdk 的版本范围。

从 dart1.19 之后,environment: 中还支持指定 flutter 的版本:

environment:
  sdk: ''>=1.19.0 <3.0.0''
  flutter: ^0.1.2

总结

以上就是 dart 的元世界 pubspec.yaml 详解。

本文已收录于 http://www.flydean.com/10-dart-pubspec/

最通俗的解读,最深刻的干货,最简洁的教程,众多你不知道的小技巧等你来发现!

欢迎关注我的公众号:「程序那些事」, 懂技术,更懂你!

dart系列之:元世界pubspec.yaml文件详解

dart系列之:元世界pubspec.yaml文件详解

简介

pubspec.yaml是所有dart项目的灵魂,它包含了所有dart项目的依赖信息和其他元信息,所以pubspec.yaml就是dart项目的meta!

pubspec.yaml支持的字段

根据dart的定义,pubspec.yaml中可以包含下面的字段:

字段名是否必须字段描述
namepackage的名字
version如果发布到pub.dev,则需要package的版本号
description如果发布到pub.dev,则需要package的描述信息
homepagepackage的主页
repositorypackage的源代码地址
issue_trackerpackage问题跟踪地址
documentationpackage的文档信息
dependenciespackage的依赖信息
dev_dependenciespacakge的dev依赖信息
dependency_overrides想要覆盖的package
environmentdart2需要
executablespackage的可执行文件路径
publish_topackage将如何发布
注意,以上是dart中pubspec.yaml支持的字段,如果是在flutter环境中,则会有些额外支持的字段。

# 一个例子

我们看一个具体的例子:

 name: my_app
version: 11.15
description: >-
  this is a new app
homepage: http://www.flydean.com
documentation: http://www.flydean.com
environment:
  sdk: ''>=2.10.0 <3.0.0''
dependencies:
  efts: ^2.0.4
  transmogrify: ^0.4.0
dev_dependencies:
  test: ''>=1.15.0 <2.0.0''

字段详情

下面来看下各个字段的详情和限制情况:

  1. Name

name表示的是包的名字,name必须是全小写,如果有多个词的话,可以用下划线来区分,如:my_app.

并且只能使用小写字母和数字的组合,同时不能以数字开头,并且不要使用dart中的保留字。

  1. Version

Version表示的是版本号,版本号是由点分割的三个数字,如:11.15.0. 后面还可以跟上build版本号:+1, +2, +hotfix.oopsie, 或者预发布版本等:-dev.4, -alpha.12, -beta.7, -rc.5.

  1. Description

package的描述信息最好使用英文来描写,长度是60 到180个字符,表示这个包的作用。

  1. Dependencies

有两种依赖信息,一种是所有使用到这个packages的人都需要用到的依赖,这种依赖放在dependencies中。

还有一种是只用在当前pacakge开发中的包,这种依赖放在dev_dependencies中。

在某些情况下,我们有可能需要覆盖某些依赖包,则可以放在:dependency_overrides中。

  1. Executables

有些pacakges提供的是工具供大家使用,这些工具有可能是命令行工具,所以需要在executables中指定可以执行的命令的路径。

比如下面的配置:

executables:
  slidy: main
  fvm:

那么在执行pub global activate之后,就可以在全局执行slidy来执行bin/main.dart, 和fvm来执行binfvm.dart.

  1. environment

因为Dart是一门新的语言,所以目前来说其变动还是挺大的。所以有些应用可以依赖于不同的dart版本,这时候就需要用到environment:

environment:
  sdk: ''>=2.10.0 <3.0.0''

上面的代码中,我们指定了dart sdk的版本范围。

从dart1.19之后,environment:中还支持指定flutter的版本:

environment:
  sdk: ''>=1.19.0 <3.0.0''
  flutter: ^0.1.2

总结

以上就是dart的元世界pubspec.yaml详解。

本文已收录于 http://www.flydean.com/10-dart-pubspec/

最通俗的解读,最深刻的干货,最简洁的教程,众多你不知道的小技巧等你来发现!

欢迎关注我的公众号:「程序那些事」,懂技术,更懂你!

flutter pubspec.yaml 退出代码 65

flutter pubspec.yaml 退出代码 65

如何解决flutter pubspec.yaml 退出代码 65?

我的 Flutter pubspec.yaml 没有得到这些包。此错误显示:

Error on line 30,column 22 of pubspec.yaml: Invalid version constraint: Expected version number after "^" in "^^4.2.1",got "^4.2.1".

   ╷

30 │   animated_text_kit: ^^4.2.1

   │                      ^^^^^^^

   ╵
pub get Failed (65;    ╵)
exit code 65

这是我的依赖项:

dependencies:
  Flutter:
    sdk: Flutter


  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  animated_text_kit: ^4.2.1
  cupertino_icons: ^1.0.3
  audioplayers: ^0.16.1

dev_dependencies:
  Flutter_test:
    sdk: Flutter

我检查了缩进、版本等。

我该怎么办?

解决方法

pubspec.yaml 上的退出代码 65 表示文件格式不正确。您需要再次检查文件问题出在哪里或共享完整的 yaml 文件以便我检查。或者,如果您对格式有信心,请在终端中尝试 flutter cleanflutter pub get

,

尝试下面的代码,然后运行 ​​flutter pub 获取参考文档 here

dependencies:
  flutter:
    sdk: flutter
  audioplayers: ^0.16.1
  animated_text_kit: ^4.2.1

  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  
  cupertino_icons: ^1.0.3

Flutter pubspec.yaml 配置文件

Flutter pubspec.yaml 配置文件

 

 

name: flutter_app1 # 应用名称
description: A new Flutter application. # 应用描述

# The following defines the version and build number for your application.
# A version number is three numbers separated by dots, like 1.2.43
# followed by an optional build number separated by a +.
# Both the version and the builder number may be overridden in flutter
# build by specifying --build-name and --build-number, respectively.
# In Android, build-name is used as versionName while build-number used as versionCode.
# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
# In iOS, build-name is used as CFBundleShortVersionString while build-number used as CFBundleVersion.
# Read more about iOS versioning at
# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
version: 1.0.0+1

#Dart 运行环境区间
environment:
  sdk: ">=2.1.0 <3.0.0"

#Flutter 依赖库
dependencies:
  flutter:
    sdk: flutter

  flutter_sheet_localization: ^1.0.0
  date_format: ^1.0.8
  flutter_custom_calendar:
    git:
      url: https://github.com/LXD312569496/flutter_custom_calendar.git

  # package1:
  #  path: ../package1/  # 路径依赖

  # The following adds the Cupertino Icons font to your application.
  # Use with the CupertinoIcons class for iOS style icons.
  cupertino_icons: ^0.1.2


  # 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.

  # 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.


  # To add assets to your application, add an assets section, like this:
flutter:
  uses-material-design: true
  # 圖片資源
  assets:
    - images/img.jpeg

  # 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
  #定义常量

#数组
#server:
 # - aaaaaa
 # - bbbbbb
 # - dddddd
#常量
#age: 22         # int
#boolitem: true  #定义一个boolean值
#myname: ''hello''   #定义一个string

 

今天关于【Flutter 实战】pubspec.yaml 配置文件详解flutter pub.dev的分享就到这里,希望大家有所收获,若想了解更多关于dart 系列之:元世界 pubspec.yaml 文件详解、dart系列之:元世界pubspec.yaml文件详解、flutter pubspec.yaml 退出代码 65、Flutter pubspec.yaml 配置文件等相关知识,可以在本站进行查询。

本文标签: