统一建模语言(Unified Modeling Language,UML)又称标准建模语言,是始于1997年的一个OMG(Object Management Group)标准,它是一个支持模型化和软件系统开发的图形化语言,为软件开发的所有阶段提供模型化和可视化支持,包括由需求分析到规格,到构造和配置.

UML从考虑系统的不同角度出发,定义了用例图、类图、对象图、包图、状态图、活动图、序列图、协作图、构件图、部署图等10种图.常见的UML图有用例图(Use Case Diagram)、类图(Class Diagram)和序列图(Sequence Diagram).下面也将主要阐述这三种UML图.

• 用例图: 展现了一组用例、参与者（actor）以及它们之间的关系

REST(Representational State Transfer),我对这个词组的翻译是表现层状态转化.要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。如果你把这个名称搞懂了,也就不难体会REST是一种什么样的设计。

• 资源(Resources)

REST的名称"表现层状态转化"中,省略了主语。"表现层"其实指的是"资源"（Resources）的"表现层"。所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。

• 表现层(Representation)

"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"（Representation）。比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式；图片可以用JPG格式表现,也可以用PNG格式表现。URI只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。

• 状态转化(State Transfer)

访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源,POST用来新建资源（也可以用于更新资源）,PUT用来更新资源,DELETE用来删除资源

• 总结

综合上面的解释,我们总结一下什么是RESTful架构：

每一个URI代表一种资源

客户端和服务器之间,传递这种资源的某种表现层

客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"

• RESTful架构有一些典型的设计误区

  • 最常见的一种设计错误,就是URI包含动词/posts/show/1中的show是动词这个URI设计就是错的,正确的应该是/posts/1然后用GET方法表示show的动作
  • 如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源.比如网上汇款,从账户1向账户2汇款500元,错误的URI是POST /accounts/1/transfer/500/to/2.正确的写法是把动词transfer改成名词transaction,资源不能是动词POST /transaction HTTP/1.1 from=1&to=2&amount=500.00

• 常用的HTTP动词有下面五个(括号里是对应的SQL命令)

  • GET(SELECT)：从服务器取出资源（一项或多项）。
  • POST(CREATE)：在服务器新建一个资源。
  • PUT(UPDATE)：在服务器更新资源（客户端提供改变后的完整资源）。
  • PATCH(UPDATE)：在服务器更新资源（客户端提供改变的属性）。
  • DELETE(DELETE)：从服务器删除资源。

• 过滤信息(Filtering)

  如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

  • ?limit=10：指定返回记录的数量
  • ?offset=10：指定返回记录的开始位置。
  • ?page=2&per_page=100：指定第几页,以及每页的记录数。
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序,以及排序顺序。
  • ?animal_type_id=1：指定筛选条件

• 状态码(Status Codes)

  服务器向用户返回的状态码和提示信息,常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

  • 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
  • 202 Accepted - [*]:表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
  • 401 Unauthorized - [*]:表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*]:表示用户得到授权（与401错误相对）,但是访问是被禁止的。
  • 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
  • 406 Not Acceptable - [GET]:用户请求的格式不可得（比如用户请求JSON格式,但是只有XML格式）。
  • 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH]:当创建一个对象时,发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

• 返回结果

  针对不同操作,服务器向用户返回的结果应该符合以下规范。

  • GET /zoos: List all Zoos (ID and Name, not too much detail)
  • POST /zoos: Create a new Zoo
  • GET /zoos/ZID: Retrieve an entire Zoo object
  • PUT /zoos/ZID: Update a Zoo (entire object)
  • PATCH /zoos/ZID: Update a Zoo (partial object)
  • DELETE /zoos/ZID: Delete a Zoo
  • GET /zoos/ZID/animals: Retrieve a listing of Animals (ID and Name).
  • GET /animals: List all Animals (ID and Name).
  • POST /animals: Create a new Animal
  • GET /animals/AID: Retrieve an Animal object
  • PUT /animals/AID: Update an Animal (entire object)
  • PATCH /animals/AID: Update an Animal (partial object)
  • GET /animal_types: Retrieve a listing (ID and Name) of all Animal Types
  • GET /animal_types/ATID: Retrieve an entire Animal Type object
  • GET /employees: Retrieve an entire list of Employees
  • GET /employees/EID: Retreive a specific Employee
  • GET /zoos/ZID/employees: Retrieve a listing of Employees (ID and Name) who work at this Zoo
  • POST /employees: Create a new Employee
  • POST /zoos/ZID/employees: Hire an Employee at a specific Zoo
  • DELETE /zoos/ZID/employees/EID: Fire an Employee from a specific Zoo

项目中前端和后端通常是并行开发,并且大部分APP其实主要是作为呈现的一端,而业务逻辑大都放到服务器端来处理。在这种背景下,开发的流程中,APP开发必然对服务器端的开发状态严重依赖.为了减少等待后端接口开发的时间,我们经常需要在本地模拟后端接口用来测试前端效果。这种做法称之为构建前端Mock。平日里我接触的前端Mock方法大致可以分为以下两种:

• 本地启动一个静态服务,将所需要的接口写成json文件,根据接口名字将文件放在项目目录下
• 再启动一个Server作为Mock Server,使用第三方Proxy将Mock Server的接口代理到静态服务器上