Flutter 代码规范整理

Dart 语法简介

Flutter是使用Dart语言开发的。

Dart语言是基于类的纯面向对象语言。

Dart 中的所有东西都是对象,包括数字、函数等,它们都继承自 Object,并且对象的默认值都是 null(包括数字)。

Dart 中类和接口是统一的,类就是接口。

Dart语法和java比较相似,熟悉java开发或者安卓开发会更容易理解Dart语言的语法规范。官宣: Dart语言的语法比JAVA更富有表现力。

总的来说,谷歌的Flutter既然使用Dart语言开发,说明Dart语言在某些方面还是有比其他语言更突出的优势的。

标识符

在 Dart 中标识符有三种风格:

  • 大写驼峰:每个单词的第一个字母大写,包括第一个单词。
  • 小写驼峰:每个单词的第一个字母大写,除了 第一个单词一直小写,即使第一个单词是缩写。
  • 小写加下划线:只使用小写字母,即使是缩写,然后使用下划线_分隔。

包名、文件名使用小写加下线划

一些文件系统是不区分大小写的,所以许多项目要求文件名全小写。使用分隔符使得那种方式下名字仍然可读。使用下划线作为分隔符确保名字仍然是有效的 Dart 标识符。

import 'package:flutter/material.dart';

import 'package:english_words/english_words.dart';

导入别名使用小写加下划线

当导入包时, 如果涉及到别名 as, 一律使用小写+下划线方式

import 'dart:math' as math;

import 'package:english_words/english_words.dart' as ew;

类型名使用大写驼峰

类,枚举,自定义类型和参数类型,应该使用大写驼峰,且不能使用分隔符。

class SliderMenu { ... }

class HttpRequest { ... }

typedef bool Predicate<T>(T value);

甚至包括作为元数据注解的类。

class Foo {
const Foo([arg]);
}

@Foo(anArg)
class A { ... }

@Foo()
class B { ... }

其它标识符使用小写驼峰

类成员,顶级的定义,变量,参数,命名参数使用小写驼峰。

var item;

HttpRequest httpRequest;

void align(bool clearItems) {
// ...
}

常量名称

建议使用小写驼峰式命名

但是你的项目中如果使用大写+下划线分割单词的方式,则可以继续使用这种方式

这里有个小说明:最初dart中采用的大写+下划线方式,但是后来有一些变量需要修改为非const变量,就需要修改为小写驼峰式,后一律使用小写驼峰式

const pi = 3.14;

const defaultTimeout = 1000;

final urlScheme = new RegExp('^([a-z]+):');

class Dice {
static final numberGenerator = new Random();
}

缩写相关

大写首字母缩略词有点难以阅读,并且多个相邻的缩写可能导致模棱两可的名字。例如,一个以HTTPSFTP开始的名字,没有办法判断提及的是HTTPS FTP还是HTTP SFTP。

为了避免这种情况,除了两个字母的首字母缩略词以及缩写词,其它的还是像常规单词那样首字母大写。(两个字母的缩写词,像 ID 和 Mr. 仍然首字母大写。)

HttpConnectionInfo

uiHandler

IOStream

HttpRequest

Id

DB

规定代码的顺序

为了保持文件的整洁,我们规定指令出现的顺序。每个部分应该使用空行隔开。

在其它导入之前导入 “dart:”

import 'dart:async';

import 'dart:html';

import 'package:bar/bar.dart';

import 'package:foo/foo.dart';

在相对导入之前导入 “package:”

import 'package:bar/bar.dart';

import 'package:foo/foo.dart';

import 'util.dart';

在其它导入前导入第三方 “package:”

import 'package:bar/bar.dart';

import 'package:foo/foo.dart';

import 'package:my_package/util.dart';

在所有导入之后的单独部分指定导出

import 'src/error.dart';

import 'src/foo_bar.dart';

export 'src/error.dart';

注释

Dart的文档注释除了有 /** /外 ,还有 /// 。
三斜杠一般单行文档注释使用,多行时每行有个三斜杠效果和/
* */ 一样。

  1. 推荐使用///作为注释。
  2. Dart的文档注释中可以有markdown的标记语法
  3. 文件头统一注释模板

/// @desp:

/// @time ${DATE} {TIME} <br> /// @author \{USER}

/// 主要用于文档注释来注释成员和类型。

// 主要用于方法体内的注释

///item 点击
void _itemClick() {
  

_btnClick() {
  return () {
    //开始请求网络,显示提交框
    LcfarmUtil.showSubmitDialog(context);
    UserService.passwordVerify(_password, (data) {
      //成功回调
      //隐藏提交对话框
     
      Navigator.of(context).pop();

      LogUtil.v("登录成功");

      //进入修改密码页-静态路由表
      Navigator.pushNamed(context, Router.passwordUpdate,
          arguments: {"phone": "138****8175"});
    }, (HttpError error) {
      //失败回调
      //隐藏提交对话框
      Navigator.of(context).pop();
      LcfarmUtil.showTipDialog(context, error.message);
    });
  };
}

约定

  1. 函数体代码不宜过多,最好在20 - 30行以内 过多改用调用 一个方法中尽量只做一件事
  2. flutter嵌套层数最好3以内 改为调用
  3. 入参过多(4个以上),建议封类型
  4. 函数参数定义要写参数类型
  5. 加下划线代表private
  6. 不使用 new 创建(官方)
  7. if格式定死 条件判断请写好注释 不要嵌套太多的逻辑判断 不能超过3层
if (true) {
    // aa
} else {
    // bb
}

这样避免了else 悬挂的问题。

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

推荐阅读更多精彩内容