1. REST介绍
REpresentational State Transfer (REST)是一种架构原则,其中将web服务视为资源,可以由其URL唯一标识。
RESTful Web服务的关键特点是明确使用HTTP方法来表示不同的操作的调用。
REST的基本设计原则对典型CRUD操作使用HTTP协议方法:
POST -创建资源
GET -检索资源
PUT–更新资源
DELETE -删除资源
REST服务的主要优势在于:
它们是跨平台(Java、.net、PHP等)高度可重用的,因为它们都依赖基本HTTP协议。
它们使用基本的XML,而不是复杂的SOAP XML,使用非常方便。
基于REST的web服务日益成为后端企业服务集成的首选方法。与基于SOAP的web服务相比,它的编程模型简单,而本机XML(而不是SOAP)的使用减少了序列化和反序列化过程的复杂性,并且不再需要其他作用相同的第三方库。
2. 编写目的
编写本文的目的是为了将系统功能进行模块化、服务化,将用户的操作以服务的方式提供。系统与系统之间遵循服务规范,将系统与系统之间的交互转为定制化服务交互,以实现系统与系统之间的集成
3. 编写原则
可寻址性(Addressability)
REST 中的所有东西都基于资源 的概念。资源与 OOP 中的对象或其他名词不同,它是一种抽象,必须可以通过 URI 寻址或访问。
接口一致性(Interface uniformity)
与SOAP或其他标准不同,REST要求用来操纵资源的方法或动词不是任意的。这意味着RESTful服务的开发人员只能使用HTTP支持的方法,比如GET、PUT、POST、DELETE等等。因此不需要使用WSDL等服务描述语言
无状态(Statelessness)
为了增强可伸缩性,服务器端不存储客户机的状态信息。这使服务器不与特定的客户机相绑定,负载平衡变得简单多了。这还让服务器更容易监视、更可靠
具象(Representational)
客户机总是与资源的某种具象交互,绝不会直接与资源本身交互。同一资源还可以有多个具象。理论上说,持有资源的具象的任何客户机应该有操纵底层资源的足够信息。
连通性(Connectedness)
任何基于REST的系统都应该预见到客户机需要访问相关的资源,应该在返回的资源具象中包含这些资源。例如,可以以超链接的形式包含特定RESTful服务的操作序列中的相关步骤,让客户机可以根据需要访问它们。
4. 服务使用说明
1) 当前系统已经提供的服务
2) GET方式调用服务
说明:
1.请求方式包括:GET (这里以area服务为实例,GET对应每一个服务Resource中的@RequestMapping(value = "treeData",method = RequestMethod.GET))
2.请求URL:rest服务请求地址,对应XXXServiceResource.java的mapping配置中的value
@RequestMapping(value = "treeData", method = RequestMethod.GET))
3.其中GET请求只包含了请求方式和请求的URL,返回的结果以json格式返回给客户端
3) POST、DELETE、UPDATE方式调用服务
说明:
1.请求方式选择POST、DELETE、UPDATE(这里以保存收藏功能为例(PUT请求),对应每一个服Resource中的@RequestMapping(value = "save",method = RequestMethod.PUT))
2.Json参数: 其中POST、DELETE、UPDATE可能传递参数通过json,也可能通过路径直接拼接参数,这边以传递json到服务端为实例,对应服务端代码:
public JSONObject save(@RequestBody JSONObject obj,BookmarkTag bookmarkTag) {
3.请求URL:rest服务请求地址,对应XXXServiceResource.java的mapping配置中的value
@RequestMapping(value = " save",method = RequestMethod.PUT))
4.返回的结果以json格式返回给客户
5. 服务列表(仅仅列举实例)
1)添加标签
2)删除标签
3)更新标签
4)获取标签列表