Flutter开发规范

一、开发工具,SDK版本要求

1、flutter可以说是Google的亲儿子,强烈推荐使用Android Studio,我们表面上比较不出和其他开发工具的差异,然而flutter,dart,甚至flushia,是Google重新发力打造的新生态工具,所以无论是从编译、打包,还是后续插件化升级,都有一定的优势;
2、统一使用最新版Android Studio(v3.5.1), jdk(1.8+), flutter(v1.9.1+hotfix.6), dart(v2.6.0),避免团队之间因版本不一致导致的报错;
flutter sdk下载地址: https://flutter.dev/docs/get-started/install/windows
dart sdk下载地址: https://dart.dev/tools/sdk


二、目录规范

image.png

1、lib文件夹是flutter主要代码目录,通常不会直接在根目录下直接创建dart文件,而是会根据功能点、模块、属性等创建子文件夹,在相应子文件夹中创建相应dart文件,当然子文件下依然可以再创建文件夹,将目标文件所属角色细化;
2、文件夹通常是小写单词,小驼峰法使用较少,不推荐使用下划线连接法;
3、通常main(mian.dart程序入口)会直接创建在根目录下;
4、Android代码目录(src/main/java/包名)基本上也是这个规则;

三、命名规范

1、大驼峰法:类名称,如MainPage;
2、小驼峰法:包名、函数名,变量名、参数名;
3、查看dart源码发现,源文件名都是小写英文加上下划线组成,如app_bar.dart;
4、一般情况下,类名是源文件名的大驼峰写法,如源文件app_bar.dart,类名AppBar;源文件bottom_app_bar,类名BottomAppBar;
5、不使用前缀字母,如不推荐使用mList,可以用list,或者更加详细的命名,如bookList;
6、assets目录下的资源文件名,和源文件名命名规则一样;
7、枚举类的元素,使用大写英文加下划线,如YEAR_MONTH_DAY;

四、代码规范

1、if else使用大括号,尽可能不省略;
2、不要使用new;
3、page页面中(StatelessWidget、StatefulWidget)尽量将每一层和每一个widget以单独函数形式调用,层次清晰分明(工具类封装的Widget可例外);
4、封装简单常用的widget,注意使用@required、assert

  /*
  *  生成常用的AppBar
  */
  static Widget buildAppBar(BuildContext context, String text,
      {double fontSize: 18.0,
      double height: 50.0,
      double elevation: 0.5,
      Widget leading,
      bool centerTitle: false,
      List<Widget> actions,
      OnItemDoubleClick onItemDoubleClick}) {
    return PreferredSize(
        child: GestureDetector(
            onDoubleTap: () {
              if (null != onItemDoubleClick) {
                onItemDoubleClick(null);
              }
            },
            child: AppBar(
              elevation: elevation, //阴影
              centerTitle: centerTitle,
              title: Text(text, style: TextStyle(fontSize: fontSize)),
              leading: leading,
              actions: actions,
            )),
        preferredSize: Size.fromHeight(height));
  }

5、常用的颜色值和宽高值,使用统一相同含义值来赋值;
6、实时处理报错(error)和警告(warning):Dart Analysis统计了所有报错和警告的具体信息;(好处:一则让代码程序更健壮,二则在dart sdk升级后,可避免报错);
7、必要的简要的代码注释(不止是.dart文件,还包括pubspec.yaml);
8、编码过程中习惯性使用“Reformat Code with dartfmt”;
9、拒绝弱命名(如var a),拒绝硬编码(如if (a == 2)...);
10、善用///[],"[]"内可以是类名、变量名,在引用中可以添加注释说明;
11、适当的换行,函数体之间、语句过长等;

五、其他

1、尽量不使用第三方插件库(SDK),大多数SDK在功能点覆盖和适配方面存在很多的缺陷;逼不得已时选择flutter官方指定维护的sdk、知名度和活跃度高的sdk;
2、创建项目时,包名采用反写域名命名规则,即com.xx.xxx.xxxx形式全部使用小写字母。一级包名为com,二级包名为xx(一般为公司或个人域名),三级包名根据应用进行命名,四级包名为功能模块名;
3、如果一个bool类型"isShow"在不确定是否会为null的情况下(尤其在与原生双向交互中),避免"if(isShow)..."这种写法,正确写法"if(isShow == true)";
4、注重dispose()方法中资源的释放;
5、删除或注释掉assets下无效的资源及pubspec.yaml的声明。

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

推荐阅读更多精彩内容