用Dart 搭建图书 REST Framework

微服务的时代，如何快速方便地交换数据变得至关重要。

Jermaine Oppong 在他的文章 Building RESTful Web APIs with Dart, Aqueduct and PostgreSQL 给了一个很完整的案例，在这里和大家一起分享。

1.设置和运行示例

pub global activate aqueduct
aqueduct create fave_reads && cd fave_reads

在项目fave_reads的文件结构中，我们重点需要关注：

bin/
  main.dart
lib/
  fave_reads_sink.dart
pubspec.yaml

bin/main.dart 创建我们的服务器并启动应用程序
lib/fave_reads_sink.dart 用来设置配置
pubspec.yaml 包文件。类似于Node.js开发的package.json

使用下面的命令启动应用程序：

aqueduct serve # 或 `dart bin/main.dart`

我们现在有一个运行在http://localhost:8081的服务器，其中/example是唯一创建的路由。访问http://localhost:8081/example将返回如下响应：

{ "key": "value" }

值得一提的是，Aqueduct 使用 RequestSink的概念，处理应用程序的初始化，包括设置路由，授权和数据库连接。
应用程序需要一个RequestSink子类来处理接收请求。本例中有一个FaveReadsSink扩展了RequestSink的基类，使我们可以重载它的方法。如：setupRouter和willOpen 。 setupRouter允许我们用关联的controllers 和其他middleware来定义我们的路由，而willOpen允许我们在路由设置之后和应用程序可以接收请求之前执行任何异步初始化。
下面我们通过在setupRouter方法中创建第二条路由：

router.route('/').listen((request) async {
  return new Response.ok('Hello world')
    ..contentType = ContentType.TEXT;
});

使用方法级联，我们可以将contentType属性设置为text/plain。 ContentType实用程序内置Dart，可以通过以下样式使用(支持HTML, JSON and TEXT）：

new ContentType(primaryType, subType, {String charset, Map parameters});

重新启动服务器。访问根路径应该得到：

helloworld.png

Dart 应用程序实例可以扩展cpu的内核数。例如：在bin/main.dart中，当调用app.start时，它当前的内核数设置为2：

await app.start(numberOfInstances: 2);

为了启用这个功能，我们需要将从“dart:io”库导入Dart的Platform类，并修改main.dart，如下所示：

import 'dart:io' show Platform;
Future main() async {
  ...
  ...
  await app.start(numberOfInstances: Platform.numberOfProcessors);
  ...
}

2. 使用CRUD操作实现路由

2.1 路由Router

在Router 对象上调用route方法时注册路由来定义请求路径。当我们的FaveReadsSink子类中的setupRouter方法被调用时，就会发生注册。
setupRouter方法提供了一个Router对象作为参数，然后我们使用它来定义我们的每个路由：

// lib/fave_reads_sink.dart
@override
void setupRouter(Router router) {
  router.route(’/path-1’).listen(...);
  router.route(’/path-2’).listen(...);
  router.route(’/path-3’).listen(...); // and so on
}

调用route方法接收一个包含路径名的字符串，接着是一个监听方法，用来处理业务逻辑。路由可以包含路径变量，它是占位符标记，表示路径中的任何参数：

router.route('/items/:itemID');

上面的例子声明了一个路径变量itemID，它匹配“/items/0”，“/items/1”，“/items/foo”等等。 itemID的值分别为“0”，“1”和“foo”。
路径变量也可以是可选的，所以我们可以像这样设置它们：

router.route('/items/[:itemID]);

基于此，我们修改lib/fave_reads_sink.dart文件中的setupRouter实现方法，如下所示：

@override
void setupRouter((Router router) async {
  router.route('/books[/:index]').listen((Request incomingRequest) async {
    return new Response.ok('Showing all books.');
  });
  router.route('/').listen((Request incomingRequest) async {
    return new Response.ok('Welcome to FaveReads')
      ..contentType = ContentType.HTML;
  });
});

根路径目前返回HTML内容。我们还定义了一个“/books”路由，它接受一个名为index的可选路径变量。这将是我们用来实现CRUD操作的地方。
调用路由方法会返回一个RouteController，它的listen方法，我们用来定义要运行的业务逻辑。还有其他两种方法，即pipe和generate。后者允许我们创建一个新的HTTPController对象，以更好地处理我们的请求。
listen方法接受一个包含表示传入请求的Request对象的闭包。然后，我们可以从中获取我们需要的信息，执行转换并返回响应。
我们进一步修改文件使我们的每个操作返回不同的响应：

router.route('/books[/:index]').listen((Request incomingRequest) async {
  String reqMethod = incomingRequest.innerRequest.method;
  String index = incomingRequest.path.variables["index"];
  
  if (reqMethod == 'GET') {
    if(index != null) {
      return new Response.ok('Showing book by index: $index');
    }
    return new Response.ok('Showing all books.');
  } else if (reqMethod == 'POST') {
    return new Response.ok('Added a book.');
  } else if (reqMethod == 'PUT') {
    return new Response.ok('Added a book.');
  } else if (reqMethod == 'DELETE') {
    return new Response.ok('Added a book.');
  }
  // If all else fails
  return new Response(405, null, 'Not sure what you\'re asking here');
});

2.2 HTTPController

HTTPControllers通过映射到对应的“处理程序方法”来响应HTTP请求。只要路径匹配，Router就会向HTTPController发送请求。
我们将创建一个扩展HTTPController的BooksController，新建文件controller/ books_controller.dart 并有以下内容：

import '../fave_reads.dart';

class BooksController extends HTTPController {
  // invoked for GET /books
  @httpGet // HTTPMethod meta data
  Future getAllBooks() async => new Response.ok('Showing all books');
  
  // invoked for GET /books/:index
  @httpGet // HTTPMethod meta data
  Future getBook(@HTTPPath("index") int idx) async => new Response.ok('Showing single book');
  
  // invoked for POST /books
  @httpPost // HTTPMethod meta data
  Future addBook() async => new Response.ok('Added a book');
  
  // invoked for PUT /books
  @httpPut // HTTPMethod meta data
  Future updateBook() async => new Response.ok('Updated a book');
  
  // invoked for DELETE /books
  @httpDelete  // HTTPMethod meta data
  Future deleteBook() async => new Response.ok('Deleted a book');
}

解释一下：

BooksController子类由5个处理程序方法组成，称为响应方法。
每个响应方法都使用反映适当请求方法的常量进行注释：@httpGet，@httpPost，@httpPut，@httpDelete。其他方法将使用HTTPMethod，如@HTTPMethod('PATCH')。
每个响应方法都会返回一个类型为Response的Future。 Dart中的Future就等同于JavaScript的Promises 。
响应方法可以将请求中的值绑定到它的参数。我们用getBook() 响应方法参数来看这个：@HTTPPath("index") int idx。其路径变量被转换为一个整数并被分配给一个名为idx的变量。

如果没有响应方法匹配请求方法（例如PATCH），则返回405方法不允许响应。修改lib/fave_reads_sink.dart文件并使用这个控制器：

import 'fave_reads.dart';
import 'controller/books_controller.dart';
...
...
@override
void setupRouter((Router router) async {
  router
    .route(‘/books/[:index]’)
    .generate(() => new BooksController()); // replaces `listen` method
...

在终端运行 aqueduct serve 或 dart bin/main.dart 重启服务器.

我们可以用 Postman. 来做测试：

book.png

2.3 测试数据源 Mocking our datasource

我们在controller/books_controller.dart中创建一个测试数据的数组：

import '../fave_reads.dart';

List books = [
  {
    'title': 'Head First Design Patterns',
    'author': 'Eric Freeman',
    'year': 2004
  },
  {
    'title': 'Clean Code: A handbook of Agile Software Craftsmanship',
    'author': 'Robert C. Martin',
    'year': 2008
  },
  {
    'title': 'Code Complete: A Practical Handbook of Software Construction',
    'author': 'Steve McConnell',
    'year': 2004
  },
];

class BooksController extends HTTPController {...}

然后更新BooksController中的响应方法来操作此数据集：

class BooksController extends HTTPController {
  @httpGet
  Future getAll() async => new Response.ok(books);

  @httpGet
  Future getSingle(@HTTPPath("index") int idx) async {
    if (idx < 0 || idx > books.length - 1) { // index out of range
      return new Response.notFound(body: 'Book does not exist');
    }
    return new Response.ok(books[idx]);
  }

  @httpPost
  Future addSingle() async {
    var book = request.body.asMap(); // `request` represents the current request. This is a property inside HTTPController base class
    books.add(book);
    return new Response.ok(book);
  }

  @httpPut
  Future replaceSingle(@HTTPPath("index") int idx) async {
    if (idx < 0 || idx > books.length - 1) { // index out of range
      return new Response.notFound(body: 'Book does not exist');
    }
    var body = request.body.asMap();
    for (var i = 0; i < books.length; i++) {
      if (i == idx) {
        books[i]["title"] = body["title"];
        books[i]["author"] = body["author"];
        books[i]["year"] = body["year"];
      }
    }
    return new Response.ok(body);
  }

  @httpDelete
  Future delete(@HTTPPath("index") int idx) async {
    if (idx < 0 || idx > books.length - 1) { // index out of range
      return new Response.notFound(body: 'Book does not exist');
    }
    books.removeAt(idx);
    return new Response.ok('Book successfully deleted.');
  }
}

2.4 重构解决方案

我们通过@HTTPBody() metadata 重构POST操作

@httpPost
Future addSingle(@HTTPBody() Map book) async {
  books.add(book);
  return new Response.ok('Added new book.');
}

这里，尝试将请求有效载荷解析为Map类型。只要自定义类型扩展了HTTPSerializable类型，我们也可以指定自定义类型，而不仅仅使用内置类型。让我们通过在 lib/model/book.dar中引入Book模型来实现这一点：

import '../fave_reads.dart';

class Book extends HTTPSerializable {
  String title;
  String author;
  int year;

  Book({this.title, this.author, this.year});

  @override
  Map asMap() => {
    "title": title,
    "author": author,
    "year": year,
  };

  @override
  void readFromMap(Map requestBody) {
    title = requestBody["title"];
    author = requestBody["author"];
    year = requestBody["year"];
  }
}

总结如下：

我们的Book模型实现了HTTPSerializable，它是一个用于从HTTP请求中解析信息的实用工具。
定义asMap和readFromMap(Map requestBody) 方法。 asMap将在JSON响应被发送回客户端时使用，而readFromMap将检索请求主体并提取数据以填充模型的属性。
现在我们只需要使用这个模型：

// lib/controller/book_controller.dart
import '../fave_reads.dart';
import 'model/book.dart';

List books = [
  new Book(
    title: 'Head First Design Patterns',
    author: 'Eric Freeman',
    year: 2004
  ),
  new Book(
    title: 'Clean Code: A handbook of Agile Software Craftsmanship', 
    author: 'Robert C. Martin', 
    year: 2008
  ),
  new Book(
    title: 'Code Complete: A Practical Handbook of Software Construction',
    author: 'Steve McConnell',
    year: 2004
  ),
];

class BooksController extends HTTPController {
  // ...
  // ...
  Future addSingle(@HTTPbody() Book book) async { // note the `Book` type being used
    books.add(book);
    return new Response.ok(book);
  }
  //...
  //...
}

以上部分的源代码，请参看： available on github

用Dart 搭建图书 REST Framework— 第一部分