使用扩展的 CodeIgniter 框架实现 RESTful 架构

886 阅读1分钟

名词解析

  • REST(表现层状态转化)是一种原则,而符合这种原则的架构就称之为 RESTful 架构。

表现:

通过

GET /library/1/book/2

这种风格的 URI 来访问控制器并传递参数, 其中 GET 是不出现在 URL 中的,而是代表一种操作方式(GETPOSTDELETEPUT),控制器通过判断请求的方式,来决定最终调用的方法。 所以

GET /book/1

POST /book/1

虽然访问的 URL 完全一样,但是根据请求方式的不同,实际上调用的是控制器内不同的方法

实现:

  • 使用 REST_Controller 扩展 CI_Controller

  • 根据业务需求,对路由进行重写,可以使用非正常格式的 URL 访问对应的对象方法

  • 通过 REST_Controller 判断请求的类型,并将 URL 中的参数交给相应的控制器处理

例:

如果发送 GET 请求到

www.test.com/index.php/user/1

那么 RESTful 路由会调用 User 控制器中的 index_get($id) 方法,并将参数 1 传递给 $id。

同理如果发送 GET 请求到 URL

www.test.com/index.php/user/book/name/foo/id/1

则会调用 User 控制器中的 login_get() 方法,通过

$this->get('name')

$this->get('id')

来分别获取到 URL 中传递的 $foo 和 $id 变量。

如果发送 POST 请求到

www.test.com/index.php/user/login

则会调用 User 控制器的 login_post() 方法,通过形如

$this->post('name');

的方法获取对应的参数。

PUT \ DELETE 同理。

返回数据:

控制器中相应的函数经过一系列处理后,需要返回包含足够信息的 json 格式字符串(根据具体需求)

通过形如下面的方法返回json格式的字符串:

$data = ['name'=>'','age'=>''];  
$this->response($data);  

相关链接:

codeigniter-restserver 项目地址