@Rookie 2022-06-22T07:08:15.000000Z 字数 7660 阅读 1312

Flutter及Dart 编码规范

flutter

Flutter及Dart 编码规范

每个部分都有许多的例子说明，每个例子都会以下面五个词中的某些作为开头：

DO ：表示你需要遵守的做法
DONT ：表示这样的做法是非常不好的
PREFER ：在多数情况下，都推荐的做法
AVOID ：在多数情况下，都应该避免的做法
CONSIDER ：需要你自己去斟酌的做法

在我看来，编码习惯都是因人而异的，并没有所谓的最佳方案。

如果你是一个人开发，当然不需要在意这些问题，但是如果你的代码需要展现给别人，或者你需要与别人协同开发，编码规范就非常有必要了。

下面，将会从官方文档中选取最基本，最典型，发生率较高的一些情况，作为规范说明。

✅表示正面做法，❌表示反面做法

样式规范

命名
DO: 类, 枚举, 类型定义, 以及泛型，都需要使用大写开头的驼峰命名法

✅
class SliderMenu { ... }
class HttpRequest { ... }
typedef Predicate<T> = bool Function(T value);

在使用注解时候，也应该这样

✅
class Foo {
  const Foo([arg]);
}
@Foo(anArg)
class A { ... }
@Foo()
class B { ... }

不过为一个类的构造函数添加注解时，你可能需要创建一个小写开头的注解变量

✅
const foo = Foo();
@foo
class C { ... }

DO: 命名库、包、目录、dart文件都应该是小写加上下划线

✅
library peg_parser.source_scanner;
import 'file_system.dart';
import 'slider_menu.dart';

❌
library pegparser.SourceScanner;
import 'file-system.dart';
import 'SliderMenu.dart';

DO: 将引用使用as转换的名字也应该是小写下划线

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

DO: 变量名、方法、参数名都应该是小写开头的驼峰命名法

✅
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();
}

花括号

DO: 只有一个if语句且没有else的时候，并且在一行内能够很好的展示，就可以不用花括号

✅
if (arg == null) return defaultValue;

但是如果一行内展示比较勉强的话，就需要用花括号了：

✅
if (overflowChars != other.overflowChars) {
  return overflowChars < other.overflowChars;
}

❌
if (overflowChars != other.overflowChars)
  return overflowChars < other.overflowChars;

文档规范

DO: 在dart的注释中，更加推荐使用///而非//

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

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

至于为什么要这样做，官方表示是由于历史原因以及他们觉得这个在某些情况下看起来更方便阅读。

DO: 文档注释应该以一句简明的话开头

✅
/// 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) {
  ...
}
DO: 将注释的第一句与其他内容分隔开来

✅
/// Deletes the file at [path].
///
/// Throws an [IOError] if the file could not be found. Throws a
/// [PermissionError] if the file is present but could not be deleted.
void delete(String path) {
  ...
}

❌
/// Deletes the file at [path]. Throws an [IOError] if the file could not
/// be found. Throws a [PermissionError] if the file is present but could
/// not be deleted.
void delete(String path) {
  ...
}

DO: 使用方括号去声明参数、返回值以及抛出的异常

❌
/// Defines a flag with the given name and abbreviation.
///
/// @param name The name of the flag.
/// @param abbr The abbreviation for the flag.
/// @returns The new flag.
/// @throws ArgumentError If there is already an option with
///     the given name or abbreviation.
Flag addFlag(String name, String abbr) => ...

✅
/// Defines a flag.
///
/// Throws an [ArgumentError] if there is already an option named [name] or
/// there is already an option using abbreviation [abbr]. Returns the new flag.
Flag addFlag(String name, String abbr) => ...

使用规范

依赖

PREFER: 推荐使用相对路径导入依赖

如果项目结构如下：

my_package
└─ lib
   ├─ src
   │  └─ utils.dart
   └─ api.dart

想要在 api.dart 中导入 utils.dart

✅
import 'src/utils.dart';

❌
import 'package:my_package/src/utils.dart';

赋值

DO: 使用??将null值做一个转换

在dart中 ?? 操作符表示当一个值为空时会给它赋值 ?? 后面的数据

❌
if (optionalThing?.isEnabled) {
  print("Have enabled thing.");
}

当 optionalThing 为空的时候，上面就会有空指针异常了。

这里说明一下。 ?. 操作符相当于做了一次判空操作，只有当 optionalThing 不为空的时候才会调用 isEnabled 参数，当 optionalThing 为空的话默认返回null，用在if判断句中自然就不行了

下面是正确做法

✅
// 如果为空的时候你想返回false的话:
optionalThing?.isEnabled ?? false;
// 如果为空的时候你想返回ture的话:
optionalThing?.isEnabled ?? true;

❌
optionalThing?.isEnabled == true;
optionalThing?.isEnabled == false;

字符串

在dart中，不推荐使用 + 去连接两个字符串

DO: 使用回车键直接分隔字符串

✅
raiseAlarm(
    'ERROR: Parts of the spaceship are on fire. Other '
    'parts are overrun by martians. Unclear which are which.');

❌
raiseAlarm('ERROR: Parts of the spaceship are on fire. Other ' +
    'parts are overrun by martians. Unclear which are which.');
PREFER: 使用${}来连接字符串与变量值

✅
'Hello, $name! You are ${year - birth} years old.';

❌
'Hello, ' + name + '! You are ' + (year - birth).toString() + ' y...';

集合

dart中创建空的可扩展 List 有两种方法: [] 和 List();创建空的 HashMap 有三种方法: {}, Map(),和 LinkedHashMap()

如果要创建不可扩展的列表或其他一些自定义集合类型，那么务必使用构造函数。

DO: 尽可能使用简单的字面量创建集合

✅
var points = [];
var addresses = {};

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

当你想要指定类型的时候

✅
var points = <Point>[];
var addresses = <String, Address>{};

❌
var points = List<Point>();
var addresses = Map<String, Address>();

DON’T: 不要使用.lenght的方法去表示一个集合是空的

✅
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(' ');
CONSIDER: 考虑使用高阶方法转换序列
var aquaticNames = animals
    .where((animal) => animal.isAquatic)
    .map((animal) => animal.name);

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

forEach（）函数在JavaScript中被广泛使用，因为内置的for-in循环不能达到你通常想要的效果。在Dart中，如果要迭代序列，那么惯用的方法就是使用循环。

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

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

DON’T: 不要使用 List.from() 除非你打算更改结果的类型

有两种方法去获取 Iterable，分别是List.from()和Iterable.toList()

✅
// 创建一个List<int>:
var iterable = [1, 2, 3];
// 输出"List<int>":
print(iterable.toList().runtimeType);

❌
// 创建一个List<int>:
var iterable = [1, 2, 3];
// 输出"List<dynamic>":
print(List.from(iterable).runtimeType);

DO: 使用 whereType()去用类型过滤一个集合

❌
var objects = [1, "a", 2, "b", 3];
var ints = objects.where((e) => e is int);

❌
var objects = [1, "a", 2, "b", 3];
var ints = objects.where((e) => e is int).cast<int>();

✅
var objects = [1, "a", 2, "b", 3];
var ints = objects.whereType<int>();
参数
DO: 使用 = 给参数设置默认值

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

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

DON’T: 不要将参数的默认值设置为 null

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

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

变量

AVOID: 避免存储可以计算的值

❌
class Circle {
  num _radius;
  num get radius => _radius;
  set radius(num value) {
    _radius = value;
    _recalculate();
  }
  num _area;
  num get area => _area;
  num _circumference;
  num get circumference => _circumference;
  Circle(this._radius) {
    _recalculate();
  }
  void _recalculate() {
    _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;
}

成员

DON’T: 不要写没必要的getter 和 setter

✅
class Box {
  var contents;
}

❌
class Box {
  var _contents;
  get contents => _contents;
  set contents(value) {
    _contents = value;
  }
}

构造函数

DO: 尽可能使用简单的初始化形式

❌
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);
}

DON’T: 不要使用 new 来创建对象

dart中不需要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!'),
    ],
  );
}

DON’T: 不要使用多余的 const 修饰对象

✅
const primaryColors = [
  Color("red", [255, 0, 0]),
  Color("green", [0, 255, 0]),
  Color("blue", [0, 0, 255]),
];

❌
const primaryColors = const [
  const Color("red", const [255, 0, 0]),
  const Color("green", const [0, 255, 0]),
  const Color("blue", const [0, 0, 255]),
];

异常处理

DO: 使用 rethrow 重新抛出异常

❌
try {
  somethingRisky();
} catch (e) {
  if (!canHandle(e)) throw e;
  handle(e);
}

✅
try {
  somethingRisky();
} catch (e) {
  if (!canHandle(e)) rethrow;
  handle(e);
}

设计

AVOID: 避免为了实现流式调用而让方法返回this

✅
var buffer = StringBuffer()
  ..write('one')
  ..write('two')
  ..write('three');

❌
var buffer = StringBuffer()
    .write('one')
    .write('two')
    .write('three');

AVOID: 避免使用 FutureOr 作为返回类型

✅
Future<int> triple(FutureOr<int> value) async => (await value) * 3;

❌
FutureOr<int> triple(FutureOr<int> value) {
  if (value is int) return value * 3;
  return (value as Future<int>).then((v) => v * 3);
}

AVOID: 避免将bool值直接作为输入参数

❌
new Task(true);
new Task(false);
new ListBox(false, true, true);
new Button(false);

✅
Task.oneShot();
Task.repeating();
ListBox(scroll: true, showScrollbars: true);
Button(ButtonState.enabled);
DON’T: 不要在自定义的 == operator 方法中进行判空

✅
class Person {
  final String name;
  // ···
  bool operator ==(other) => other is Person && name == other.name;
  int get hashCode => name.hashCode;
}

❌
class Person {
  final String name;
  // ···
  bool operator ==(other) => other != null && ...
}

Flutter及Dart 编码规范

样式规范

花括号

文档规范

使用规范

依赖

赋值

字符串

集合

变量

成员

构造函数

异常处理

设计

内容目录