Flutter入门(一)——关于目录结构和配置文件

flutter App目录结构

1. 实际操作

首先,使用Android Studio新建一个flutter工程,假设名为github_client_app;创建完成之后,工程结构如下:

如图,我们看到了下面这些目录:

文件或目录 说明
.dart_tool 记录了一些dart工具库所在的位置和信息
.idea android studio 是基于idea开发的,.idea 记录了项目的一些文件的变更记录
android 包含Android特定文件的Android子工程(android平台相关代码)
ios 包含ios特定文件的ios子工程(ios平台相关代码)
lib flutter应用源文件目录,我们自己写的Dart文件都放进此文件夹中
test 用于存放测试代码
.gitignore git忽略配置文件
.metadata IDE 用来记录某个 Flutter 项目属性的的隐藏文件
.packages pub 工具需要使用的,包含 package 依赖的 yaml 格式的文件
flutter_app.iml 工程文件的本地路径配置
pubspec.lock 当前项目依赖所生成的文件
pubspec.yaml 当前项目的一些配置文件,包括依赖的第三方库、图片资源文件等
README.md READEME文件

Flutter虽然是跨平台方案,但却需要一个容器最终运行到Android和iOS平台上,所以Flutter工程实际上就是一个同时内嵌了Android和iOS原生子工程的父工程;我们在lib目录下进行Flutter代码的开发而某些特殊场景下的原生功能,则在对应的Android和iOS工程中提供相应的代码实现, 供对应的Flutter代码调用。

为了使用外部图片和Icon资源,我们还可以在项目根目录下分别创建imgs和fonts文件夹,由于在网络数据传输和持久化时,我们需要通过Json来传输、保存数据;但是在应用开发的时候我们又需要转换成Dart Model类,所以需要在根目录下再创建一个用于保存Json文件的"Jsons"文件夹。

lib以下还可以根据技术选型和经验创建这些目录:(来源:flutter中文网 https://book.flutterchina.club/chapter15/code_structure.html

lib
├── common:一些工具类,如通用方法类、网络接口类、保存全局变量的静态类等
├── models:Json文件对应的Dart Model类会在此目录下
├── states:保存APP中需要跨组件共享的状态类
├── routes:存放所有路由页面类
└── widgets:APP内封装的一些Widgets组件都在该目录下

2. 基本架构

每一个Flutter项目都有一个lib目录,这个目录有有一个默认添加的文件main.dart,这个文件就是flutter的入口文件。main.dart里面的 main 方法是Dart的入口方法。而 runApp 方法是Flutter的入口方法。

需要注意的是

* 入口函数
*
* */
void main() => runApp(MyApp()); //Dart中的箭头函数,跟kotlin很像,跟下面写法效果一致
//main(){
//  return new MyApp();
//}

返回一个Widget, MyApp就是我们要展示的启动界面。

通过代码查看:

image-20201225134754272.png

可以看到这里的MyApp类中返回了一个MaterialApp widget, Material App可以理解为ui的风格,Android上就是这种风格的UI,ios上我们可以使用CupertinoApp。
在Flutter中,Widget是整个视图描述的基础,在Flutter的世界里,包括应用本身、视图、视图控制器、布局等在内的概念,都建立在Widget的基础之上。Flutter的设计思想是:一切皆Widget。

pubspec.yaml配置文件

pubspec.yaml是Flutter项目的配置文件,类似于Android中的Gradle配置文件,位于根目录下。
去除英文注释之后,其内容如下:

name: github_client_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: ^0.1.3

dev_dependencies:
  flutter_test:
    sdk: flutter

flutter:
  uses-material-design: true
  assets:
    - images/add.png

1. name

name: github_client_app

此属性表示包名,引入其他文件的时候需要使用此包名,例如:
import 'package:github_client_app/home_page.dart'

2. description

description: A new Flutter application.

description是一个可选的配置属性,是对当前项目的介绍

3. publish_to

publish_to: 'none' 

这一行可以防止软件包被pub publish发布到pub.dev上,对于私有软件包这行是必需的配置;如果想要把当前软件包发布到pub.dev也可以删除此行

4. version

此属性是应用程序的版本和内部版本号,格式为 x.x.x+x,例如:1.0.0+1,这个版本号称为 语义版本号(semantic versioning )
版本的指定有多种形式
不指定或者 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

5. environment

environment:
  sdk: ">=2.7.0 <3.0.0"

environment属性下添加Flutter和Dart版本控制号。
sdk:规定此应用只能在高于或等于2.7.0,低于3.0.0的Dart SDK版本上运行。
也可以添加flutter:手动添加flutter版本控制。

6. dependencies和dev_dependencies

dependencies和dev_dependencies下包含应用程序所依赖的包,dependencies下的所有依赖会编译到项目中, 而dev_dependencies仅仅是运行期间的包,比如自动生成代码的库。

dependencies:
  flutter:
    sdk: flutter
dev_dependencies:
  flutter_test:
    sdk: flutter

我们可以通过四种方式依赖其包:

  • 依赖 pub.dev 上的第三方库
  • 依赖本地库
  • 依赖 git repository
  • 依赖我们自己的 pub仓库
  • 依赖 pub.dev 上的第三方库
  • 依赖 pub.dev 上的第三方库是最常用的一种方式

依赖 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

6. flutter

Flutter下面的配置都是Flutter的相关配置。

flutter :
  uses-material-design: true
  assets:
    - images/add.png
  fonts:
    - family: Schyler
    fonts:
      - asset: fonts/Schyler-Regular.ttf
      - asset: fonts/Schyler-Italic.ttf
        style: italic
      - family: Trajan Pro
   

uses-material-design是确保应用程序中包含Material Icons字体,以便可以使用material Icons类中的图标。
assets是对当前资源的配置,比如 图片、字体等。
Fonts用来配置字体。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容