一、RESTful架构介绍
RESTful就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。REST这个词,是Roy ThomasFielding在他2000年的博士论文中提出的 .
REST 是Representational State Transfer的缩写,翻译是”表现层状态转化”。 可以总结为一句话:REST是所有Web应用都应该遵守的架构设计指导原则。面向资源是REST最明显的特征,对于同一个资源的一组不同的操作。
要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。
(1)资源(Resources)
REST的名称"表现层状态转化"中,省略了主语。"表现层"其实指的是"资源"(Resources)的"表现层"。所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。
资源是服务器上一个可命名的抽象概念,资源是以名词为核心来组织的,首先关注的是名词。REST要
求,必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。
(2)表现层(Representation)
"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形
式,叫做它的"表现层"(Representation)。
比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。URI只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。
(3)状态转化(State Transfer)
访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态化"(StateTransfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。
综合上面的解释,我们总结一下什么是RESTful架构:
- 每一个URI代表一种资源;
- 客户端和服务器之间,传递这种资源的某种表现层;
- 客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。
7个HTTP方法:GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS,其中最常用的是GET/POST/PUT/DELETE这四个
常见错误
(1)URI包含动词
POST /accounts/1/transfer/500/to/2
正确的写法是把动词transfer改成名词transaction
(2)URI包含版本
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分:
Accept: vnd.example‐com.foo+json; version=1.0
Accept: vnd.example‐com.foo+json; version=1.1
Accept: vnd.example‐com.foo+json; version=2.0
二、安全与幂等
安全
出现脏读、不可重复读、幻读就是不安全的,不出现脏读、不可重复读、幻读就是安全的;
幂等
在操作数据库成功的前提下,会不会对数据库造成不好的、额外的影响;比如,下单时向数据库插入数据,由于网络的原因,多提交了两次,结果两次都成功了,这种情况就是不幂等的;
GET-获取数据
- 安全且幂等
只是去获取数据,所以是安全的(获取数据前没有其他操作,不会出现脏读、不可重复读、幻读等);
即使查询语句执行了多次,也不会对数据库造成额外的影响,所以是幂等的;
POST-插入数据
- 不安全且不幂等
可能执行多条插入语句,对数据库造成了额外的影响,所以是不幂等的;
PUT-更新数据
- 不安全且幂等
即使更新语句执行了多次,但是对数据库来说,数据库里的值是不变的,所以幂等;
DELETE-删除数据
- 不安全且幂等
即使删除语句执行了多次,但是对数据库来说,数据库里的值是不变的,所以幂等;
三、RestFul风格的Controller设计
@RestController
@RequestMapping("/label")
public class LabelController {
@Autowired
private LabelService labelService;
/**
* 查询全部列表
* @return
*/
@RequestMapping(method = RequestMethod.GET)
public Result<List> findAll(){
return new Result<>(true,StatusCode.OK,"查询成功",
labelService.findAll() );
}
/**
* 根据ID查询标签
* @param id
* @return
*/
@RequestMapping(value="/{id}",method = RequestMethod.GET)
public Result<Label> findById(@PathVariable String id){
return new Result<>(true,StatusCode.OK,"查询成功",labelService.findById(id));
}
/**
* 增加
* @param label
* @return
*/
@RequestMapping(method = RequestMethod.POST)
public Result add( @RequestBody Label label){
labelService.add(label);
return new Result(true,StatusCode.OK,"增加成功");
}
/**
* 修改
* @param label
* @return
*/
@RequestMapping(value="/{id}" ,method = RequestMethod.PUT)
public Result update( @RequestBody Label label,@PathVariable String id){
label.setId(id);
labelService.update(label);
return new Result(true,StatusCode.OK,"修改成功");
}
/**
* 删除
* @param id
* @return
*/
@RequestMapping(value="/{id}" ,method = RequestMethod.DELETE)
public Result deleteById(@PathVariable String id){
labelService.deleteById(id);
return new Result(true,StatusCode.OK,"删除成功");
}
}
四、跨域
跨域是什么?浏览器从一个域名的网页去请求另一个域名的资源时,域名、端口、协议任一不同,都是跨域 。如果是采用前后端分离开发的,也是前后端分离部署的,必然会存在跨域问题。 怎么解决跨域?很简单,只需要在Controller类上添加注解@CrossOrigin 即可!这个注解其实是CORS的实现。
CORS
CORS(Cross-Origin Resource Sharing, 跨源资源共享)是W3C出的一个标准,其思想是使用自定义的HTTP头部让浏览器与服务器进行沟通,从而决定请求或响应是应该成功,还是应该失败。因此,要想实现CORS进行跨域,需要服务器进行一些设置,同时前端也需要做一些配置和分析。