REST_Controller可以方便的在get/post/put/delete里处理相关信息,CI_Controller在访问的时候是控制器/method的方式,两种各有优缺点。所以必要的时候,尽管以restfull思想为大前提,但是CI_Controller也是有必要用的。虽然REST_Controller继承自CI_Controller,但是在获得输入和输出的时候进行了大量的封装,如果用Rest_Controller时间长了,会忘了CI_Controller的本来面目。废话不说了,下面对最常用的get和post进行对比:
一,GET请求
CI_Controller的get
在controller文件夹下新建文件Test_ci.php,内容如下:
<?php
class Test_ci extends CI_Controller {
public function print_user($name, $age = 24, $id = '3060411151', $website) {
// //方式1
// echo "name = " . $name . " age = " . $age;
// echo '<br/>';
//
// //方式2
$data = array('name'=>$name, 'age'=>$age, 'id'=>$id, 'website'=>$website);
echo json_encode($data);
//
// //方式3
// $data = array('name'=>$name, 'age'=>$age);
// $this->output->set_output(json_encode($data));
//方式4,标准url
// parse_str($_SERVER['QUERY_STRING'], $_GET);
// $data = array('name'=>$_GET['name'], 'age'=>$_GET['age'], 'id'=>$_GET['id'], 'website'=>$_GET['website']);
// echo json_encode($data);
}
}
然后浏览器输入http://app.sod90.com/city52/test_ci/print_user/yanzi/0/4567进行测试,可以看到正常的json输出。
我们可以总结如下几点:
1,controllder/method/params1/params2/params3进行传递的,为了安全起见method里各个参数一定要写个默认值。这种传递方式必须按照顺序,依次传入,CI依次匹配,不能漏传。本例中如果传入/yanzi/67,这个67会作为age,而非id。
2,当请求为get时,且通过controllder/method/params1/params2/params3传递参数时,直接通过$_GET['name']是得不到值的,通过$this->input->get('name')同样的不到值。函数的输入参数即是get请求的参数。
3,在返回的时候直接echo即可,当然也可以用$this->output->set_output,也可以用exit().共同点是里面必须为string,如果为array要记得json_encode.
4,这种pathinfo的url好处是利于SEO,能让动态的url看起来像静态的一样。如本例的网址是http://app.sod90.com/city52/test_ci/print_user/yanzi/25/4567 我如果想统计'yanzi'这个name被访问的次数则直接分析url就可以了。但凡是有利也有弊,试想我想传个参数 website=http://blog.csdn.net/yanzi1225627, 那url地址就要这样:http://app.sod90.com/city52/test_ci/print_user/yanzi/25/4567/http://blog.csdn.net/yanzi1225627用这种pathinfo的url一定会跪。得到的结果如下:
这是因为CI区分参数时以'/'去匹配的。为了解决这个问题,我们只能用传统的标准url方式,方法也很简单:
1,在调用_$GET之前调用parse_str($_SERVER['QUERY_STRING'], $_GET);一次, 就ok了。个别文档说还要将配置文件里的uri_protocol改为PATH_INFO 这是没有必要的,直接用默认的REQUEST_URI即可。
2,将原来控制器的方法里输入函数全部去掉。修改后的程序如下:
<?php
class Test_ci extends CI_Controller {
public function print_user(/*$name, $age = 24, $id = '3060411151', $website*/) {
// //方式1
// echo "name = " . $name . " age = " . $age;
// echo '<br/>';
//
// //方式2
// $data = array('name'=>$name, 'age'=>$age, 'id'=>$id, 'website'=>$website);
// echo json_encode($data);
//
// //方式3
// $data = array('name'=>$name, 'age'=>$age);
// $this->output->set_output(json_encode($data));
//方式4,标准url
parse_str($_SERVER['QUERY_STRING'], $_GET);
$data = array('name'=>$_GET['name'], 'age'=>$_GET['age'], 'id'=>$_GET['id'], 'website'=>$_GET['website']);
echo json_encode($data);
}
}
运行结果示例:
可以看到,完美解决了问题。但是直接使用$_GET不推荐这么做,如果key不存在会报错。事实上可以不输入parse_str($_SERVER['QUERY_STRING'], $_GET);这句话,直接使用$this->input->get()就可以获得到get参数了。CI_Controller get请求的输入输出就介绍到这里。
REST_Controller的get
<?php
/**
* Created by PhpStorm.
* User: yanzi
* Date: 15/11/20
* Time: 上午7:54
*/
require_once APPPATH . 'libraries/REST_Controller.php';
class Test_rest extends REST_Controller{
public function index_get() {
$data = array(
'name'=>$this->get('name'),
'age'=>$this->get('age'),
'id'=>$this->get('id')
);
$this->response($data);
}
}
浏览器输入:http://app.sod90.com/city52/test_rest?name=yanzi&age=25&id=4567 可以看到效果如下:
当然代码里的$this->get('key'),也可以换成$this->input->get('key')的写法。除此外,我们浏览器还可以输入一个分段式的url测试下:
http://app.sod90.com/city52/test_rest/name/yandzi/age/25/id/4567/format/json 结果很失望:
输入http://app.sod90.com/city52/test_rest?name/yandzi/age/25/id/4567/format/json ,结果依旧:
可以看到这进到了正确的方法里,但是未检测到参数。自始至终config里配置
$config['uri_protocol'] = 'REQUEST_URI';
将其改为path_info也是不行。但是rest_controller的官网 里有下面一段描述:
但是经过验证并没有成功。我在apache和nginx上都测试过了,均不行。不知是我环境问题还是咋回事。
二,POST请求
CI_Controller的POST
前者的测试代码:
public function print_user2(){
$data = array('name'=>$_POST['name'], 'age'=>$_POST['age'], 'id'=>$_POST['id'], 'website'=>$_POST['website']);
echo json_encode($data);
}
测试实例:
我们将代码里的$_POST['name']换成$this->input->post('name'),结果依旧。但是唯一的区别是,在没有传'name'这个字段时,直接用$_POST['name']会报错,而用$this->input->post('name')得到的是null,因此我们应该尽量都用$this->input->post()来获得参数。
然后代码改为:
public function print_user2(){
$data = array('name'=>$this->input->get('name'), 'age'=>$_POST['age'], 'id'=>$_POST['id'], 'website'=>$_POST['website']);
echo json_encode($data);
}
即用来测试post请求里url后面还带参数的情况:
发现也是ok的。再将代码改下,试试直接传递参数:
public function print_user2($name){
$data = array('name'=>$name, 'age'=>$_POST['age'], 'id'=>$_POST['id'], 'website'=>$_POST['website']);
echo json_encode($data);
}
结果也是ok的。但是你输入/name/yanziyan,是区分不出来name字段的。
REST_Controller的POST
测试代码:<?php
/**
* Created by PhpStorm.
* User: yanzi
* Date: 15/11/20
* Time: 上午7:54
*/
require_once APPPATH . 'libraries/REST_Controller.php';
class Test_rest extends REST_Controller{
public function index_get() {
$data = array(
'name'=>$this->get('name'),
'age'=>$this->get('age'),
'id'=>$this->get('id')
);
$this->response($data);
}
public function index_post(){
$data = array(
'name'=>$this->post('name'),
'age'=>$this->post('age'),
'id'=>$this->post('id')
);
$this->response($data);
}
}
使用POST_MAN进行测试:
再来测试下post请求里获取get参数的例子:
public function index_post(){
$data = array(
'name'=>$this->get('name'),
'age'=>$this->post('age'),
'id'=>$this->post('id')
);
$this->response($data);
}
可以看到并未接收到name这个参数。
但是不用怕,将$this->get()换成$this->input->get()试一下:
public function index_post(){
$data = array(
'name'=>$this->input->get('name'),
'age'=>$this->post('age'),
'id'=>$this->post('id')
);
$this->response($data);
}
测试:
这样就能收到参数了。除此外,使用$this->query()也是可以获得到post里的url参数的。但是query是获得不到post参数的。
再来测试下/key/params的方式,发现还是不行:
最终的结论如下:
1,需明确$this->input->get()和$this->input->post()是CI_Controller提供的方法,Rest_Controller继承自CI_Controller除了这两个方法外,作者为我们提供了更简便的访问方式:$this->get(), $this->post(), $this->query().
2,不推荐使用_$GET和_$POST来获得参数,原因是字段未传时将会报错。在CI_Controller里如果使用_$GET(仅当使用key=params1&key2=params2这种方式传参数时),还要加上:parse_str($_SERVER['QUERY_STRING'], $_GET);
3,CI_Controller和REST_Controller这两个控制器在访问上区别很大。Rest是按请求类型get/post自动给你路由到xxx_get()和xxx_post()里,url里只需要控制器的名字,不需要method的名字,CI是必须在url里指定函数名***/controller/method/params1/params2/params3
4,CI_Controller是支持***/controller/method/params1/params2/params3这种分段式url,往method这个函数依次传入数据,但是如果参数里本身有/就会有问题。所以必要时候还是得用***/controller/method?key1=params1&key2=params2这种方式
5,Rest_Controller不支持***/controller/method/params1/params2/params3这种段式传参,但是官网上说支持/controller/key1/params1/key2/params2,但是我在Nginx和apache上均没有成功。
6,$this->query能在rest的controller下,用来获取url里的参数(?key=params1&key2=params2),不管是不是get请求。也即post或put请求的url里传的参数。当然在post请求时也可以通过$this->input->get()获得url里的参数,通过$this->get()在post请求里是得不到url里的参数的。
7,$this->output->set_output()是CI_Controller提供的方法的,但在Rest里可以直接用$this->response()进行返回。在CI_Controller里如果嫌$this->output->set_output()太长,且只考虑反回数据的话可以使用echo 或exit直接返回数据。
2015-12-23补充说明:
1,Rest 的api不支持一次取出多个参数,只能单个取:$this->get('key1'),没办法 这样$this->get(array('key1', 'key2'));
2,CodeIgniter里支持一次取出多个参数,但是必须加input,如:$this->input->get(array('field1', 'field2'));
参见:http://codeigniter.org.cn/user_guide/libraries/input.html
参考文献:
1,restserver github:https://github.com/chriskacerguis/codeigniter-restserver
2,restserver guide:http://code.tutsplus.com/tutorials/working-with-restful-services-in-codeigniter-2--net-8814
3,CodeIgniter官网:http://codeigniter.org.cn/user_guide/libraries/output.html
------------------欢迎大家加入PHP CodeIgniter社区群:460132647,备注yanzi