REST(英文:Representational State Transfer,简称REST)是web服务的一种架构风格;使用HTTP,URI,XML,JSON,HTML等广泛流行的标准和协议;轻量级,跨平台,跨语言的架构设计;它是一种设计风格,不是一种标准,是一种思想。
设计概念和准则:
1、网络上的所有事物都被抽象为资源(resource);
2、每个资源对应一个唯一的资源标识(resource identifier);
3、通过通用的连接器接口(generic connector interface)对资源进行操作;
4、对资源的各种操作不会改变资源标识;
5、所有的操作都是无状态的(stateless)。
什么是RESTFUL
REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。REST式的web服务是一种ROA(The Resource-Oriented Architecture)(面向资源的架构).
传统的请求模式和REST模式的请求模式区别
为什么使用RESTFUL
遵循REST规范的Web应用将会获得下面好处:
URL具有很强可读性的,具有自描述性;
资源描述与视图的松耦合;
可提供OpenAPI,便于第三方系统集成,提高互操作性;
如果提供无状态的服务接口,可提高应用的水平扩展性;
下面再详细说明一下REST。了解事物,分三步走:
使用
RESTFUL支持
thinkphp3.2 的RESTFul支持更为灵活,你只需要把控制器继承Think\Controller\RestController即可。 继承RestController控制器后你的访问控制器就可以支持下面的一些功能:
支持资源类型自动检测;
支持请求类型自动检测;
RESTFul方法支持;
可以设置允许的请求类型列表;
可以设置允许请求和输出的资源类型;
可以设置默认请求类型和默认资源类型;
例如:
namespace Home\Controller;
use Think\Controller\RestController;
class DemoController extends RestController{
}
REST参数
继承了RestController后,你可以在你的控制器里面设置rest相关的属性参数,包括:allowMethod,defaultMethod,allowType,defaultType以及allowOutputType。
REST方法
RESTFul方法的操作方法定义主要区别在于,需要对请求类型和资源类型进行判断,大多数情况下,通过路由定义可以把操作方法绑定到某个请求类型和资源类型。如果你没有定义路由的话,需要自己在操作方法里面添加判断代码,示例:
<?php
/**
* Created by PhpStorm.
* User: Zhiqiang Guo
* Date: 2018/3/7
* Time: 17:16
*/
namespace Home\Controller;
use Think\Controller\RestController;
class DemoController extends RestController{
/**
* 请求类型和资源类型进行判断
*
* @author Zhiqiang Guo
* @return void
* @throws Exception
* @access public
*/
public function rest() {
switch ($this->_method){
case 'get': // get请求处理代码
if ($this->_type == 'html'){
}elseif($this->_type == 'xml'){
}
break;
case 'put': // put请求处理代码
break;
case 'post': // post请求处理代码
break;
}
}
}
在Rest操作方法中,可以使用$this->_type获取当前访问的资源类型,用$this->_method获取当前的请求类型。
REST控制器类还提供了response方法用于REST输出: 用法如下:
$this->response($data,'json');
Response方法会自动对data数据进行输出类型编码,目前支持的包括xml/json/html。
除了普通方式定义Restful操作方法外,系统还支持另外一种自动调用方式,就是根据当前请求类型和资源类型自动调用相关操作方法。系统的自动调用规则是:
要使用这种方式的前提就是不能为当前操作定义方法,这样在空操作的检查之前系统会首先按照上面的定义规范顺序检查是否存在方法定义,如果检测到相关的restful方法则不再检查后面的方法规范,例如我们定义了
<?php
/**
* Created by PhpStorm.
* User: Zhiqiang Guo
* Date: 2018/3/7
* Time: 17:16
*/
namespace Home\Controller;
use Think\Controller\RestController;
class DemoController extends RestController{
protected $allowMethod = array('get','post','put'); // REST允许的请求类型列表
protected $allowType = array('html','xml','json'); // REST允许请求的资源类型列表
/**
* 请求类型和资源类型进行判断
*
* @author Zhiqiang Guo
* @return void
* @throws Exception
* @access public
*/
public function rest() {
switch ($this->_method){
case 'get': // get请求处理代码
if ($this->_type == 'html'){
}elseif($this->_type == 'xml'){
}
break;
case 'put': // put请求处理代码
break;
case 'post': // post请求处理代码
break;
}
}
public function read_get_html(){
// 输出id为1的Demo的html页面
echo "输出id为1的Demo的XML数据read_get_html";
}
public function read_get_xml(){
// 输出id为1的Demo的XML数据
echo "输出id为1的Demo的XML数据read_get_xml";
}
public function read_xml(){
// 输出id为1的Demo的XML数据
echo "输出id为1的Demo的XML数据read_xml";
}
public function read_json(){
// 输出id为1的Demo的json数据
echo "输出id为1的Demo的XML数据read_json";
}
}
如果我们访问的URL是:
http://www.test/index.php/home/demo/read/id/1.xml
浏览器显示
“输出id为1的Demo的XML数据read_get_xml”
假设我们没有定义路由,这样访问的是Demo控制器的read操作,那么上面的请求会调用DemoController类的 read_get_xml方法,而不是read_xml方法,但是如果访问的URL是:
http://www.test/index.php/home/demo/read/id/1.json
那么则会调用read_json方法。
浏览器显示:
输出id为1的Demo的XML数据read_json
如果我们访问的URL是
http://www.test/index.php/home/demo/read/id/1.rss
由于我们不允许rss资源类型的访问,所以,调用的方法其实是read_get_html方法。
REST路由
我们可以借助3.2的路由参数功能,来解决REST的路由定义问题。 例如,
‘blog/:id’=>array(‘blog/read’,’status=1’,array(‘ext’=>’xml’,’method’=>’get’)),
上面的路由定义,把blog/5路由到了blog/read/id/5 并且,约束了后缀是xml 请求类型是get。 我们还可以定义其他的路由参数,例如:
‘blog/:id’=>array(‘blog/update’,”,array(‘ext’=>’xml’,’method’=>’put’)),
复制代码
为了确保定义不冲突,REST路由定义我们通常改成下面的定义方式:
array(‘blog/:id’,’blog/read’,’status=1’,array(‘ext’=>’xml’,’method’=>’get’)),
array(‘blog/:id’,’blog/update’,”,array(‘ext’=>’xml’,’method’=>’put’)),
这样就可以给相同的路由规则定义不同的参数支持。定义了REST路由后,你的rest方法定义就不受任何约束,当然,如果路由定义的操作方法不存在的时候,系统默认的rest方法规范仍然会有效。