Flutter 开发规范 仅供参考😁

1.大驼峰 

类、枚举、typedef和类型参数

class SliderMenu { ... }

class HttpRequest { ... } 

typedef Predicate = bool Function<T>(T value);

包括用于元数据注释的类

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

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

@Foo() class B { ... }

使用小写加下划线来命名库和源文件

library peg_parser.source_scanner; 

import 'file_system.dart';

import 'slider_menu.dart';

不推荐如下写法：

library pegparser.SourceScanner; 

import 'file-system.dart';

import 'SliderMenu.dart';

使用小写加下划线来命名导入前缀

import 'dart:math' as math; 

import 'package:angular_components/angular_components' as angular_components;

import 'package:js/js.dart' as js;

不推荐如下写法：

import 'dart:math' as Math;

import 'package:angular_components/angular_components' as angularComponents;

import 'package:js/js.dart' as JS;

2.小驼峰

var item; 

HttpRequest httpRequest; void align(bool clearItems) { // ... }

优先使用小驼峰法作为常量命名

const pi = 3.14;

const defaultTimeout = 1000; 

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

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

不推荐如下写法：

const PI = 3.14; const DefaultTimeout = 1000;

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

class Dice { static final NUMBER_GENERATOR = Random(); }

不使用前缀字母

因为Dart可以告诉您声明的类型、范围、可变性和其他属性，

所以没有理由将这些属性编码为标识符名称。

defaultTimeout不推荐如下写法：

kDefaultTimeout排序为了使你的文件前言保持整洁，我们有规定的命令，指示应该出现在其中。

每个“部分”应该用空行分隔。

3.引库

在其他引入之前引入所需的dart库

import 'dart:async';

import 'dart:html';

import 'package:bar/bar.dart';

import 'package:foo/foo.dart';

在相对引入之前先引入在包中的库

import 'package:bar/bar.dart'; 

import 'package:foo/foo.dart'; 

import 'util.dart';

第三方包的导入先于其他包

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';

不推荐如下写法：

import 'src/error.dart'; 

export 'src/error.dart';

import 'src/foo_bar.dart';

4.所有流控制结构，请使用大括号这样做可以避免悬浮的else问题 

if (isWeekDay) {

print('Bike to work!'); 

} else {

print('Go dancing or read a book!');

}

一个if语句没有else子句，其中整个if语句和then主体都适合一行。

在这种情况下，如果你喜欢的话，你可以去掉大括号

if (arg == null) return defaultValue;

如果流程体超出了一行需要分划请使用大括号：

if (overflowChars != other.overflowChars) { 

return overflowChars < other.overflowChars; 

}

不推荐如下写法：

if (overflowChars != other.overflowChars)

return overflowChars < other.overflowChars;

注释要像句子一样格式化 除非是区分大小写的标识符，否则第一个单词要大写。

以句号结尾  (或“!”或“?”)。对于所有的注释都是如此：doc注释、内联内容，甚至TODOs。

即使是一个句子片段。

greet(name) { // Assume we have a valid name. print('Hi, $name!'); }不推荐如下写法：

greet(name) { /* Assume we have a valid name. */ print('Hi, $name!'); }

可以使用块注释(/…/)临时注释掉一段代码，

但是所有其他注释都应该使用//Doc注释 

使用///文档注释来记录成员和类型。

使用doc注释而不是常规注释，可以让dartdoc找到并生成文档。

/// The number of characters in this chunk when unsplit. int get length => ...

考虑为私有api编写文档注释 Doc注释并不仅仅针对库的公共API的外部使用者。

它们还有助于理解从库的其他部分调用的私有成员以简短的、

以用户为中心的描述开始你的文档注释，以句号结尾。

/// Deletes the file at [path] from the file system. void delete(String path) { ... }

不推荐如下写法：

/// Depending on the state of the file system and the user's permissions, 

/// certain operations may or may not be possible. If there is no file at

/// [path] or it can't be accessed, this function throws either [IOError]

/// or [PermissionError], respectively. Otherwise, this deletes the file.

void delete(String path) { ... }

字符串的使用优先使用模板字符串 'Hello, $name! You are ${year - birth} years old.';

集合尽可能使用集合字面量 如果要创建一个不可增长的列表，或者其他一些自定义集合类型，

var points = []; 

var addresses = {};

var lines = <Lines>[];

不推荐如下写法：

var points = List(); var addresses = Map();

不要使用.length查看集合是否为空

if (lunchBox.isEmpty) return 'so hungry...'; 

if (words.isNotEmpty) return words.join(' ');

不推荐如下写法：

if (lunchBox.length == 0) return 'so hungry...'; 

if (!words.isEmpty) return words.join(' ');

考虑使用高阶方法转换序列 如果有一个集合，并且希望从中生成一个新的修改后的集合，

那么使用.map()、.where()和Iterable上的其他方便的方法通常更短，也更具有声明性

var aquaticNames = animals .where((animal) => animal.isAquatic) .map((animal) => animal.name);   

避免使用带有函数字面量的Iterable.forEach()

5.循环/遍历/赋值

在Dart中，如果你想遍历一个序列，惯用的方法是使用循环。

for (var person in people) { ... }

不推荐如下写法：

people.forEach((person) { ... });

不要使用List.from()，除非打算更改结果的类型 给定一个迭代，

有两种明显的方法可以生成包含相同元素的新列表

 var copy1 = iterable.toList();

 var copy2 = List.from(iterable);

明显的区别是第一个比较短。

重要的区别是第一个保留了原始对象的类型参数

// Creates a List<int>: var iterable = [1, 2, 3]; 

 // Prints "List<int>": print(iterable.toList().runtimeType);

// Creates a List<int>: var iterable = [1, 2, 3]; 

 // Prints "List<dynamic>": print(List.from(iterable).runtimeType);

参数的使用使用=将命名参数与其默认值分割开 由于遗留原因，Dart均允许“:”和“=”作为指定参数的默认值分隔符。

为了与可选的位置参数保持一致，使用“=”。

void insert(Object item, {int at = 0}) { ... }

不推荐如下写法：

void insert(Object item, {int at: 0}) { ... }

如果参数是可选的，但没有给它一个默认值，则语言隐式地使用null作为默认值，因此不需要编写它

void error([String message]) { stderr.write(message ?? '\n'); }

不推荐如下写法:

void error([String message = null])

 { stderr.write(message ?? '\n'); }

变量不要显式地将变量初始化为空 在Dart中，未显式初始化的变量或字段自动被初始化为null。

不要多余赋值

nullint _nextId; 

 class LazyId { 

 int _id;

 int get id {

 if (_nextId == null) _nextId = 0;

 if (_id == null) _id = _nextId++;

 return _id;

 } }

不推荐如下写法：

int _nextId = null; 

 class LazyId { 

 int _id = null;

 int get id {

 if (_nextId == null) _nextId = 0;

 if (_id == null) _id = _nextId++; return _id;

 } }

避免储存你能计算的东西 在设计类时，您通常希望将多个视图公开到相同的底层状态。

通常你会看到在构造函数中计算所有视图的代码，然后存储它们:

class Circle { 

 num radius; 

 num area; 

 num circumference;

 Circle(num radius) : radius = radius, 

 area = pi * radius * radius, 

 circumference = pi * 2.0 * radius; 

 }

如上代码问题：

浪费内存缓存的问题是无效——如何知道何时缓存过期需要重新计算？

推荐的写法如下：

class Circle { 

 num radius; 

 Circle(this.radius);

 num get area => pi * radius * radius; 

 num get circumference => pi * 2.0 * radius;

 }

类成员不要把不必要地将字段包装在getter和setter中 

不推荐如下写法：

class Box {

 var _contents; 

 get contents => _contents; 

 set contents(value) {

 _contents = value;

 } }

优先使用final字段来创建只读属性 尤其对于 StatelessWidget在不需要的时候不要用this 

不推荐如下写法：

class Box { 

 var value; 

 void clear() {

 this.update(null); 

 } 

 void update(value) {

 this.value = value; 

 } }

推荐如下写法：

class Box {

 var value; 

 void clear() {

 update(null); 

 } 

 void update(value) { 

 this.value = value;

 } }

构造函数尽可能使用初始化的形式 

不推荐如下写法：

class Point { 

 num x, y; 

 Point(num x, num y) { this.x = x; this.y = y; } }

推荐如下写法：

class Point { num x, y; Point(this.x, this.y); }

不要使用new Dart2使new 

关键字可选推荐写法：

Widget build(BuildContext context) {

 return Row( children: [

 RaisedButton( child: Text('Increment'), ), Text('Click!'), 

 ], ); }

不推荐如下写法：

Widget build(BuildContext context) { 

 return new Row( children: [

 new RaisedButton( child: new Text('Increment'), ), new Text('Click!'),

 ], ); }

6.异步

异步优先使用async/await代替原始的futures async/await语法提高了可读性，允许你在异步代码中使用所有Dart控制流结构。

Future<int> countActivePlayers(String teamName) async { 

 try {

 var team = await downloadTeam(teamName); 

 if (team == null) return 0;

 var players = await team.roster;

 return players.where((player) => player.isActive).length;

 } catch (e) { log.error(e); return 0; } }

当异步没有任何用处时，不要使用它 如果可以在不改变函数行为的情况下省略异步，那么就这样做:

Future afterTwoThings(Future first, Future second) { return Future.wait([first, second]); }

不推荐写法：

Future afterTwoThings(Future first, Future second) async { return Future.wait([first, second]); }

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,193评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,306评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,130评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,110评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,118评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,085评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,007评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,844评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,283评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,508评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,395评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,985评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,630评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,797评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,653评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,553评论 2赞 352