Dart 库预览

http://dart.goodev.org/guides/libraries/library-tour#strings-and-regular-expressions

这里讲介绍 Dart 核心库中的主要特性和功能。 只是一个预览,并不会面面俱到。 如果你想了解更详细的信息,请参考 Dart API 文档。

关于 Dart 语言的更多信息请参考: Dart 语言预览。

dart:core - numbers, collections, strings, and more

Dart core 库提供了少量的但是非常核心的功能。每个 Dart 应用都会自动导入这个 库。

Numbers

dart:core 库定义了 num, int, 和 double 类,这些类 定义一些操作数字的基础功能。

使用 parse() 函数可以把字符串 转换为 整数或者浮点数。

assert(int.parse('42') == 42);
assert(int.parse('0x42') == 66);
assert(double.parse('0.50') == 0.5);

num 类也定义了一个 parse() 函数,这个函数会尝试解析 为整数,如果无法解析为整数,则会解析为浮点数(double)。

assert(num.parse('42') is int);
assert(num.parse('0x42') is int);
assert(num.parse('0.50') is double);

对于整数,可以指定一个 radix 作为基数:

assert(int.parse('42', radix: 16) == 66);

使用 toString() 函数 (由 Object 对象定义)来把整数或者浮点数 转换为字符串。使用 num 类的函数 toStringAsFixed() 可以限定 小数点的位数。如果要指定转换为字符串的有效位数, 则可以使用定义在 num 类的 函数 toStringAsPrecision():

// Convert an int to a string.
assert(42.toString() == '42');

// Convert a double to a string.
assert(123.456.toString() == '123.456');

// Specify the number of digits after the decimal.
assert(123.456.toStringAsFixed(2) == '123.46');

// Specify the number of significant figures.
assert(123.456.toStringAsPrecision(2) == '1.2e+2');
assert(double.parse('1.2e+2') == 120.0);

更多信息,参考 API 文档中每个类的描述: int, double, 和 num。 另外还有 dart:math提供了关于数学运算的常用功能。

Strings and regular expressions(字符串和正则表达式)

Dart 中的字符串是一个不可变的 UTF-16 码元(code units)序列。 在语言预览中对 字符串有详细的介绍。 你可以使用正则表达式(RegExp 对象) 来搜索字符串中的内容或者 替换部分字符串。

String 类定义了一些函数 split(), contains(), startsWith(), endsWith() 等来处理各种字符串操作。

Searching inside a string(在字符串内搜索) 可以在字符串内查找特定字符的位置,还可以 判断字符串是否以特定字符串开始和结尾。 例如:

// Check whether a string contains another string.
assert('Never odd or even'.contains('odd'));

// Does a string start with another string?
assert('Never odd or even'.startsWith('Never'));

// Does a string end with another string?
assert('Never odd or even'.endsWith('even'));

// Find the location of a string inside a string.
assert('Never odd or even'.indexOf('odd') == 6);

Extracting data from a string(从字符串中提取数据)

可以从字符串中获取到单个的字符,单个字符可以是 String 也可以是 int 值。 准确来说,实际得到的是一个 UTF-16 code units; 对于码率比较大的字符,实际得到的是两个 code units,例如 treble clef 符号 (‘\u{1D11E}’) 。

还可以从字符串中提取一个子字符串,或者把字符串分割为 多个子字符串:

// Grab a substring.
assert('Never odd or even'.substring(6, 9) == 'odd');

// Split a string using a string pattern.
var parts = 'structured web apps'.split(' ');
assert(parts.length == 3);
assert(parts[0] == 'structured');

// Get a UTF-16 code unit (as a string) by index.
assert('Never odd or even'[0] == 'N');

// Use split() with an empty string parameter to get
// a list of all characters (as Strings); good for
// iterating.
for (var char in 'hello'.split('')) {
  print(char);
}

// Get all the UTF-16 code units in the string.
var codeUnitList = 'Never odd or even'.codeUnits.toList();
assert(codeUnitList[0] == 78);

Converting to uppercase or lowercase(大小写转换)

字符串大小写转换是非常 简单的:

// Convert to uppercase.
assert('structured web apps'.toUpperCase() ==
    'STRUCTURED WEB APPS');

// Convert to lowercase.
assert('STRUCTURED WEB APPS'.toLowerCase() ==
    'structured web apps');

注意: 注意上面的转换方式对于某些语言是有问题的。例如对于土耳其语言 中的无点 I 的转换就是错误的。

Trimming and empty strings(裁剪和判断空字符串)

trim() 函数可以删除字符串前后的空白字符。使用 isEmpty 可以 判断字符串是否为空(长度为 0)。

// Trim a string.
assert('  hello  '.trim() == 'hello');

// Check whether a string is empty.
assert(''.isEmpty);

// Strings with only white space are not empty.
assert(!'  '.isEmpty);

Replacing part of a string(替换部分字符)

Strings 是不可变的对象,可以创建他们但是无法修改。 如果你仔细研究了 String API 文档,你会注意到并没有 函数可以修改字符串的状态。 例如,函数 replaceAll() 返回一个新的 String 对象而不是修改 旧的对象:

var greetingTemplate = 'Hello, NAME!';
var greeting = greetingTemplate
    .replaceAll(new RegExp('NAME'), 'Bob');

assert(greeting !=
    greetingTemplate); // greetingTemplate didn't change.

Building a string(创建字符串)

使用 StringBuffer 可以在代码中创建字符串。 只有当你调用 StringBuffer 的 toString() 函数的时候,才会创建一个 新的 String 对象。而 writeAll() 函数还有一个可选的参数来指定每个字符串的分隔符, 例如下面指定空格为分隔符:

var sb = new StringBuffer();
sb..write('Use a StringBuffer for ')
  ..writeAll(['efficient', 'string', 'creation'], ' ')
  ..write('.');

var fullString = sb.toString();

assert(fullString ==
    'Use a StringBuffer for efficient string creation.');

Regular expressions(正则表达式)

RegExp 类提供了 JavaScript 正则表达式同样的功能。 正则表达式可以高效率的搜索和匹配 字符串。

// Here's a regular expression for one or more digits.
var numbers = new RegExp(r'\d+');

var allCharacters = 'llamas live fifteen to twenty years';
var someDigits = 'llamas live 15 to 20 years';

// contains() can use a regular expression.
assert(!allCharacters.contains(numbers));
assert(someDigits.contains(numbers));

// Replace every match with another string.
var exedOut = someDigits.replaceAll(numbers, 'XX');
assert(exedOut == 'llamas live XX to XX years');

还可以直接操作 RegExp 类。 Match 类提供了 访问正则表达式匹配到的内容。

var numbers = new RegExp(r'\d+');
var someDigits = 'llamas live 15 to 20 years';

// Check whether the reg exp has a match in a string.
assert(numbers.hasMatch(someDigits));

// Loop through all matches.
for (var match in numbers.allMatches(someDigits)) {
  print(match.group(0)); // 15, then 20
}

More information(更多信息)

参考 String API 文档 来查看 String 类的所有 方法。同时还可以参考下面这些类的 api 文档: StringBuffer, Pattern, RegExp, 和 Match.

Collections

Dart 提供了一些核心的集合 API,包含 lists, sets, 和 maps。

Lists

在语言预览中已经介绍过如何 创建 lists了。另外还可以 使用 List 构造函数来创建 List 对象。 List 类来定义了一些函数可以添加或者删除里面的数据。

// Use a List constructor.
var vegetables = new List();

// Or simply use a list literal.
var fruits = ['apples', 'oranges'];

// Add to a list.
fruits.add('kiwis');

// Add multiple items to a list.
fruits.addAll(['grapes', 'bananas']);

// Get the list length.
assert(fruits.length == 5);

// Remove a single item.
var appleIndex = fruits.indexOf('apples');
fruits.removeAt(appleIndex);
assert(fruits.length == 4);

// Remove all elements from a list.
fruits.clear();
assert(fruits.length == 0);

使用 indexOf() 来查找 list 中对象的索引:

var fruits = ['apples', 'oranges'];

// Access a list item by index.
assert(fruits[0] == 'apples');

// Find an item in a list.
assert(fruits.indexOf('apples') == 0);

排序一个 list 可以使用 sort() 函数。还可以提供一个用来排序 的比较方法。排序方法返回值 为:对于小的值 为 < 0;对于相同的值为 0 ;对于大的值为 > 0。 下面的示例使用由 Comparable 定义的 compareTo() 函数,该函数也被 String 实现了。

var fruits = ['bananas', 'apples', 'oranges'];

// Sort a list.
fruits.sort((a, b) => a.compareTo(b));
assert(fruits[0] == 'apples');

List 是泛型类型,所以可以指定 里面所保存的数据类型:

// This list should contain only strings.
var fruits = new List<String>();

fruits.add('apples');
var fruit = fruits[0];
assert(fruit is String);

// Generates static analysis warning, num is not a string.
fruits.add(5);  // BAD: Throws exception in checked mode.

参考 List API 文档 来查看 list 的 所有函数。

Sets

Dart 中的 Set 是一个无序集合,里面不能保护重复的数据。 由于是无序的,所以无法通过索引来从 set 中获取数据:

var ingredients = new Set();
ingredients.addAll(['gold', 'titanium', 'xenon']);
assert(ingredients.length == 3);

// Adding a duplicate item has no effect.
ingredients.add('gold');
assert(ingredients.length == 3);

// Remove an item from a set.
ingredients.remove('gold');
assert(ingredients.length == 2);

使用 contains()containsAll() 来判断 set 中是否包含 一个或者多个对象:

var ingredients = new Set();
ingredients.addAll(['gold', 'titanium', 'xenon']);

// Check whether an item is in the set.
assert(ingredients.contains('titanium'));

// Check whether all the items are in the set.
assert(ingredients.containsAll(['titanium', 'xenon']));
交际是两个 set 中都有的数据的子集:

var ingredients = new Set();
ingredients.addAll(['gold', 'titanium', 'xenon']);

// Create the intersection of two sets.
var nobleGases = new Set.from(['xenon', 'argon']);
var intersection = ingredients.intersection(nobleGases);
assert(intersection.length == 1);
assert(intersection.contains('xenon'));

Maps

map 通常也被称之为 字典或者 hash ,也是一个无序的集合,里面 包含一个 key-value 对。map 把 key 和 value 关联起来可以 方便获取数据。和 JavaScript 不同的是, Dart objects 不是 maps。

下面是两种定义 map 对象的方式:

// Maps often use strings as keys.
var hawaiianBeaches = {
  'Oahu'      : ['Waikiki', 'Kailua', 'Waimanalo'],
  'Big Island': ['Wailea Bay', 'Pololu Beach'],
  'Kauai'     : ['Hanalei', 'Poipu']
};

// Maps can be built from a constructor.
var searchTerms = new Map();

// Maps are parameterized types; you can specify what
// types the key and value should be.
var nobleGases = new Map<int, String>();

使用中括号来访问或者设置 map 中的数据, 使用 remove() 函数来从 map 中删除 key 和 value。

var nobleGases = {54: 'xenon'};

// Retrieve a value with a key.
assert(nobleGases[54] == 'xenon');

// Check whether a map contains a key.
assert(nobleGases.containsKey(54));

// Remove a key and its value.
nobleGases.remove(54);
assert(!nobleGases.containsKey(54));

还可以获取 map 的所有 key 和 value:

var hawaiianBeaches = {
  'Oahu'      : ['Waikiki', 'Kailua', 'Waimanalo'],
  'Big Island': ['Wailea Bay', 'Pololu Beach'],
  'Kauai'     : ['Hanalei', 'Poipu']
};

// Get all the keys as an unordered collection
// (an Iterable).
var keys = hawaiianBeaches.keys;

assert(keys.length == 3);
assert(new Set.from(keys).contains('Oahu'));

// Get all the values as an unordered collection
// (an Iterable of Lists).
var values = hawaiianBeaches.values;
assert(values.length == 3);
assert(values.any((v) => v.contains('Waikiki')));

containsKey() 判断 map 是否包含一个 key。由于 map 的 value 可以为 null, 所有通过 key 来获取 value 并通过 判断 value 是否为 null 来判断 key 是否存在是 行不通的。所以添加了一个判断 key 是否存在的函数:

var hawaiianBeaches = {
  'Oahu'      : ['Waikiki', 'Kailua', 'Waimanalo'],
  'Big Island': ['Wailea Bay', 'Pololu Beach'],
  'Kauai'     : ['Hanalei', 'Poipu']
};

assert(hawaiianBeaches.containsKey('Oahu'));
assert(!hawaiianBeaches.containsKey('Florida'));

map 还有一个 putIfAbsent() 函数来设置 key 的值,但是只有该 key 在 map 中不存在的时候才设置这个值,否则 key 的值保持不变。该函数需要 一个方法返回 value:

var teamAssignments = {};
teamAssignments.putIfAbsent(
    'Catcher', () => pickToughestKid());
assert(teamAssignments['Catcher'] != null);

Common collection methods(常用的集合函数)

List, Set, 和 Map 上可以使用很多常用的集合函数。 Iterable 类定义了一些常用的功能, List 和 Set 实现了 Iterable 。

注意: 虽然 Map 没有实现 Iterable,但是 Map 的 keys 和 values 属性实现了 Iterable。

可以使用 isEmpty 函数来判断集合是否为空的:

var teas = ['green', 'black', 'chamomile', 'earl grey'];
assert(!teas.isEmpty);

使用 forEach() 函数可以对集合中的每个数据都应用 一个方法:

var teas = ['green', 'black', 'chamomile', 'earl grey'];

teas.forEach((tea) => print('I drink $tea'));

在 Map 上使用 forEach() 的时候,方法需要能 接收两个参数(key 和 value):

hawaiianBeaches.forEach((k, v) {
  print('I want to visit $k and swim at $v');
  // I want to visit Oahu and swim at
  // [Waikiki, Kailua, Waimanalo], etc.
});

Iterables 也有一个 map() 函数,这个函数返回一个包含所有数据的对象:

var teas = ['green', 'black', 'chamomile', 'earl grey'];

var loudTeas = teas.map((tea) => tea.toUpperCase());
loudTeas.forEach(print);

注意: map() 函数返回的对象也是一个 Iterable,该对象是懒求值(lazily evaluated) 的,只有当访问里面的值的时候, map 的方法才被调用。

可以使用 map().toList() 或者 map().toSet() 来 强制立刻执行 map 的方法:

var loudTeaList = teas
    .map((tea) => tea.toUpperCase())
    .toList();

Iterable 的 where() 函数可以返回所有满足特定条件的数据。 any() 判断是否有数据满足特定条件, every() 判断是否所有数据都满足 特定条件。

var teas = ['green', 'black', 'chamomile', 'earl grey'];

// Chamomile is not caffeinated.
bool isDecaffeinated(String teaName) =>
    teaName == 'chamomile';

// Use where() to find only the items that return true
// from the provided function.
var decaffeinatedTeas = teas
    .where((tea) => isDecaffeinated(tea));
// or teas.where(isDecaffeinated)

// Use any() to check whether at least one item in the
// collection satisfies a condition.
assert(teas.any(isDecaffeinated));

// Use every() to check whether all the items in a
// collection satisfy a condition.
assert(!teas.every(isDecaffeinated));

URIs

Uri 类 提供了 编码和解码 URI(URL) 字符的功能。 这些函数处理 URI 特殊的字符,例如 & 和 =。 Uri 类还可以解析和处理 URI 的每个部分,比如 host, port, scheme 等。

Encoding and decoding fully qualified URIs(编码解码URI) 要编码和解码除了 URI 中特殊意义(例如 /, :, &, #)的字符, 则可以使用 encodeFull() 和 decodeFull() 函数。这两个函数可以用来编码和解码整个 URI,并且保留 URI 特殊意义的字符不变。

var uri = 'http://example.org/api?foo=some message';

var encoded = Uri.encodeFull(uri);
assert(encoded ==
    'http://example.org/api?foo=some%20message');

var decoded = Uri.decodeFull(encoded);
assert(uri == decoded);

注意上面 some 和 message 之间的空格被编码了。

Encoding and decoding URI components(编码解码URI组件)

使用 encodeComponent() 和 decodeComponent() 可以编码 和解码 URI 中的所有字符,特殊意义的字符(/, &, 和 : 等) 也会编码,

var uri = 'http://example.org/api?foo=some message';

var encoded = Uri.encodeComponent(uri);
assert(encoded ==
    'http%3A%2F%2Fexample.org%2Fapi%3Ffoo%3Dsome%20message');

var decoded = Uri.decodeComponent(encoded);
assert(uri == decoded);

注意上面特殊字符也被编码了,比如 / 编码为 %2F。

Parsing URIs

如果有个 Uri 对象或者 URI 字符串,使用 Uri 的属性 可以获取每个部分,比如 path。使用 parse() 静态 函数可以从字符串中解析一个 Uri 对象:

var uri = Uri.parse('http://example.org:8080/foo/bar#frag');

assert(uri.scheme   == 'http');
assert(uri.host     == 'example.org');
assert(uri.path     == '/foo/bar');
assert(uri.fragment == 'frag');
assert(uri.origin   == 'http://example.org:8080');

Building URIs

使用 Uri() 构造函数可以从 URI 的 各个部分来构造一个 Uri 对象:

var uri = new Uri(scheme: 'http', host: 'example.org',
                  path: '/foo/bar', fragment: 'frag');
assert(uri.toString() ==
    'http://example.org/foo/bar#frag');

Dates and times

DateTime 对象代表某个时刻。时区是 UTC 或者 本地时区。

一些构造函数可以创建 DateTime 对象:

// Get the current date and time.
var now = new DateTime.now();

// Create a new DateTime with the local time zone.
var y2k = new DateTime(2000);   // January 1, 2000

// Specify the month and day.
y2k = new DateTime(2000, 1, 2); // January 2, 2000

// Specify the date as a UTC time.
y2k = new DateTime.utc(2000);   // 1/1/2000, UTC

// Specify a date and time in ms since the Unix epoch.
y2k = new DateTime.fromMillisecondsSinceEpoch(
    946684800000, isUtc: true);

// Parse an ISO 8601 date.
y2k = DateTime.parse('2000-01-01T00:00:00Z');
millisecondsSinceEpoch 属性返回自从 “Unix epoch”—January 1, 1970, UTC 以来的毫秒数值:

// 1/1/2000, UTC
y2k = new DateTime.utc(2000);
assert(y2k.millisecondsSinceEpoch == 946684800000);

// 1/1/1970, UTC
var unixEpoch = new DateTime.utc(1970);
assert(unixEpoch.millisecondsSinceEpoch == 0);

使用 Duration 类可以计算两个日期之间的间隔, 还可以前后位移日期:

var y2k = new DateTime.utc(2000);

// Add one year.
var y2001 = y2k.add(const Duration(days: 366));
assert(y2001.year == 2001);

// Subtract 30 days.
var december2000 = y2001.subtract(
    const Duration(days: 30));
assert(december2000.year == 2000);
assert(december2000.month == 12);

// Calculate the difference between two dates.
// Returns a Duration object.
var duration = y2001.difference(y2k);
assert(duration.inDays == 366); // y2k was a leap year.

警告: 使用 Duration 来在 DateTime 对象上前后移动数天可能会有问题, 比如像夏令时等时间问题。如果要按照天数来位移时间,则 需要使用 UTC 日期。

Utility classes(工具类)

核心库还包含了一些常用的工具类,比如排序、 值映射以及遍历数据等。

Comparing objects(比较对象)

实现 Comparable 接口表明该对象可以相互比较,通常用来 排序。compareTo() 函数对于 小于的值返回 < 0 ; 相同的值返回 0 ; 大于的值返回 > 0、

class Line implements Comparable {
  final length;
  const Line(this.length);
  int compareTo(Line other) => length - other.length;
}

main() {
  var short = const Line(1);
  var long = const Line(100);
  assert(short.compareTo(long) < 0);
}

Implementing map keys

Dart 中的每个对象都有一个整数 hash 码,这样每个对象都 可以当做 map 的 key 来用。但是,你可以覆写 hashCode getter 来自定义 hash 码的实现,如果你这样做了,你也需要 同时覆写 == 操作符。相等的对象(使用 == 比较)的 hash 码应该一样。Hasm 码并不要求是唯一的, 但是应该具有良好的分布形态。

class Person {
  final String firstName, lastName;

  Person(this.firstName, this.lastName);

  // Override hashCode using strategy from Effective Java,
  // Chapter 11.
  int get hashCode {
    int result = 17;
    result = 37 * result + firstName.hashCode;
    result = 37 * result + lastName.hashCode;
    return result;
  }

  // You should generally implement operator == if you
  // override hashCode.
  bool operator ==(other) {
    if (other is! Person) return false;
    Person person = other;
    return (person.firstName == firstName &&
        person.lastName == lastName);
  }
}

main() {
  var p1 = new Person('bob', 'smith');
  var p2 = new Person('bob', 'smith');
  var p3 = 'not a person';
  assert(p1.hashCode == p2.hashCode);
  assert(p1 == p2);
  assert(p1 != p3);
}

Iteration

Iterable 和 Iterator 类支持 for-in 循环。当你创建一个类的时候,继承或者实现 Iterable 可以 提供一个用于 for-in 循环的 Iterators。 实现 Iterator 来定义实际的遍历操作。

class Process {
  // Represents a process...
}

class ProcessIterator implements Iterator<Process> {
  Process current;
  bool moveNext() {
    return false;
  }
}

// A mythical class that lets you iterate through all
// processes. Extends a subclass of Iterable.
class Processes extends IterableBase<Process> {
  final Iterator<Process> iterator =
      new ProcessIterator();
}

main() {
  // Iterable objects can be used with for-in.
  for (var process in new Processes()) {
    // Do something with the process.
  }
}

Exceptions

Dart 核心库定义了很多常见的异常和错误类。 异常通常是一些可以预知和预防的例外情况。 错误这是无法预料的并且不需要预防的情况。

下面是一些常见的错误:

NoSuchMethodError 当在一个对象上调用一个该对象没有 实现的函数会抛出该错误。

ArgumentError 调用函数的参数不合法会抛出这个错误。

抛出一个应用相关的异常是一种用来表明有错误发生的常见 方法。你还可以通过实现 Exception 接口来自定义 一些异常。

class FooException implements Exception {
  final String msg;
  const FooException([this.msg]);
  String toString() => msg ?? 'FooException';
}

dart:async - asynchronous programming

异步编程通常使用回调函数,但是 Dart 提供了另外的 选择: Future 和 Stream 对象。 Future 和 JavaScript 中的 Promise 类似,代表在将来某个时刻会返回一个 结果。Stream 是一种用来获取一些列数据的方式,例如 事件流。 Future, Stream, 以及其他异步操作的类在 dart:async 库中。

注意: 你并不是都需要直接使用 Future 和 Stream。 Dart 语言有一些异步功能的关键字,例如 async 和 await。 详细信息 请参考 异步支持。

dart:async 库在 web app 和命令行 app 都可以使用。 只需要导入 dart:async 即可使用:

import 'dart:async';

Future

在 Dart 库中随处可见 Future 对象,通常异步函数返回的对象就是一个 Future。 当一个 future 执行完后,他里面的值 就可以使用了。

Using await

在直接使用 Future api 之前,你可以考虑先使用 await。 使用 await 的表达式比直接使用 Future api 的代码要更加 容易理解。

例如下面的方法。使用 Future 的 then() 函数来 执行三个异步方法, 每个方法执行完后才继续执行后一个方法。

runUsingFuture() {
  //...
  findEntrypoint().then((entrypoint) {
    return runExecutable(entrypoint, args);
  }).then(flushThenExit);
}

下面是使用 await 表达式实现的同样功能的代码, 看起来更像是同步代码,更加容易理解:

runUsingAsyncAwait() async {
  //...
  var entrypoint = await findEntrypoint();
  var exitCode = await runExecutable(entrypoint, args);
  await flushThenExit(exitCode);
}

异步方法可以把 Future 中的错误当做 异常来处理。 例如:

attached() async {
  super.attached();
  try {
    await appObject.start();
  } catch (e) {
    //...handle the error...
  }
}

重要: 异步方法(带有关键字 async 的方法)会返回 Future。 如果你不想让你的方法返回 future,则 不要使用 async 关键字。 例如,你可以在你的方法里面调用一个 异步方法。

关于使用 await 和相关 Dart 语言的其他特性,请参考 异步支持。

Basic usage

可以使用 then() 来在 future 完成的时候执行其他代码。例如 HttpRequest.getString() 返回一个Future,由于 HTTP 请求是一个 耗时操作。使用 then() 可以在 Future 完成的时候执行其他代码 来解析返回的数据:

HttpRequest.getString(url).then((String result) {
  print(result);
});
// Should handle errors here.

使用 catchError() 来处理 Future 对象可能抛出的 各种异常和错误:

HttpRequest.getString(url).then((String result) {
  print(result);
}).catchError((e) {
  // Handle or ignore the error.
});

then().catchError() 模式就是异步版本的 try-catch

重要: 确保是在 then() 返回的 Future 上调用 catchError(), 而不是在 原来的 Future 对象上调用。否则的话,catchError() 就只能处理原来 Future 对象抛出的异常而无法处理 then() 代码 里面的异常。

Chaining multiple asynchronous methods

then() 函数返回值为 Future,可以把多个异步调用给串联起来。 如果 then() 函数注册的回调函数也返回一个 Future,而 then() 返回一个同样的 Future。如果回调函数返回的是一个其他类型的值, 则 then() 会创建一个新的 Future 对象 并完成这个 future。

Future result = costlyQuery();

return result.then((value) => expensiveWork())
             .then((value) => lengthyComputation())
             .then((value) => print('done!'))
             .catchError((exception) => print('DOH!'));

上面的示例中,代码是按照如下顺序执行的:

    1. costlyQuery()
    1. expensiveWork()
    1. lengthyComputation()

Waiting for multiple futures

有时候,你的算法要求调用很多异步方法,并且等待 所有方法完成后再继续执行。使用 Future.wait() 这个静态函数来管理多个 Future 并等待所有 Future 执行完成。

Future deleteDone = deleteLotsOfFiles();
Future copyDone = copyLotsOfFiles();
Future checksumDone = checksumLotsOfOtherFiles();

Future.wait([deleteDone, copyDone, checksumDone])
    .then((List values) {
      print('Done with all the long steps');
    });

Stream

Stream 在 Dart API 中也经常出现,代表一些列数据。 例如, HTML 按钮点击事件就可以使用 stream 来表示。 还可以把读取文件内容当做一个 Stream。

Using an asynchronous for loop

有时候可以使用异步 for 循环(await for)来 替代 Stream API。

例如下面的示例中,使用 Stream 的 listen() 函数来订阅 一些文件,然后使用一个方法参数来 搜索每个文件和目录。

void main(List<String> arguments) {
  ...
  FileSystemEntity.isDirectory(searchPath).then((isDir) {
    if (isDir) {
      final startingDir = new Directory(searchPath);
      startingDir
          .list(
              recursive: argResults[RECURSIVE],
              followLinks: argResults[FOLLOW_LINKS])
          .listen((entity) {
        if (entity is File) {
          searchFile(entity, searchTerms);
        }
      });
    } else {
      searchFile(new File(searchPath), searchTerms);
    }
  });
}

下面是使用 await 表达式和异步 for 循环 实现的等价的代码, 看起来更像是同步代码:

main(List<String> arguments) async {
  ...
  if (await FileSystemEntity.isDirectory(searchPath)) {
    final startingDir = new Directory(searchPath);
    await for (var entity in startingDir.list(
        recursive: argResults[RECURSIVE],
        followLinks: argResults[FOLLOW_LINKS])) {
      if (entity is File) {
        searchFile(entity, searchTerms);
      }
    }
  } else {
    searchFile(new File(searchPath), searchTerms);
  }
}

重要: 在使用 await for 之前请确保使用之后的代码看起来确实是 更加清晰易懂了。例如,对于 DOM时间监听器通常 不会使用 await for,原因在于 DOM 发送 无尽的事件流。 如果使用 await for 来在同一行注册两个 DOM 事件监听器, 则第二个事件在不会被处理。

关于使用 await 和相关 Dart 语言的其他特性, 请参考 异步支持。

Listening for stream data

要想在每个数据到达的时候就去处理,则可以选择使用 await for 或者 使用 listen() 函数来订阅事件:

// Find a button by ID and add an event handler.
querySelector('#submitInfo').onClick.listen((e) {
  // When the button is clicked, it runs this code.
  submitData();
});

上面的示例中, onClick 属性是 “submitInfo” 按钮提供的一个 Stream 对象。

如果你只关心里面其中一个事件,则可以使用这些属性: first, last, 或者 single。要想在处理事件之前先测试是否满足条件,则 使用 firstWhere(), lastWhere(), 或者 singleWhere() 函数。

如果你关心一部分事件,则可以使用 skip(), skipWhile(), take(), takeWhile(), 和 where() 这些函数。

Transforming stream data

经常你需要先转换 stream 里面的数据才能使用。 使用 transform() 函数可以生产另外一个数据类型 的 Stream 对象:

var stream = inputStream
    .transform(UTF8.decoder)
    .transform(new LineSplitter());

上面的代码使用两种转换器(transformer)。第一个使用 UTF8.decoder 来把整数类型的数据流转换为字符串类型的数据流。然后使用 LineSplitter 把字符串类型数据流转换为按行分割的数据流。 这些转换器都来至于 dart:convert 库。 参考 dart:convert ) 了解详情。

Handling errors and completion

使用异步 for 循环 (await for) 和使用 Stream API 的 异常处理情况是有 区别的。

如果是异步 for 循环,则可以 使用 try-catch 来处理异常。

在 stream 关闭后执行的代码位于异步 for 循环 之后。

readFileAwaitFor() async {
  var config = new File('config.txt');
  Stream<List<int>> inputStream = config.openRead();

  var lines = inputStream
      .transform(UTF8.decoder)
      .transform(new LineSplitter());
  try {
    await for (var line in lines) {
      print('Got ${line.length} characters from stream');
    }
    print('file is now closed');
  } catch (e) {
    print(e);
  }
}

如果你使用 Stream API,则需要 使用 onError 函数来处理异常。 stream 完成后执行的代码要通过 onDone 函数 来执行。

var config = new File('config.txt');
Stream<List<int>> inputStream = config.openRead();

inputStream
    .transform(UTF8.decoder)
    .transform(new LineSplitter())
    .listen((String line) {
      print('Got ${line.length} characters from stream');
    }, onDone: () {
      print('file is now closed');
    }, onError: (e) {
      print(e);
    });

More information

关于在命令行应用中使用 Future 和 Stream 的更多示例,请参考 dart:io 里面的内容。 下面也是一些可以参考的文章和教程:

Asynchronous Programming: Futures

  • Futures and Error Handling
  • The Event Loop and Dart
  • Asynchronous Programming: Streams
  • Creating Streams in Dart

dart:math - math and random

Math 库提供了常见的数学运算功能,例如 sine 和 cosine, 最大值、最小值等,还有各种常量 例如 pi 和 e 等。Math 库中 的大部分函数都是顶级方法。

导入 dart:math 就可以使用 Math 库了。 下面的示例代码使用前缀 math 来引用库中的顶级 方法和常量:

import 'dart:math' as math;

Trigonometry

Math 库中提供了常见的三角运算功能:

// Cosine
assert(math.cos(math.PI) == -1.0);

// Sine
var degrees = 30;
var radians = degrees * (math.PI / 180);
// radians is now 0.52359.
var sinOf30degrees = math.sin(radians);
// sin 30° = 0.5
assert((sinOf30degrees - 0.5).abs() < 0.01);

注意: 上面这些函数是基于弧度的不是基于角度的。

Maximum and minimum

Math 库提供了 max() 和 min() 函数用来计算最大值和最小值:

assert(math.max(1, 1000) == 1000);
assert(math.min(1, -1000) == -1000);

Math constants

Math 库中提供各种数学常量,例如 pi, e 等。

// See the Math library for additional constants.
print(math.E);     // 2.718281828459045
print(math.PI);    // 3.141592653589793
print(math.SQRT2); // 1.4142135623730951

Random numbers

使用 Random 类可以生成随机数。 在 Random 构造函数中还可以提供一个随机种子:

var random = new math.Random();
random.nextDouble(); // Between 0.0 and 1.0: [0, 1)
random.nextInt(10);  // Between 0 and 9.

也可以生成随机的布尔值:

var random = new math.Random();
random.nextBool();  // true or false

More information

详细的信息可以参考 Math API 文档 来了解。 还可以参考下面这些类的 API 文档 num, int, 和 double。

dart:html - browser-based apps

如果要和浏览器打交道则需要使用 dart:html 库, 访问 DOM 元素和使用 HTML5 API。 DOM 是 Document Object Model 的缩写,用来 描述 HTML 页面的结构。

dart:html 还可以用来操作样式表(CSS)、用 HTTP 请求 来获取数据,使用 WebSockets 来获取数据。 HTML5 (和 dart:html) 具有很多其他的 API 在这里并没有介绍。 只有 Web 应用可以使用 dart:html,命令行应用无法使用该库。

注意: 关于构建 Web 应用的更高层级的框架,请参考 Polymer Dart 和 Angular 2 for Dart。

在 web 应用中导入 dart:html 就可以使用 HTML 相关的功能了:

import 'dart:html';

Manipulating the DOM

要使用 DOM 你需要了解 windows, documents, elements, 和 nodes 等概念。

一个 Window 对象代表 浏览器实际的窗口。每个窗口都有一个文档(Document)对象, 文档对象是当前正在加载的界面。Window 对象还可以访问各种 API,例如 用于存储数据的 IndexedDB、用于动画的 requestAnimationFrame 等。 在多窗口浏览器中,每个窗口(tab 也)都有 自己的 Window 对象。

使用 Document 对象, 可以创建和操纵 document 中的 Elements 对象。 注意 Document 本身也是一个 element,也是可以 被修改的。

DOM 模型是很多 Nodes 组成的树状结构。这些 nodes 通常 是 elements,但是也可以是 attributes、 text、 comments、 和其他 DOM 类型。 除了跟节点没有父节点以外,其他 DOM 中的节点都有一个 父节点,还有可能带有很多子节点。

Finding elements

在操作一个 element 之前,你需要先找到这个 element。 使用查询语法可以查找所需要的 element。

使用顶级方法 querySelector() 和 querySelectorAll() 可以查找一个或者多个符合条件的 element。可以根据 ID、class、tag、name 或者 这些的组合来查询 element。 CSS 选择器 规范 定义了选择器的形式, 例如使用 # 前缀代表 ID,英文句号 (.) 代表 classes。

使用 querySelector() 方法可以获取第一个符合选择器要求的元素; 而 querySelectorAll() 返回所有符合 选择器要求的元素结合。

// Find an element by id (an-id).
Element elem1 = querySelector('#an-id');

// Find an element by class (a-class).
Element elem2 = querySelector('.a-class');

// Find all elements by tag (<div>).
List<Element> elems1 = querySelectorAll('div');

// Find all text inputs.
  List<Element> elems2 =
      querySelectorAll('input[type="text"]');

// Find all elements with the CSS class 'class'
// inside of a <p> that is inside an element with
// the ID 'id'.
List<Element> elems3 = querySelectorAll('#id p.class');

Manipulating elements

可以使用属性(properties)来修改 element 的状态。 Node 和子类型 Element 定义了所有 element 都具有的属性。例如, 所有 element 都有 classes, hidden, id, style, 和 title 属性,你可以使用这些属性来修改 element 的状态。 Element 的 子类还定义了其他属性,比如 AnchorElement 定义了 href 属性。

例如下面的示例在 HTML 中设置一个锚链接:

<a id="example" href="http://example.com">link text</a>

<a>标签使用 href 定义了一个 element 和一个包含文字 “linktext” 的 text node(使用 text 属性访问)。使用 AnchorElement 的 href 属性 可以修改点击该链接跳转的地址:

querySelector('#example').href = 'http://dartlang.org';

通常你需要在多个 element 上设置属性。例如,下面的示例在 所有 class 样式带有 “mac”, “win”, 或者 “linux” 的 element 上设置 hidden 属性。设置 hidden 属性为 true 和 设置 CSS 样式 display:none 是同样的效果。

<!-- In HTML: -->
<p>
  <span class="linux">Words for Linux</span>
  <span class="macos">Words for Mac</span>
  <span class="windows">Words for Windows</span>
</p>

// In Dart:
final osList = ['macos', 'windows', 'linux'];

// In real code you'd programmatically determine userOs.
var userOs = 'linux';

for (var os in osList) { // For each possible OS...
  bool shouldShow = (os == userOs); // Matches user OS?

  // Find all elements with class=os. For example, if
  // os == 'windows', call querySelectorAll('.windows')
  // to find all elements with the class "windows".
  // Note that '.$os' uses string interpolation.
  for (var elem in querySelectorAll('.$os')) {
    elem.hidden = !shouldShow; // Show or hide.
  }
}

当属性不能访问或者不方便访问的时候,可以使用 Element 的 attributes 属性。 这个属性是一个 Map<String, String>,里面的 key 为属性名字。所有 HTML 元素的 属性名字以及意义,请参考 MDN Attributes 网页。下面是一个设置 属性值的示例:

elem.attributes['someAttribute'] = 'someValue';

Creating elements

还可以创建新的 element 然后添加到 HTML 页面的 DOM 中。下面的示例创建了一个 段落 (

) 元素:

var elem = new ParagraphElement();
elem.text = 'Creating is easy!';

使用 HTML 文本也可以创建 element。所包含的子元素 也一起被创建:

var elem2 =
    new Element.html('<p>Creating <em>is</em> easy!</p>');

注意上面的 elem2 对象是一个 ParagraphElement 。

给新创建的 Element 指定一个父节点可以把这个 Element 添加到 DOM 中。 可以把 Element 添加到任何已经存在于 DOM 中的其他 Element 的 children 中。 例如,下面的示例,body 是一个 element,使用 children 属性来 访问该元素的所有子元素(返回的是一个 List),然后把新的 elem2 添加 到子元素集合中。

document.body.children.add(elem2);

Adding, replacing, and removing nodes

之前说过,element 也是 node 的一种。使用 Node 的 nodes 属性可以 获取到当前 node 的所有子元素,nodes 返回的是 List ( children 属性只包含 Element 类型的 nodes)。 获取到这个 Node list 后,就可以使用 List 的各种函数来 处理这些 Node 对象了。

使用 List 的add() 函数可以把一个 node 添加到所有子元素的 最后:

// Find the parent by ID, and add elem as its last child.
querySelector('#inputs').nodes.add(elem);

使用 Node 的 replaceWith() 函数可以替换一个 Node:

// Find a node by ID, and replace it in the DOM.
querySelector('#status').replaceWith(elem);

使用 Node 的 remove() 函数来删除 node:

// Find a node by ID, and remove it from the DOM.
querySelector('#expendable').remove();

Manipulating CSS styles

CSS(cascading style sheets 的缩写)定义了 DOM 元素的 UI 样式。 在一个 element 上附加 ID 和 class 属性可以修改 其应用的 CSS 样式。

没有 element 都有一个 classes 属性(field),该属性的类型为 List。 添加和移除上面的 CSS 类就是向这个集合中添加和删除字符串。 流入,下面的示例中给 element 添加了 warning CSS 类样式。

var element = querySelector('#message');
element.classes.add('warning');

通过 ID 来查找元素非常高效。通过 id 属性你可以动态给一个 Element 指定 一个 ID 值。

var message = new DivElement();
message.id = 'message2';
message.text = 'Please subscribe to the Dart mailing list.';

使用级联调用可以减少 需要编写的代码:

var message = new DivElement()
    ..id = 'message2'
    ..text = 'Please subscribe to the Dart mailing list.';

使用 ID 和 CSS 的 classes 来应用样式是最佳的方式,但是有时候 你还是希望直接在 element 上应用具体的样式,则 可以直接使用 style 属性:

message.style
    ..fontWeight = 'bold'
    ..fontSize = '3em';

Handling events

要响应像点击、聚焦等外部事件,你需要使用事件监听器。 在页面上的任何 element 上都可以注册事件监听器。 事件分发和传递是一个很复杂的议题: 如果你是 Web 开发新手, 请到 这里来 详细研究这个事件分发机制。

使用 element.onEvent.listen(function)来添加事件监听器, 这里的 Event 是事件的名字,而 function 是事件处理器。

例如,下面是处理按钮点击的事件:

// Find a button by ID and add an event handler.
querySelector('#submitInfo').onClick.listen((e) {
  // When the button is clicked, it runs this code.
  submitData();
});

事件可以通过 DOM 树来向上或者向下传递。 通过 e.target 可以获取是那个 element 触发该事件的:

document.body.onClick.listen((e) {
  var clickedElem = e.target;
  print('You clicked the ${clickedElem.id} element.');
});

要查看所有可以注册的事件名字,可以查看 Element 文档中的 “onEventType” 属性。 下面是一些常见的事件:

  • change
  • blur
  • keyDown
  • keyUp
  • mouseDown
  • mouseUp

Using HTTP resources with HttpRequest

HttpRequest 类是之前 大家耳熟能详的 XMLHttpRequest 的功能一样,使用该类 可以在 web 应用总访问 HTTP 资源。 一般而言, AJAX 风格的应用会很依赖 HttpRequest。使用 HttpRequest 来 动态的加载 JSON 数据或者其他资源。 还可以动态的向服务器发送数据。

下面的示例假设所有的资源都是来至于和当前脚本文件位于 同一个 web 服务器。由于浏览器的安全限制, HttpRequest 要使用 其他服务器的资源是比较麻烦的。如果你需要访问 其他服务器上的资源, 你需要使用 JSONP 技术或者 启用另外一个资源服务器的 CORS header。

Getting data from the server HttpRequest 的静态函数 getString() 可以很方便的从服务器获取资源。 使用 await 来确保 getString() 调用资源返回后再 在继续执行后面的代码:

import 'dart:html';
import 'dart:async';

// A JSON-formatted file next to this page.
var uri = 'data.json';

main() async {
  // Read a JSON file.
  var data = await HttpRequest.getString(uri);
  processString(data);
}

processString(String jsonText) {
  parseText(jsonText);
}

dart:convert 中会介绍 JSON API 相关的内容。

使用 try-catch 来指定异常处理代码:

try {
  data = await HttpRequest.getString(jsonUri);
  processString(data);
} catch (e) {
  handleError(e);
}
// ...
handleError(error) {
  print('Uh oh, there was an error.');
  print(error.toString());
}

如果除了返回的文本数据以外你还需要 访问 HttpRequest,你可以使用 request() 静态函数。下面 是一个读取 XML 数据的示例:

import 'dart:html';
import 'dart:async';

// An XML-formatted file next to this page.
var xmlUri = 'data.xml';

main() async {
  // Read an XML file.
  try {
    var data = await HttpRequest.request(xmlUri);
    processRequest(data);
  } catch (e) {
    handleError(e);
  }
}

processRequest(HttpRequest request) {
  var xmlDoc = request.responseXml;
  try {
    var license = xmlDoc.querySelector('license').text;
    print('License: $license');
  } catch (e) {
    print("$xmlUri doesn't have correct XML formatting.");
  }
}

可以使用 full API 来处理各种情况。例如, 设置请求 header 信息。

下面是使用 HttpRequest full API 的常用流程:

    1. 创建 HttpRequest 对象。
    1. 使用 GET 或者 POST 打开一个 URL。
    1. 添加事件处理器。
    1. 发送请求。

例如:

import 'dart:html';
// ...
var request = new HttpRequest()
    ..open('POST', dataUrl)
    ..onLoadEnd.listen((_) => requestComplete(request))
    ..send(encodedData);

Sending data to the server

HttpRequest 还可以使用 HTTP POST 函数来向服务器发送数据。 例如,你可能希望动态的提交数据到服务器。 向 RESTful web 服务器发送 JSON 数据是一种非常常见的情况。

在表单处理中提交数据需要提供一个 name-value 数据对,该数据还需要 使用 URI 编码(关于 URI 类的信息请 参考 URIs 文档)。 如果要在表单处理器中提交数据则还 需要设置 Content-type header 为 application/x-www-form-urlencode。

import 'dart:html';

String encodeMap(Map data) {
  return data.keys.map((k) {
    return '${Uri.encodeComponent(k)}=' +
           '${Uri.encodeComponent(data[k])}';
  }).join('&');
}

loadEnd(HttpRequest request) {
  if (request.status != 200) {
    print('Uh oh, error: ${request.status}');
  } else {
    print('Data has been posted');
  }
}

main() async {
  var dataUrl = '/registrations/create';
  var data = {'dart': 'fun', 'editor': 'productive'};
  var encodedData = encodeMap(data);

  var httpRequest = new HttpRequest();
  httpRequest.open('POST', dataUrl);
  httpRequest.setRequestHeader(
      'Content-type',
      'application/x-www-form-urlencoded');
  httpRequest.send(encodedData);
  await httpRequest.onLoadEnd.first;
  loadEnd(httpRequest);
}

Sending and receiving real-time data with WebSockets

WebSocket 可以让你的 web 应用和服务器持续的交互数据,不用 一直的轮询。创建 WebSocket 的服务器会监听 ws:// 开头的 URL, 例如 ws://127.0.0.1:1337/ws。 通过 WebSocket 发送的数据可以是字符串或者 blob。 通常都是使用 JSON 格式的字符串。

要在 web 应用中使用 WebSocket,需要先创建 WebSocket 对象,把 WebSocket URL 作为该对象的参数。

var ws = new WebSocket('ws://echo.websocket.org');

Sending data

使用 send() 函数向 WebSocket 发送数据:

ws.send('Hello from Dart!');

Receiving data

要从 WebSocket 接收数据,需要注册一个事件 监听器:

ws.onMessage.listen((MessageEvent e) {
  print('Received message: ${e.data}');
});

消息事件处理函数的参数为 MessageEvent 对象。 该对象的 data 变量保存了服务器返回的数据。

Handling WebSocket events

你的应用可以处理如下的 WebSocket 事件:open, close, error, 和 (前面演示的) message。下面是演示各种事件 的 示例:

void initWebSocket([int retrySeconds = 2]) {
  var reconnectScheduled = false;

  print("Connecting to websocket");
  ws = new WebSocket('ws://echo.websocket.org');

  void scheduleReconnect() {
    if (!reconnectScheduled) {
      new Timer(
          new Duration(milliseconds: 1000 * retrySeconds),
          () => initWebSocket(retrySeconds * 2));
    }
    reconnectScheduled = true;
  }

  ws.onOpen.listen((e) {
    print('Connected');
    ws.send('Hello from Dart!');
  });

  ws.onClose.listen((e) {
    print('Websocket closed, retrying in ' +
          '$retrySeconds seconds');
    scheduleReconnect();
  });

  ws.onError.listen((e) {
    print("Error connecting to ws");
    scheduleReconnect();
  });

  ws.onMessage.listen((MessageEvent e) {
    print('Received message: ${e.data}');
  });
}

More information

上面只是简单的介绍了 dart:html 库。更多信息 请参考 dart:html。 Dart 还有一些 web 特殊领域的 api,例如 web audio, IndexedDB, 和 WebGL。

dart:io - I/O for command-line apps

dart:io 库 提供了一些和 文件、目录、进程、sockets、 WebSockets、和 HTTP 客户端以及服务器的 API。 只有命令行应用可以使用 dart:io 库,web app 无法使用。

一般而言,dart:io 库实现和提供的是异步 API。 同步函数很容易阻塞应用,后期扩展起来非常麻烦。 因此,大部分的操作返回值都是 Future 或者 Stream 对象, 如果你熟悉 Node.js 则对这种 模式会有所了解。

dart:io 里面也有一小部分同步方法,这些方法都使用 sync 前缀命名方法名字。 这里就不再介绍这些同步方法了。

注意: 只有命令行应用才能导入 dart:io。

Files and directories

I/O 库可以让命令行应用读写文件和查看目录。 读取文件有两种方式:一次读完或者通过流的方式来读取。 一次读完需要把文件内容读到内存中,如果文件 非常大或者你希望一边读文件一边处理,则应该 使用 Stream, 在 流式读取文件中介绍。

Reading a file as text

对于编码为 UTF-8 的文本,可以使用函数 readAsString() 一次性 的读取整个文本。如果单行文字比较重要,则可以 使用 readAsLines() 来读取。 这两个函数返回一个 Future 对象,当文件 读取完的时候,可以从 Future 对象获取一个或者多个字符串。

import 'dart:io';

main() async {
  var config = new File('config.txt');
  var contents;

  // Put the whole file in a single string.
  contents = await config.readAsString();
  print('The entire file is ${contents.length} characters long.');

  // Put each line of the file into its own string.
  contents = await config.readAsLines();
  print('The entire file is ${contents.length} lines long.');
}

Reading a file as binary

下面的示例把文件数据读取为字节流。 同样 readAsBytes() 函数返回值为 Future, 当读完文件后,可以从 Future 中获取数据。

import 'dart:io';

main() async {
  var config = new File('config.txt');

  var contents = await config.readAsBytes();
  print('The entire file is ${contents.length} bytes long');
}

Handling errors

在 Future 上注册一个 catchError 来处理异常, 还可以在 async 方法中使用 try-catch 来 处理异常:

import 'dart:io';

main() async {
  var config = new File('config.txt');
  try {
    var contents = await config.readAsString();
    print(contents);
  } catch (e) {
    print(e);
  }
}

Streaming file contents

使用 Stream 读取文件的时候, 使用 Stream API 或者 await for 可以一点点的读取, 详情参考 异步支持。

import 'dart:io';
import 'dart:convert';
import 'dart:async';

main() async {
  var config = new File('config.txt');
  Stream<List<int>> inputStream = config.openRead();

  var lines = inputStream
      .transform(UTF8.decoder)
      .transform(new LineSplitter());
  try {
    await for (var line in lines) {
      print('Got ${line.length} characters from stream');
    }
    print('file is now closed');
  } catch (e) {
    print(e);
  }
}

Writing file contents

使用 IOSink 可以往文件 写入内容。使用 File 的 openWrite() 函数获取到一个 IOSink。 默认的写模式为 FileMode.WRITE,新写入的数据会完全覆盖 文件之前的内容。

var logFile = new File('log.txt');
var sink = logFile.openWrite();
sink.write('FILE ACCESSED ${new DateTime.now()}\n');
sink.close();

如果想在文件末尾追加内容,则可以使用 mode 可选参数,参数取值 为 FileMode.APPEND:

var sink = logFile.openWrite(mode: FileMode.APPEND);
使用 add(List<int> data) 函数可以写二进制数据到文件。

Listing files in a directory

查找目录中的所有文件和子目录是一个异步操作。 list() 函数返回一个 Stream,当遇到文件或者子目录的时候, Stream 就发射一个对象。

import 'dart:io';

main() async {
  var dir = new Directory('/tmp');

  try {
    var dirList = dir.list();
    await for (FileSystemEntity f in dirList) {
      if (f is File) {
        print('Found file ${f.path}');
      } else if (f is Directory) {
        print('Found dir ${f.path}');
      }
    }
  } catch (e) {
    print(e.toString());
  }
}

Other common functionality

File 和 Directory 类包含其他的一些文件操作, 下面只是一些常见的函数:

  • 创建文件或者目录: create() in File and Directory
  • 删除文件或者目录: delete() in File and Directory
  • 获取文件的长度: length() in File
  • 随机位置访问文件: open() in File

参考 File 和 Directory 的 API 文档来 查看所有的函数。

HTTP clients and servers

dart:io 库提供了一些命令行应用可以用来访问 HTTP 资源 和运行 HTTP 服务器的类。

HTTP server

HttpServer 类 提供了用来建构 Web 服务器的底层方法。可以匹配 请求处理、设置 header、处理数据等。

下面的示例项目只能返回简单的文本信息。 服务器监听本机地址 127.0.0.1 的 8888 端口, 响应来自于 /languages/dart 路径的请求。所有其他的 请求都有默认的请求处理器处理(返回 404 页面没发现的错误提示)。

import 'dart:io';

main() async {
  dartHandler(HttpRequest request) {
    request.response.headers.contentType =
        new ContentType('text', 'plain');
    request.response.write('Dart is optionally typed');
    request.response.close();
  }

  var requests = await HttpServer.bind('127.0.0.1', 8888);
  await for (var request in requests) {
    print('Got request for ${request.uri.path}');
    if (request.uri.path == '/languages/dart') {
      dartHandler(request);
    } else {
      request.response.write('Not found');
      request.response.close();
    }
  }
}

HTTP client

HttpClient 类可以 在命令行应用程序或者服务器应用程序中使用,用来请求 HTTP 资源。 可以设置请求头、HTTP 请求方式和读写 数据。HttpClient 无法在 web 应用中使用。 在 web 应用中可以使用 HttpRequest class。 下面是使用 HttpClient 的一个示例:

import 'dart:io';
import 'dart:convert';

main() async {
  var url = Uri.parse(
      'http://127.0.0.1:8888/languages/dart');
  var httpClient = new HttpClient();
  var request = await httpClient.getUrl(url);
  print('have request');
  var response = await request.close();
  print('have response');
  var data = await response.transform(UTF8.decoder).toList();
  var body = data.join('');
  print(body);
  httpClient.close();
}

More information

除了上面提到的几个功能外,dart:io 库还包含 processes, sockets, 和 web sockets 等相关的 API。

dart:convert - decoding and encoding JSON, UTF-8, and more

dart:convert 库 里面有一些用来转换 JSON 和 UTF-8 的转换器,还可以自定义 新的转换器。 JSON 是非常流行的数据格式。 UTF-8 是一种非常流行的编码格式, 能够代表所有 Unicode 字符 集。

命令行应用和 web 应用都可以使用 dart:convert 库。 导入 dart:convert 就可以使用该库了。

Decoding and encoding JSON

使用 JSON.decode() 函数把 JSON 字符串解码为 Dart 对象:

import 'dart:convert' show JSON;

main() {
  // NOTE: Be sure to use double quotes ("),
  // not single quotes ('), inside the JSON string.
  // This string is JSON, not Dart.
  var jsonString = '''
  [
    {"score": 40},
    {"score": 80}
  ]
  ''';

  var scores = JSON.decode(jsonString);
  assert(scores is List);

  var firstScore = scores[0];
  assert(firstScore is Map);
  assert(firstScore['score'] == 40);
}

使用 JSON.encode() 可以把 Dart 对象 编码为 JSON 字符串:

import 'dart:convert' show JSON;

main() {
  var scores = [
    {'score': 40},
    {'score': 80},
    {'score': 100, 'overtime': true, 'special_guest': null}
  ];

  var jsonText = JSON.encode(scores);
  assert(jsonText == '[{"score":40},{"score":80},'
                     '{"score":100,"overtime":true,'
                     '"special_guest":null}]');
}

默认只支持 int、double、String、bool、null、List或者 Map(key 需要为 string) 这些类型转换为 JSON。 集合对象会使用递归的形式来转换每个对象。

对于默认不支持的对象,可以有两种选择: 一,调用 encode() 并指定第二个参数, 该参数是一个函数用来返回一个默认支持的对象; 二,不指定第二个参数,则会 调用该对象的 toJson() 函数。

Decoding and encoding UTF-8 characters

使用 UTF8.decode() 来解码 UTF8-encoded 字节流为 Dart 字符串:

import 'dart:convert' show UTF8;

main() {
  var string = UTF8.decode([
    0xc3, 0x8e, 0xc3, 0xb1, 0xc5, 0xa3, 0xc3, 0xa9,
    0x72, 0xc3, 0xb1, 0xc3, 0xa5, 0xc5, 0xa3, 0xc3,
    0xae, 0xc3, 0xb6, 0xc3, 0xb1, 0xc3, 0xa5, 0xc4,
    0xbc, 0xc3, 0xae, 0xc5, 0xbe, 0xc3, 0xa5, 0xc5,
    0xa3, 0xc3, 0xae, 0xe1, 0xbb, 0x9d, 0xc3, 0xb1
  ]);
  print(string); // 'Îñţérñåţîöñåļîžåţîờñ'
}

如果是 stream 字节流则可以在 Stream 的 transform() 函数上指定 UTF8.decoder :

var lines = inputStream
    .transform(UTF8.decoder)
    .transform(new LineSplitter());
try {
  await for (var line in lines) {
    print('Got ${line.length} characters from stream');
  }

使用 UTF8.encode() 把字符串编码为 UTF8 字节 流:

import 'dart:convert' show UTF8;

main() {
  List<int> expected = [
    0xc3, 0x8e, 0xc3, 0xb1, 0xc5, 0xa3, 0xc3, 0xa9,
    0x72, 0xc3, 0xb1, 0xc3, 0xa5, 0xc5, 0xa3, 0xc3,
    0xae, 0xc3, 0xb6, 0xc3, 0xb1, 0xc3, 0xa5, 0xc4,
    0xbc, 0xc3, 0xae, 0xc5, 0xbe, 0xc3, 0xa5, 0xc5,
    0xa3, 0xc3, 0xae, 0xe1, 0xbb, 0x9d, 0xc3, 0xb1
  ];

  List<int> encoded = UTF8.encode('Îñţérñåţîöñåļîžåţîờñ');

  assert(() {
    if (encoded.length != expected.length) return false;
    for (int i = 0; i < encoded.length; i++) {
      if (encoded[i] != expected[i]) return false;
    }
    return true;
  });
}

Other functionality

dart:convert 来包含转换 ASCII 和 ISO-8859-1(Latin1) 的转换器。详情请参考 dart:convert 库的 API 文档。

dart:mirrors - reflection

dart:mirrors 库提供了基本的反射支持。 使用 mirror 来查询程序的结构,也可以 在运行时动态的调用方法或者函数。 dart:mirrors 库在命令行和 web 应用中均可使用。 导入 dart:mirrors 即可开始使用。

警告: 使用 dart:mirrors 可能会导致 dart2js 生成的 JavaScript 代码 文件非常大!

目前的解决方式是在导入 dart:mirrors 之前添加一个 @MirrorsUsed 注解。 详情请参考 MirrorsUsed API 文档。由于 dart:mirrors 库依然还在 开发中,所以这个解决方案以后很有可能发生变化。

Symbols

mirror 系统使用 Symbol 类对象 来表达定义的 Dart 标识符名字。 Symbols 在混淆后的代码也可以 使用。

如果在写代码的时候,已经知道 symbol 的名字了,则可以使用 #符号名字 的方式直接使用。 直接使用的 symbol 对象是编译时常量,多次定义引用的是同一个对象。 如果名字不知道,则可以通过 Symbol 构造函数来 创建:

import 'dart:mirrors';

// If the symbol name is known at compile time.
const className = #MyClass;

// If the symbol name is dynamically determined.
var userInput = askUserForNameOfFunction();
var functionName = new Symbol(userInput);

在混淆代码的时候,编译器可能使用更加简短的名字来替代原来的符号(symbol)名字。 要获取原来的 symbol 名字,使用 MirrorSystem.getName() 函数。该函数 在代码混淆的情况下,也能返回正确的 symbol 名字。

import 'dart:mirrors';

const className = #MyClass;
assert('MyClass' == MirrorSystem.getName(className));

Introspection

使用 mirror 功能来检查程序的结构。可以检查 类、库以及对象等。

下面的示例使用 Person 类:

class Person {
  String firstName;
  String lastName;
  int age;

  Person(this.firstName, this.lastName, this.age);

  String get fullName => '$firstName $lastName';

  void greet(String other) {
    print('Hello there, $other!');
  }
}

在开始使用之前,需要在一个类或者对象上调用 reflect 函数来获取 到 mirror。

Class mirrors

在任何 Type 上面调用 reflect 函数来获取 ClassMirror :

ClassMirror mirror = reflectClass(Person);

assert('Person' ==
    MirrorSystem.getName(mirror.simpleName));

也可以在实例上调用 runtimeType 获取该对象的 Type。

var person = new Person('Bob', 'Smith', 33);
ClassMirror mirror = reflectClass(person.runtimeType);
assert('Person' ==
    MirrorSystem.getName(mirror.simpleName));

获取到 ClassMirror 后,就可以查询类的构造函数、成员变量、等信息。 下面是列出类的所有构造函数的示例:

showConstructors(ClassMirror mirror) {
  var constructors = mirror.declarations.values
      .where((m) => m is MethodMirror && m.isConstructor);

  constructors.forEach((m) {
    print('The constructor ${m.simpleName} has '
          '${m.parameters.length} parameters.');
  });
}

下面是列出类的成员变量的示例:

showFields(ClassMirror mirror) {
  var fields = mirror.declarations.values
      .where((m) => m is VariableMirror);

  fields.forEach((VariableMirror m) {
    var finalStatus = m.isFinal ? 'final' : 'not final';
    var privateStatus = m.isPrivate ?
        'private' : 'not private';
    var typeAnnotation = m.type.simpleName;

    print('The field ${m.simpleName} is $privateStatus ' +
          'and $finalStatus and is annotated as ' +
          '$typeAnnotation.');
  });
}

详情请参考 ClassMirror 的 API 文档。

Instance mirrors

在对象上调用 reflect 函数可以获取到一个 InstanceMirror 对象。

var p = new Person('Bob', 'Smith', 42);
InstanceMirror mirror = reflect(p);

如果你已经有个 InstanceMirror 对象了,但是想知道该对象反射的目标对象,则需要 调用 reflectee。

var person = mirror.reflectee;
assert(identical(p, person));

Invocation

获取到 InstanceMirror 后,就可以调用里面的函数、getter和setter了。 详细信息请参考 API docs for InstanceMirror 的 API 文档。

Invoke methods

使用 InstanceMirror 的 invoke() 函数来调用对象的函数。 第一个参数为要调用的函数名字,第二个参数为该函数的 一个位置参数列表。第三个参数为可选参数,用来指定命名 参数。

var p = new Person('Bob', 'Smith', 42);
InstanceMirror mirror = reflect(p);

mirror.invoke(#greet, ['Shailen']);

Invoke getters and setters

使用 InstanceMirror 的 getField() 和 setField() 函数来 查询和设置对象的属性。

var p = new Person('Bob', 'Smith', 42);
InstanceMirror mirror = reflect(p);

// Get the value of a property.
var fullName = mirror.getField(#fullName).reflectee;
assert(fullName == 'Bob Smith');

// Set the value of a property.
mirror.setField(#firstName, 'Mary');
assert(p.firstName == 'Mary');

More information

文章 Reflection in Dart with Mirrors 更详细 的介绍了反射功能。另外也可以参考 dart:mirror, 特别是 MirrorsUsed, ClassMirror, 和 InstanceMirror 这些类的 API 文档。

Summary 这页介绍了 Dart 应用中最常用的 内置库,并没有介绍所有的内置库。 下面是一些其他参考资料: dart:collection, dart:isolate, 和 dart:typed_data. 使用 pub 工具可以使用其他第三方库。 例如 args, logging, polymer, 和 test 库都是第三方库,可以 使用 pub 工具来使用。


所属标签

无标签

官方入门指南

Flutter官方发布的入门指导,包括了如何在不同的平台(Windows, Mac, Linux)上搭建开发环境,以及一些入门级的指导,以便您从零开始进入Flutter的世界,同时,一些Flutter的框架API,也是您开发时必不可少的工具书。

从这里进入