dart编程讲解（-成绩查询系统之四）

dart编程讲解（-成绩查询系统之四）为了实现将Score对象及其Score对象列表转换为JSON字符串，我们使用了json.encode方法，但是，被转换的对象必须满足encodable 才可以。对于普通类型的数值，比如number、boolean、String和List类型，它们都满足encodable。对于自定义的类Score来说，它就不符合encodable的要求。因此，我们需要为Score类增加一个方法，名称为toJson 如下图3所示，它实现的功能是将Score对象转换为一个Map对象，在Map对象中指定键名和对应的键值，这样在调用json.encode方法时通过toJson方法就可以实现将Score对象转换为对应的JSON字符串了，第16行代码中设置了头域“Content-Type”的值为“application/json”格式。图2图1图1中第11行代码定义了一个Router对象，它表示一个路由器，我们将在这个

「初探Dart编程语言」-构建一个成绩查询系统之二
「初探Dart编程语言」-构建一个成绩查询系统之三
「初探Dart编程语言」-构建一个成绩查询系统之一

Dart语言除了能够编写控制台交互程序之外，它也可以进行服务器端应用的开发，本文我们将使用Dart语言开发一个RESTful API服务器，实现一个网络版成绩查询功能的Web应用。下表1为服务器端点资源描述。

表1

在这个Web开发框架丛生的年代，每一种语言都有不止一种的Web应用开发方式，Java语言有Spring MVC及其强大的生态系统，Node.js有Express轻量级框架以及其各种衍生产品，同样在Dart语言的生态系统中也有对应的Web端应用开发产品，本文我们使用shelf和shelf_router库进行开发一个Web API应用，用以实现成绩信息的“增删改查”操作，如下图1所示。

图1

图1中第11行代码定义了一个Router对象，它表示一个路由器，我们将在这个路由器上实现所有成绩信息操作，第13行代码定义了一个 GET方法，其路径为路由的根路径”/”，用于获取所有的成绩信息；第20行代码定义了一个GET方法，其路径为“/<scoreId>”，用于获取一条成绩信息；第31行代码定义了一个POST方法，其路径也是根路径，它表示创建一条成绩信息；第40行代码定义一个PUT方法，其路径为”/<scoreId>”，用于更新一条成绩信息；第56行代码定义一个DELETE方法，其路径也为”/<scoreId>”，它用于删除一条成绩信息。图1中通过在Router上定义了不同的路径所对应的操作，下文中将介绍每一个路由所对应的处理器是如何实现的。

获取成绩列表

获取成绩列表将返回所有的成绩信息。本文使用上一篇文章所实现的文件存储仓库scoreRepo，调用findAll方法获取到当前文件中所有的成绩信息，这些信息是存储在一个列表对象中，其中每一个元素都是一个Score对象。我们需要将这些对象转换为JSON格式的字符串返回给客户端。

图2

为了实现将Score对象及其Score对象列表转换为JSON字符串，我们使用了json.encode方法，但是，被转换的对象必须满足encodable 才可以。对于普通类型的数值，比如number、boolean、String和List类型，它们都满足encodable。对于自定义的类Score来说，它就不符合encodable的要求。因此，我们需要为Score类增加一个方法，名称为toJson 如下图3所示，它实现的功能是将Score对象转换为一个Map对象，在Map对象中指定键名和对应的键值，这样在调用json.encode方法时通过toJson方法就可以实现将Score对象转换为对应的JSON字符串了，第16行代码中设置了头域“Content-Type”的值为“application/json”格式。

图3

这个接口返回的数据如下图4所示。

图4

获取一个成绩

获取一个成绩信息是指通过指定一条成绩记录的Id值，获得对应的一条成绩记录。图5中第19行代码通过设置路由参数<scoreId>，shelf框架在解析路径之后会将它的值存放在Request对象req中，第20行代码通过访问req对象的params成员可以获取到scoreId路径参数。通过这样的方式获取到的参数为字符串类型，因此，第25行代码调用findOne方法时需要先使用int.parse方法将字符串值转换为整型值，之后再将其查询结果作为JSON字符串返回给客户端，同时设置响应的Content-Type头域为JSON格式类型。

图5

新建一个成绩

新建一个成绩是指使用用户发送过来的数据构建出一个成绩对象，并将其保存至文件中。我们使用了HTTP协议的POST方法，客户端就可以将成绩对象的信息作为消息体内容发送给服务器。图6中第31行代码通过调用Request对象的readAsString方法从消息体中读取出客户端提供的成绩数据，当然，这些数据是以字符串的方式进行存储，然而，我们需要的是Score类型的对象，因此，第32行代码先对字符串执行了json.decode操作，将其转换为一个JSON对象，之后再调用了factory构造方法而生成一个Score对象。

图6

图7给出了将一个dynamic对象转换为Score对象的factory构造方法。调用这个构造方法就可以构建出对应的Score对象，之后通过第33行代码调用文件存储仓库scoreRepo的save方法将其写入至文件中，最后通过第35-36行代码将保存后的Score对象以JSON文本串的方式返回给客户端。

图7

更新一个成绩

更新一个成绩是指在路径中提供一个成绩Id值，同时在消息体中提供新的成绩信息，使用新的成绩信息更新原来的成绩信息。如图8所示，第39行代码指定了一个路径参数scoreId，其所对应的请求为HTTP PUT请求，在PUT消息体中客户端提供了新的成绩信息，与新建一个成绩时获取客户端成绩内容相同，第41行代码使用Request对象的readAsString方法，将消息体的内容以字符串的方式读取出来，第42行代码通过将Request对象中成绩Id读取出来，之后各自进行相应的类型转换，第45行代码调用文件仓库的update方法将新的数据更新至文件中。为了获取更新后的数据，第46行代码再次使用请求的成绩id值进行一次查询操作，最后通过第48-49行代码将查询后得到的Score对象以JSON格式返回给客户端。

图8

删除一个成绩

删除一个成绩是指按照用户提供的成绩Id值，将对应的成绩信息从文件中删除。图9中第55行代码使用了HTTP协议的DELETE方法，这个路由中也含有一个参数scoreId，表示待删除的成绩对象Id值，这个Id值同样可以通过Request对象获取到，经过类型转换之后，第58行代码便可以调用文件存储仓库的remove方法将其从文件中删除，删除文件的响应数据只提供了一个count信息，因此，我们使用了一个Map对象来表示响应的内容，如第60-61行代码所示。

图9

应用服务器

上述几个小节内容实现了成绩资源的各个路由功能，完成了一个路由器的构建，如何在代码中使用这个路由呢？如下图10所示，第6行代码构建了一个服务对象，第7行代码使用这个服务对象的handler成员作为第一个参数，即我们所定义的路由器，第二个参数表示监听的主机地址，第三个参数表示监听的端口号，最后一个参数表示地址端口是否共享。完成这些参数设置之后调用shelf_io的serve方法就可以启动HTTP应用服务器，之后客户端就可以访问各个成绩资源了。

图10

总结

Dart语言不仅仅可以开发控制台应用程序，它同样也有强大的网络处理能力，其生态中已经包含多个优秀的网络开发框架，这些框架所提供的能力可以满足日常的需求，我们本项目所选择的shelf框架是一个很轻量级的库，即使这样它所提供的能力也已经能够满足基本的Web API的需求，通过本文演示shelf框架对HTTP动词、路由、路径参数、消息体和响应的处理能力。由此可见Dart语言的通用性，它可不是一个只能够开发控制台或界面的语言，它同样也是可以进行服务器应用开发的。

「初探Dart编程语言」-构建一个成绩查询系统之三
「初探Dart编程语言」-构建一个成绩查询系统之二
「初探Dart编程语言」-构建一个成绩查询系统之一